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

Implements

JsonSerializable<ResourceFile>

public final class ResourceFile
implements JsonSerializable<ResourceFile>

A single file or multiple files to be downloaded to a Compute Node.

Constructor Summary

Constructor	Description
ResourceFile()	Creates an instance of ResourceFile class.

Method Summary

Modifier and Type	Method and Description
static ResourceFile	fromJson(JsonReader jsonReader) Reads an instance of ResourceFile from the JsonReader.
String	getAutoStorageContainerName() Get the autoStorageContainerName property: The storage container name in the auto storage Account.
String	getBlobPrefix() Get the blobPrefix property: The blob prefix to use when downloading blobs from an Azure Storage container.
String	getFileMode() Get the fileMode property: The file permission mode attribute in octal format.
String	getFilePath() Get the filePath property: The location on the Compute Node to which to download the file(s), relative to the Task's working directory.
String	getHttpUrl() Get the httpUrl property: The URL of the file to download.
BatchNodeIdentityReference	getIdentityReference() Get the identityReference property: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl.
String	getStorageContainerUrl() Get the storageContainerUrl property: The URL of the blob container within Azure Blob Storage.
ResourceFile	setAutoStorageContainerName(String autoStorageContainerName) Set the autoStorageContainerName property: The storage container name in the auto storage Account.
ResourceFile	setBlobPrefix(String blobPrefix) Set the blobPrefix property: The blob prefix to use when downloading blobs from an Azure Storage container.
ResourceFile	setFileMode(String fileMode) Set the fileMode property: The file permission mode attribute in octal format.
ResourceFile	setFilePath(String filePath) Set the filePath property: The location on the Compute Node to which to download the file(s), relative to the Task's working directory.
ResourceFile	setHttpUrl(String httpUrl) Set the httpUrl property: The URL of the file to download.
ResourceFile	setIdentityReference(BatchNodeIdentityReference identityReference) Set the identityReference property: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl.
ResourceFile	setStorageContainerUrl(String storageContainerUrl) Set the storageContainerUrl property: The URL of the blob container within Azure Blob Storage.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ResourceFile

public ResourceFile()

Creates an instance of ResourceFile class.

Method Details

fromJson

public static ResourceFile fromJson(JsonReader jsonReader)

Reads an instance of ResourceFile from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ResourceFile if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the ResourceFile.

getAutoStorageContainerName

public String getAutoStorageContainerName()

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.

getBlobPrefix

public String getBlobPrefix()

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.

getFileMode

public String getFileMode()

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 Compute Node. If this property is not specified for a Linux Compute Node, then a default value of 0770 is applied to the file.

Returns:

the fileMode value.

getFilePath

public String getFilePath()

Get the filePath property: The location on the Compute Node to which to download the file(s), 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.

getHttpUrl

public String getHttpUrl()

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.

getIdentityReference

public BatchNodeIdentityReference getIdentityReference()

Get the identityReference property: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl.

Returns:

the identityReference value.

getStorageContainerUrl

public String getStorageContainerUrl()

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.

setAutoStorageContainerName

public ResourceFile setAutoStorageContainerName(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.

setBlobPrefix

public ResourceFile setBlobPrefix(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.

setFileMode

public ResourceFile setFileMode(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 Compute Node. If this property is not specified for a Linux Compute Node, then a default value of 0770 is applied to the file.

Parameters:

fileMode - the fileMode value to set.

Returns:

the ResourceFile object itself.

setFilePath

public ResourceFile setFilePath(String filePath)

Set the filePath property: The location on the Compute Node to which to download the file(s), 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.

setHttpUrl

public ResourceFile setHttpUrl(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.

setIdentityReference

public ResourceFile setIdentityReference(BatchNodeIdentityReference identityReference)

Set the identityReference property: The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl.

Parameters:

identityReference - the identityReference value to set.

Returns:

the ResourceFile object itself.

setStorageContainerUrl

public ResourceFile setStorageContainerUrl(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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException