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

Implements

JsonSerializable<AzureBlobFileSystemConfiguration>

public final class AzureBlobFileSystemConfiguration
implements JsonSerializable<AzureBlobFileSystemConfiguration>

Information used to connect to an Azure Storage Container using Blobfuse.

Constructor Summary

Constructor	Description
AzureBlobFileSystemConfiguration(String accountName, String containerName, String relativeMountPath)	Creates an instance of AzureBlobFileSystemConfiguration class.

Method Summary

Modifier and Type	Method and Description
static AzureBlobFileSystemConfiguration	fromJson(JsonReader jsonReader) Reads an instance of AzureBlobFileSystemConfiguration from the JsonReader.
String	getAccountKey() Get the accountKey property: The Azure Storage Account key.
String	getAccountName() Get the accountName property: The Azure Storage Account name.
String	getBlobfuseOptions() Get the blobfuseOptions property: Additional command line options to pass to the mount command.
String	getContainerName() Get the containerName property: The Azure Blob Storage Container name.
BatchNodeIdentityReference	getIdentityReference() Get the identityReference property: The reference to the user assigned identity to use to access containerName.
String	getRelativeMountPath() Get the relativeMountPath property: The relative path on the compute node where the file system will be mounted.
String	getSasKey() Get the sasKey property: The Azure Storage SAS token.
AzureBlobFileSystemConfiguration	setAccountKey(String accountKey) Set the accountKey property: The Azure Storage Account key.
AzureBlobFileSystemConfiguration	setBlobfuseOptions(String blobfuseOptions) Set the blobfuseOptions property: Additional command line options to pass to the mount command.
AzureBlobFileSystemConfiguration	setIdentityReference(BatchNodeIdentityReference identityReference) Set the identityReference property: The reference to the user assigned identity to use to access containerName.
AzureBlobFileSystemConfiguration	setSasKey(String sasKey) Set the sasKey property: The Azure Storage SAS token.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AzureBlobFileSystemConfiguration

public AzureBlobFileSystemConfiguration(String accountName, String containerName, String relativeMountPath)

Creates an instance of AzureBlobFileSystemConfiguration class.

Parameters:

accountName - the accountName value to set.

containerName - the containerName value to set.

relativeMountPath - the relativeMountPath value to set.

Method Details

fromJson

public static AzureBlobFileSystemConfiguration fromJson(JsonReader jsonReader)

Reads an instance of AzureBlobFileSystemConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AzureBlobFileSystemConfiguration 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.

getAccountKey

public String getAccountKey()

Get the accountKey property: The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified.

Returns:

the accountKey value.

getAccountName

public String getAccountName()

Get the accountName property: The Azure Storage Account name.

Returns:

the accountName value.

getBlobfuseOptions

public String getBlobfuseOptions()

Get the blobfuseOptions property: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.

Returns:

the blobfuseOptions value.

getContainerName

public String getContainerName()

Get the containerName property: The Azure Blob Storage Container name.

Returns:

the containerName value.

getIdentityReference

public BatchNodeIdentityReference getIdentityReference()

Get the identityReference property: The reference to the user assigned identity to use to access containerName. This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified.

Returns:

the identityReference value.

getRelativeMountPath

public String getRelativeMountPath()

Get the relativeMountPath property: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.

Returns:

the relativeMountPath value.

getSasKey

public String getSasKey()

Get the sasKey property: The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be specified.

Returns:

the sasKey value.

setAccountKey

public AzureBlobFileSystemConfiguration setAccountKey(String accountKey)

Set the accountKey property: The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified.

Parameters:

accountKey - the accountKey value to set.

Returns:

the AzureBlobFileSystemConfiguration object itself.

setBlobfuseOptions

public AzureBlobFileSystemConfiguration setBlobfuseOptions(String blobfuseOptions)

Set the blobfuseOptions property: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.

Parameters:

blobfuseOptions - the blobfuseOptions value to set.

Returns:

the AzureBlobFileSystemConfiguration object itself.

setIdentityReference

public AzureBlobFileSystemConfiguration setIdentityReference(BatchNodeIdentityReference identityReference)

Set the identityReference property: The reference to the user assigned identity to use to access containerName. This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified.

Parameters:

identityReference - the identityReference value to set.

Returns:

the AzureBlobFileSystemConfiguration object itself.

setSasKey

public AzureBlobFileSystemConfiguration setSasKey(String sasKey)

Set the sasKey property: The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be specified.

Parameters:

sasKey - the sasKey value to set.

Returns:

the AzureBlobFileSystemConfiguration object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException