Share via

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

Implements

JsonSerializable<AzureFileShareConfiguration>

public final class AzureFileShareConfiguration
implements JsonSerializable<AzureFileShareConfiguration>

Information used to connect to an Azure Fileshare.

Constructor Summary

Constructor Description
AzureFileShareConfiguration(String accountName, String accountKey, String azureFileUrl, String relativeMountPath)

Creates an instance of AzureFileShareConfiguration class.

Method Summary

Modifier and Type Method and Description
static AzureFileShareConfiguration fromJson(JsonReader jsonReader)

Reads an instance of AzureFileShareConfiguration 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 getAzureFileUrl()

Get the azureFileUrl property: The Azure Files URL.
String getMountOptions()

Get the mountOptions property: Additional command line options to pass to the mount command.
String getRelativeMountPath()

Get the relativeMountPath property: The relative path on the compute node where the file system will be mounted.
AzureFileShareConfiguration setMountOptions(String mountOptions)

Set the mountOptions property: Additional command line options to pass to the mount command.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AzureFileShareConfiguration

public AzureFileShareConfiguration(String accountName, String accountKey, String azureFileUrl, String relativeMountPath)

Creates an instance of AzureFileShareConfiguration class.

Parameters:

accountName - the accountName value to set.
accountKey - the accountKey value to set.
azureFileUrl - the azureFileUrl value to set.
relativeMountPath - the relativeMountPath value to set.

Method Details

fromJson

public static AzureFileShareConfiguration fromJson(JsonReader jsonReader)

Reads an instance of AzureFileShareConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Returns:

the accountKey value.

getAccountName

public String getAccountName()

Get the accountName property: The Azure Storage account name.

Returns:

the accountName value.

getAzureFileUrl

public String getAzureFileUrl()

Get the azureFileUrl property: The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'.

Returns:

the azureFileUrl value.

getMountOptions

public String getMountOptions()

Get the mountOptions 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 mountOptions 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.

setMountOptions

public AzureFileShareConfiguration setMountOptions(String mountOptions)

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

Parameters:

mountOptions - the mountOptions value to set.

Returns:

the AzureFileShareConfiguration object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to