ResourceFile Class

Package:

com.azure.resourcemanager.batch.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-batch:2.0.0

• java.lang.Object
• • com.azure.resourcemanager.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
String	autoStorageContainerName() Get the autoStorageContainerName property: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.
String	blobPrefix() Get the blobPrefix property: The property is valid only when autoStorageContainerName or storageContainerUrl is used.
String	fileMode() Get the fileMode property: This property applies only to files being downloaded to Linux compute nodes.
String	filePath() Get the filePath property: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename.
static ResourceFile	fromJson(JsonReader jsonReader) Reads an instance of ResourceFile from the JsonReader.
String	httpUrl() Get the httpUrl property: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.
ComputeNodeIdentityReference	identityReference() Get the identityReference property: The reference to a user assigned identity associated with the Batch pool which a compute node will use.
String	storageContainerUrl() Get the storageContainerUrl property: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
ResourceFile	withAutoStorageContainerName(String autoStorageContainerName) Set the autoStorageContainerName property: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.
ResourceFile	withBlobPrefix(String blobPrefix) Set the blobPrefix property: The property is valid only when autoStorageContainerName or storageContainerUrl is used.
ResourceFile	withFileMode(String fileMode) Set the fileMode property: This property applies only to files being downloaded to Linux compute nodes.
ResourceFile	withFilePath(String filePath) Set the filePath property: If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename.
ResourceFile	withHttpUrl(String httpUrl) Set the httpUrl property: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.
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.
ResourceFile	withStorageContainerUrl(String storageContainerUrl) Set the storageContainerUrl property: The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified.

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

autoStorageContainerName

public String autoStorageContainerName()

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

Returns:

the autoStorageContainerName value.

blobPrefix

public String blobPrefix()

Get the blobPrefix property: 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.

fileMode

public String fileMode()

Get the fileMode property: 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.

filePath

public String filePath()

Get the filePath property: 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.

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.

httpUrl

public String httpUrl()

Get the httpUrl property: 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.

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.

storageContainerUrl

public String storageContainerUrl()

Get the storageContainerUrl property: 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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withAutoStorageContainerName

public ResourceFile withAutoStorageContainerName(String autoStorageContainerName)

Set the autoStorageContainerName property: 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.

withBlobPrefix

public ResourceFile withBlobPrefix(String blobPrefix)

Set the blobPrefix property: 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.

withFileMode

public ResourceFile withFileMode(String fileMode)

Set the fileMode property: 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.

withFilePath

public ResourceFile withFilePath(String filePath)

Set the filePath property: 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.

withHttpUrl

public ResourceFile withHttpUrl(String httpUrl)

Set the httpUrl property: 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.

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.

withStorageContainerUrl

public ResourceFile withStorageContainerUrl(String storageContainerUrl)

Set the storageContainerUrl property: 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.