PoolPatchParameter Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. PoolPatchParameter
- com.
public class PoolPatchParameter
The set of changes to be made to a pool.
Method Summary
Modifier and Type | Method and Description |
---|---|
List<Application |
applicationPackageReferences()
Get changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. If this element is present, it replaces any existing application package references. If you specify an empty collection, then all application package references are removed from the pool. If omitted, any existing application package references are left unchanged. |
List<Certificate |
certificateReferences()
Get if this element is present, it replaces any existing certificate references configured on the pool. If omitted, any existing certificate references are left unchanged. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. |
List<Metadata |
metadata()
Get if this element is present, it replaces any existing metadata configured on the pool. If you specify an empty collection, any metadata is removed from the pool. If omitted, any existing metadata is left unchanged. |
Start |
startTask()
Get if this element is present, it overwrites any existing start task. If omitted, any existing start task is left unchanged. |
Pool |
withApplicationPackageReferences(List<ApplicationPackageReference> applicationPackageReferences)
Set changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. If this element is present, it replaces any existing application package references. If you specify an empty collection, then all application package references are removed from the pool. If omitted, any existing application package references are left unchanged. |
Pool |
withCertificateReferences(List<CertificateReference> certificateReferences)
Set if this element is present, it replaces any existing certificate references configured on the pool. If omitted, any existing certificate references are left unchanged. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. |
Pool |
withMetadata(List<MetadataItem> metadata)
Set if this element is present, it replaces any existing metadata configured on the pool. If you specify an empty collection, any metadata is removed from the pool. If omitted, any existing metadata is left unchanged. |
Pool |
withStartTask(StartTask startTask)
Set if this element is present, it overwrites any existing start task. If omitted, any existing start task is left unchanged. |
Method Details
applicationPackageReferences
public List
Get changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. If this element is present, it replaces any existing application package references. If you specify an empty collection, then all application package references are removed from the pool. If omitted, any existing application package references are left unchanged.
Returns:
certificateReferences
public List
Get if this element is present, it replaces any existing certificate references configured on the pool. If omitted, any existing certificate references are left unchanged. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.
Returns:
metadata
public List
Get if this element is present, it replaces any existing metadata configured on the pool. If you specify an empty collection, any metadata is removed from the pool. If omitted, any existing metadata is left unchanged.
Returns:
startTask
public StartTask startTask()
Get if this element is present, it overwrites any existing start task. If omitted, any existing start task is left unchanged.
Returns:
withApplicationPackageReferences
public PoolPatchParameter withApplicationPackageReferences(List
Set changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. If this element is present, it replaces any existing application package references. If you specify an empty collection, then all application package references are removed from the pool. If omitted, any existing application package references are left unchanged.
Parameters:
Returns:
withCertificateReferences
public PoolPatchParameter withCertificateReferences(List
Set if this element is present, it replaces any existing certificate references configured on the pool. If omitted, any existing certificate references are left unchanged. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.
Parameters:
Returns:
withMetadata
public PoolPatchParameter withMetadata(List
Set if this element is present, it replaces any existing metadata configured on the pool. If you specify an empty collection, any metadata is removed from the pool. If omitted, any existing metadata is left unchanged.
Parameters:
Returns:
withStartTask
public PoolPatchParameter withStartTask(StartTask startTask)
Set if this element is present, it overwrites any existing start task. If omitted, any existing start task is left unchanged.
Parameters:
Returns:
Applies to
Azure SDK for Java