Package com.microsoft.azure.batch.protocol.models

Class PoolUpdatePropertiesParameter

  • public class PoolUpdatePropertiesParameter
extends Object
    The set of changes to be made to a Pool.

    • Constructor Detail

      • PoolUpdatePropertiesParameter

        public PoolUpdatePropertiesParameter()

    • Method Detail

      • startTask

        public StartTask startTask()
        Get if this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is removed from the Pool.
        Returns:
        the startTask value

      • withStartTask

        public PoolUpdatePropertiesParameter withStartTask​(StartTask startTask)
        Set if this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is removed from the Pool.
        Parameters:
        startTask - the startTask value to set
        Returns:
        the PoolUpdatePropertiesParameter object itself.

      • certificateReferences

        public List<CertificateReference> 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 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:
        the certificateReferences value

      • withCertificateReferences

        public PoolUpdatePropertiesParameter 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 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:
        certificateReferences - the certificateReferences value to set
        Returns:
        the PoolUpdatePropertiesParameter object itself.

      • applicationPackageReferences

        public List<ApplicationPackageReference> 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. There is a maximum of 10 Application Package references on any given Pool. If omitted, or if you specify an empty collection, any existing Application Packages references are removed from the Pool. A maximum of 10 references may be specified on a given Pool.
        Returns:
        the applicationPackageReferences value

      • withApplicationPackageReferences

        public PoolUpdatePropertiesParameter 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. There is a maximum of 10 Application Package references on any given Pool. If omitted, or if you specify an empty collection, any existing Application Packages references are removed from the Pool. A maximum of 10 references may be specified on a given Pool.
        Parameters:
        applicationPackageReferences - the applicationPackageReferences value to set
        Returns:
        the PoolUpdatePropertiesParameter object itself.

      • metadata

        public List<MetadataItem> 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.
        Returns:
        the metadata value

      • withMetadata

        public PoolUpdatePropertiesParameter 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.
        Parameters:
        metadata - the metadata value to set
        Returns:
        the PoolUpdatePropertiesParameter object itself.