Package com.azure.compute.batch.models

Class OutputFileBlobContainerDestination

java.lang.Object
com.azure.compute.batch.models.OutputFileBlobContainerDestination
All Implemented Interfaces:
com.azure.json.JsonSerializable<OutputFileBlobContainerDestination>
public final class OutputFileBlobContainerDestination extends Object implements com.azure.json.JsonSerializable<OutputFileBlobContainerDestination>
Specifies a file upload destination within an Azure blob storage container.

  • Constructor Details

    • OutputFileBlobContainerDestination

      public OutputFileBlobContainerDestination(String containerUrl)
      Creates an instance of OutputFileBlobContainerDestination class.
      Parameters:
      containerUrl - the containerUrl value to set.

  • Method Details

    • getPath

      public String getPath()
      Get the path property: The destination blob or virtual directory within the Azure Storage container. If filePattern refers to a specific file (i.e. contains no wildcards), then path is the name of the blob to which to upload that file. If filePattern contains one or more wildcards (and therefore may match multiple files), then path is the name of the blob virtual directory (which is prepended to each blob name) to which to upload the file(s). If omitted, file(s) are uploaded to the root of the container with a blob name matching their file name.
      Returns:
      the path value.

    • setPath

      public OutputFileBlobContainerDestination setPath(String path)
      Set the path property: The destination blob or virtual directory within the Azure Storage container. If filePattern refers to a specific file (i.e. contains no wildcards), then path is the name of the blob to which to upload that file. If filePattern contains one or more wildcards (and therefore may match multiple files), then path is the name of the blob virtual directory (which is prepended to each blob name) to which to upload the file(s). If omitted, file(s) are uploaded to the root of the container with a blob name matching their file name.
      Parameters:
      path - the path value to set.
      Returns:
      the OutputFileBlobContainerDestination object itself.

    • getContainerUrl

      public String getContainerUrl()
      Get the containerUrl property: The URL of the container within Azure Blob Storage to which to upload the file(s). If not using a managed identity, the URL must include a Shared Access Signature (SAS) granting write permissions to the container.
      Returns:
      the containerUrl value.

    • getIdentityReference

      public BatchNodeIdentityReference getIdentityReference()
      Get the identityReference property: The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl. The identity must have write access to the Azure Blob Storage container.
      Returns:
      the identityReference value.

    • setIdentityReference

      public OutputFileBlobContainerDestination setIdentityReference(BatchNodeIdentityReference identityReference)
      Set the identityReference property: The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl. The identity must have write access to the Azure Blob Storage container.
      Parameters:
      identityReference - the identityReference value to set.
      Returns:
      the OutputFileBlobContainerDestination object itself.

    • getUploadHeaders

      public List<HttpHeader> getUploadHeaders()
      Get the uploadHeaders property: A list of name-value pairs for headers to be used in uploading output files. These headers will be specified when uploading files to Azure Storage. Official document on allowed headers when uploading blobs: https://learn.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types.
      Returns:
      the uploadHeaders value.

    • setUploadHeaders

      public OutputFileBlobContainerDestination setUploadHeaders(List<HttpHeader> uploadHeaders)
      Set the uploadHeaders property: A list of name-value pairs for headers to be used in uploading output files. These headers will be specified when uploading files to Azure Storage. Official document on allowed headers when uploading blobs: https://learn.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types.
      Parameters:
      uploadHeaders - the uploadHeaders value to set.
      Returns:
      the OutputFileBlobContainerDestination object itself.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<OutputFileBlobContainerDestination>
      Throws:
      IOException

    • fromJson

      public static OutputFileBlobContainerDestination fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of OutputFileBlobContainerDestination from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of OutputFileBlobContainerDestination if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the OutputFileBlobContainerDestination.