Package com.azure.compute.batch.models

Class AzureBlobFileSystemConfiguration

java.lang.Object
com.azure.compute.batch.models.AzureBlobFileSystemConfiguration
All Implemented Interfaces:
com.azure.json.JsonSerializable<AzureBlobFileSystemConfiguration>
public final class AzureBlobFileSystemConfiguration extends Object implements com.azure.json.JsonSerializable<AzureBlobFileSystemConfiguration>
Information used to connect to an Azure Storage Container using Blobfuse.

  • 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

    • getAccountName

      public String getAccountName()
      Get the accountName property: The Azure Storage Account name.
      Returns:
      the accountName value.

    • getContainerName

      public String getContainerName()
      Get the containerName property: The Azure Blob Storage Container name.
      Returns:
      the containerName value.

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

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

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

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

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

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

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

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

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AzureBlobFileSystemConfiguration>
      Throws:
      IOException

    • fromJson

      public static AzureBlobFileSystemConfiguration fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the AzureBlobFileSystemConfiguration.