AzureFileShareReference Class

  • java.lang.Object
    • com.azure.resourcemanager.batchai.models.AzureFileShareReference

public final class AzureFileShareReference

Azure File Share mounting configuration.

Constructor Summary

Constructor Description
AzureFileShareReference()

Method Summary

Modifier and Type Method and Description
String accountName()

Get the accountName property: Name of the Azure storage account.

String azureFileUrl()

Get the azureFileUrl property: URL to access the Azure File.

AzureStorageCredentialsInfo credentials()

Get the credentials property: Information about the Azure storage credentials.

String directoryMode()

Get the directoryMode property: File mode for directories on the mounted file share.

String fileMode()

Get the fileMode property: File mode for files on the mounted file share.

String relativeMountPath()

Get the relativeMountPath property: The relative path on the compute node where the Azure File share will be mounted.

void validate()

Validates the instance.

AzureFileShareReference withAccountName(String accountName)

Set the accountName property: Name of the Azure storage account.

AzureFileShareReference withAzureFileUrl(String azureFileUrl)

Set the azureFileUrl property: URL to access the Azure File.

AzureFileShareReference withCredentials(AzureStorageCredentialsInfo credentials)

Set the credentials property: Information about the Azure storage credentials.

AzureFileShareReference withDirectoryMode(String directoryMode)

Set the directoryMode property: File mode for directories on the mounted file share.

AzureFileShareReference withFileMode(String fileMode)

Set the fileMode property: File mode for files on the mounted file share.

AzureFileShareReference withRelativeMountPath(String relativeMountPath)

Set the relativeMountPath property: The relative path on the compute node where the Azure File share will be mounted.

Methods inherited from java.lang.Object

Constructor Details

AzureFileShareReference

public AzureFileShareReference()

Method Details

accountName

public String accountName()

Get the accountName property: Name of the Azure storage account.

Returns:

the accountName value.

azureFileUrl

public String azureFileUrl()

Get the azureFileUrl property: URL to access the Azure File.

Returns:

the azureFileUrl value.

credentials

public AzureStorageCredentialsInfo credentials()

Get the credentials property: Information about the Azure storage credentials.

Returns:

the credentials value.

directoryMode

public String directoryMode()

Get the directoryMode property: File mode for directories on the mounted file share. Default value: 0777.

Returns:

the directoryMode value.

fileMode

public String fileMode()

Get the fileMode property: File mode for files on the mounted file share. Default value: 0777.

Returns:

the fileMode value.

relativeMountPath

public String relativeMountPath()

Get the relativeMountPath property: The relative path on the compute node where the Azure File share will be mounted. Note that all cluster level file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level file shares will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.

Returns:

the relativeMountPath value.

validate

public void validate()

Validates the instance.

withAccountName

public AzureFileShareReference withAccountName(String accountName)

Set the accountName property: Name of the Azure storage account.

Parameters:

accountName - the accountName value to set.

Returns:

the AzureFileShareReference object itself.

withAzureFileUrl

public AzureFileShareReference withAzureFileUrl(String azureFileUrl)

Set the azureFileUrl property: URL to access the Azure File.

Parameters:

azureFileUrl - the azureFileUrl value to set.

Returns:

the AzureFileShareReference object itself.

withCredentials

public AzureFileShareReference withCredentials(AzureStorageCredentialsInfo credentials)

Set the credentials property: Information about the Azure storage credentials.

Parameters:

credentials - the credentials value to set.

Returns:

the AzureFileShareReference object itself.

withDirectoryMode

public AzureFileShareReference withDirectoryMode(String directoryMode)

Set the directoryMode property: File mode for directories on the mounted file share. Default value: 0777.

Parameters:

directoryMode - the directoryMode value to set.

Returns:

the AzureFileShareReference object itself.

withFileMode

public AzureFileShareReference withFileMode(String fileMode)

Set the fileMode property: File mode for files on the mounted file share. Default value: 0777.

Parameters:

fileMode - the fileMode value to set.

Returns:

the AzureFileShareReference object itself.

withRelativeMountPath

public AzureFileShareReference withRelativeMountPath(String relativeMountPath)

Set the relativeMountPath property: The relative path on the compute node where the Azure File share will be mounted. Note that all cluster level file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level file shares will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.

Parameters:

relativeMountPath - the relativeMountPath value to set.

Returns:

the AzureFileShareReference object itself.

Applies to