PoolUpdatePropertiesParameter Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. PoolUpdatePropertiesParameter
- com.
public class PoolUpdatePropertiesParameter
The set of changes to be made to a pool.
Method Summary
Modifier and Type | Method and Description |
---|---|
List<Application |
applicationPackageReferences()
Get the list replaces any existing application package references on the pool. 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 omitted, or if you specify an empty collection, any existing application packages references are removed from the pool. |
List<Certificate |
certificateReferences()
Get this list replaces any existing certificate references configured on the pool. If you specify an empty collection, any existing certificate references are removed from the pool. 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 this list replaces any existing metadata configured on the pool. If omitted, or if you specify an empty collection, any existing metadata is removed from the pool. |
Start |
startTask()
Get if this element is present, it overwrites any existing start task. If omitted, any existing start task is removed from the pool. |
Pool |
withApplicationPackageReferences(List<ApplicationPackageReference> applicationPackageReferences)
Set the list replaces any existing application package references on the pool. 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 omitted, or if you specify an empty collection, any existing application packages references are removed from the pool. |
Pool |
withCertificateReferences(List<CertificateReference> certificateReferences)
Set this list replaces any existing certificate references configured on the pool. If you specify an empty collection, any existing certificate references are removed from the pool. 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 this list replaces any existing metadata configured on the pool. If omitted, or if you specify an empty collection, any existing metadata is removed from the pool. |
Pool |
withStartTask(StartTask startTask)
Set if this element is present, it overwrites any existing start task. If omitted, any existing start task is removed from the pool. |
Method Details
applicationPackageReferences
public List
Get the list replaces any existing application package references on the pool. 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 omitted, or if you specify an empty collection, any existing application packages references are removed from the pool.
Returns:
certificateReferences
public List
Get this list replaces any existing certificate references configured on the pool. If you specify an empty collection, any existing certificate references are removed from the pool. 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 this list replaces any existing metadata configured on the pool. If omitted, or if you specify an empty collection, any existing metadata is removed from the pool.
Returns:
startTask
public StartTask startTask()
Get if this element is present, it overwrites any existing start task. If omitted, any existing start task is removed from the pool.
Returns:
withApplicationPackageReferences
public PoolUpdatePropertiesParameter withApplicationPackageReferences(List
Set the list replaces any existing application package references on the pool. 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 omitted, or if you specify an empty collection, any existing application packages references are removed from the pool.
Parameters:
Returns:
withCertificateReferences
public PoolUpdatePropertiesParameter withCertificateReferences(List
Set this list replaces any existing certificate references configured on the pool. If you specify an empty collection, any existing certificate references are removed from the pool. 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 PoolUpdatePropertiesParameter withMetadata(List
Set this list replaces any existing metadata configured on the pool. If omitted, or if you specify an empty collection, any existing metadata is removed from the pool.
Parameters:
Returns:
withStartTask
public PoolUpdatePropertiesParameter withStartTask(StartTask startTask)
Set if this element is present, it overwrites any existing start task. If omitted, any existing start task is removed from the pool.
Parameters:
Returns:
Applies to
Azure SDK for Java