Package com.azure.resourcemanager.batch.models

Class ResourceFile

java.lang.Object
com.azure.resourcemanager.batch.models.ResourceFile
public final class ResourceFile extends Object
A single file or multiple files to be downloaded to a compute node.

  • Constructor Details

    • ResourceFile

      public ResourceFile()
      Creates an instance of ResourceFile class.

  • Method Details

    • autoStorageContainerName

      public String autoStorageContainerName()
      Get the autoStorageContainerName property: The storage container name in the auto storage account.

      The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.

      Returns:
      the autoStorageContainerName value.

    • withAutoStorageContainerName

      public ResourceFile withAutoStorageContainerName(String autoStorageContainerName)
      Set the autoStorageContainerName property: The storage container name in the auto storage account.

      The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.

      Parameters:
      autoStorageContainerName - the autoStorageContainerName value to set.
      Returns:
      the ResourceFile object itself.

    • storageContainerUrl

      public String storageContainerUrl()
      Get the storageContainerUrl property: The URL of the blob container within Azure Blob Storage.

      The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access.

      Returns:
      the storageContainerUrl value.

    • withStorageContainerUrl

      public ResourceFile withStorageContainerUrl(String storageContainerUrl)
      Set the storageContainerUrl property: The URL of the blob container within Azure Blob Storage.

      The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access.

      Parameters:
      storageContainerUrl - the storageContainerUrl value to set.
      Returns:
      the ResourceFile object itself.

    • httpUrl

      public String httpUrl()
      Get the httpUrl property: The URL of the file to download.

      The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access.

      Returns:
      the httpUrl value.

    • withHttpUrl

      public ResourceFile withHttpUrl(String httpUrl)
      Set the httpUrl property: The URL of the file to download.

      The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access.

      Parameters:
      httpUrl - the httpUrl value to set.
      Returns:
      the ResourceFile object itself.

    • blobPrefix

      public String blobPrefix()
      Get the blobPrefix property: The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded.

      The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded.

      Returns:
      the blobPrefix value.

    • withBlobPrefix

      public ResourceFile withBlobPrefix(String blobPrefix)
      Set the blobPrefix property: The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded.

      The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded.

      Parameters:
      blobPrefix - the blobPrefix value to set.
      Returns:
      the ResourceFile object itself.

    • filePath

      public String filePath()
      Get the filePath property: The location on the compute node to which to download the file, relative to the task's working directory.

      If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..').

      Returns:
      the filePath value.

    • withFilePath

      public ResourceFile withFilePath(String filePath)
      Set the filePath property: The location on the compute node to which to download the file, relative to the task's working directory.

      If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..').

      Parameters:
      filePath - the filePath value to set.
      Returns:
      the ResourceFile object itself.

    • fileMode

      public String fileMode()
      Get the fileMode property: The file permission mode attribute in octal format.

      This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.

      Returns:
      the fileMode value.

    • withFileMode

      public ResourceFile withFileMode(String fileMode)
      Set the fileMode property: The file permission mode attribute in octal format.

      This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.

      Parameters:
      fileMode - the fileMode value to set.
      Returns:
      the ResourceFile object itself.

    • identityReference

      public ComputeNodeIdentityReference identityReference()
      Get the identityReference property: The reference to a user assigned identity associated with the Batch pool which a compute node will use.
      Returns:
      the identityReference value.

    • withIdentityReference

      public ResourceFile withIdentityReference(ComputeNodeIdentityReference identityReference)
      Set the identityReference property: The reference to a user assigned identity associated with the Batch pool which a compute node will use.
      Parameters:
      identityReference - the identityReference value to set.
      Returns:
      the ResourceFile object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.