OutputFileBlobContainerDestination Class

Package:

com.azure.compute.batch.models

Maven Artifact:

com.azure:azure-compute-batch:1.0.0-beta.5

• java.lang.Object
• • com.azure.compute.batch.models.OutputFileBlobContainerDestination

Implements

JsonSerializable<OutputFileBlobContainerDestination>

public final class OutputFileBlobContainerDestination
implements JsonSerializable<OutputFileBlobContainerDestination>

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

Constructor Summary

Constructor	Description
OutputFileBlobContainerDestination(String containerUrl)	Creates an instance of OutputFileBlobContainerDestination class.

Method Summary

Modifier and Type	Method and Description
static OutputFileBlobContainerDestination	fromJson(JsonReader jsonReader) Reads an instance of OutputFileBlobContainerDestination from the JsonReader.
String	getContainerUrl() Get the containerUrl property: The URL of the container within Azure Blob Storage to which to upload the file(s).
BatchNodeIdentityReference	getIdentityReference() Get the identityReference property: The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl.
String	getPath() Get the path property: The destination blob or virtual directory within the Azure Storage container.
List<OutputFileUploadHeader>	getUploadHeaders() Get the uploadHeaders property: A list of name-value pairs for headers to be used in uploading output files.
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.
OutputFileBlobContainerDestination	setPath(String path) Set the path property: The destination blob or virtual directory within the Azure Storage container.
OutputFileBlobContainerDestination	setUploadHeaders(List<OutputFileUploadHeader> uploadHeaders) Set the uploadHeaders property: A list of name-value pairs for headers to be used in uploading output files.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

OutputFileBlobContainerDestination

public OutputFileBlobContainerDestination(String containerUrl)

Creates an instance of OutputFileBlobContainerDestination class.

Parameters:

containerUrl - the containerUrl value to set.

Method Details

fromJson

public static OutputFileBlobContainerDestination fromJson(JsonReader jsonReader)

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:

IOException

- If the deserialized JSON object was missing any required properties.

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.

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.

getUploadHeaders

public List<OutputFileUploadHeader> 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.

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.

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.

setUploadHeaders

public OutputFileBlobContainerDestination setUploadHeaders(List<OutputFileUploadHeader> 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 JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException