OutputFileBlobContainerDestination Class

  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.OutputFileBlobContainerDestination

public class OutputFileBlobContainerDestination

Specifies a file upload destination within an Azure blob storage container.

Constructor Summary

Constructor Description
OutputFileBlobContainerDestination()

Method Summary

Modifier and Type Method and Description
String containerUrl()

Get if not using a managed identity, the URL must include a Shared Access Signature (SAS) granting write permissions to the container.

ComputeNodeIdentityReference identityReference()

Get the identity must have write access to the Azure Blob Storage container.

String path()

Get if filePattern refers to a specific file (i.e.

List<HttpHeader> uploadHeaders()

Get these headers will be specified when uploading files to Azure Storage.

OutputFileBlobContainerDestination withContainerUrl(String containerUrl)

Set if not using a managed identity, the URL must include a Shared Access Signature (SAS) granting write permissions to the container.

OutputFileBlobContainerDestination withIdentityReference(ComputeNodeIdentityReference identityReference)

Set the identity must have write access to the Azure Blob Storage container.

OutputFileBlobContainerDestination withPath(String path)

Set if filePattern refers to a specific file (i.e.

OutputFileBlobContainerDestination withUploadHeaders(List<HttpHeader> uploadHeaders)

Set these headers will be specified when uploading files to Azure Storage.

Methods inherited from java.lang.Object

Constructor Details

OutputFileBlobContainerDestination

public OutputFileBlobContainerDestination()

Method Details

containerUrl

public String containerUrl()

Get 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

identityReference

public ComputeNodeIdentityReference identityReference()

Get the identity must have write access to the Azure Blob Storage container.

Returns:

the identityReference value

path

public String path()

Get 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

uploadHeaders

public List uploadHeaders()

Get these headers will be specified when uploading files to Azure Storage. Official document on allowed headers when uploading blobs: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob\#request-headers-all-blob-types.

Returns:

the uploadHeaders value

withContainerUrl

public OutputFileBlobContainerDestination withContainerUrl(String containerUrl)

Set if not using a managed identity, the URL must include a Shared Access Signature (SAS) granting write permissions to the container.

Parameters:

containerUrl - the containerUrl value to set

Returns:

the OutputFileBlobContainerDestination object itself.

withIdentityReference

public OutputFileBlobContainerDestination withIdentityReference(ComputeNodeIdentityReference identityReference)

Set the identity must have write access to the Azure Blob Storage container.

Parameters:

identityReference - the identityReference value to set

Returns:

the OutputFileBlobContainerDestination object itself.

withPath

public OutputFileBlobContainerDestination withPath(String path)

Set 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.

withUploadHeaders

public OutputFileBlobContainerDestination withUploadHeaders(List uploadHeaders)

Set these headers will be specified when uploading files to Azure Storage. Official document on allowed headers when uploading blobs: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob\#request-headers-all-blob-types.

Parameters:

uploadHeaders - the uploadHeaders value to set

Returns:

the OutputFileBlobContainerDestination object itself.

Applies to