Package com.azure.resourcemanager.containerinstance.models

Class AzureFileVolume

java.lang.Object
com.azure.resourcemanager.containerinstance.models.AzureFileVolume
All Implemented Interfaces:
com.azure.json.JsonSerializable<AzureFileVolume>
public final class AzureFileVolume extends Object implements com.azure.json.JsonSerializable<AzureFileVolume>
The properties of the Azure File volume. Azure File shares are mounted as volumes.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AzureFileVolume()
    Creates an instance of AzureFileVolume class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static AzureFileVolume
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of AzureFileVolume from the JsonReader.
    Boolean
    readOnly()
    Get the readOnly property: The flag indicating whether the Azure File shared mounted as a volume is read-only.
    String
    shareName()
    Get the shareName property: The name of the Azure File share to be mounted as a volume.
    String
    storageAccountKey()
    Get the storageAccountKey property: The storage account access key used to access the Azure File share.
    String
    storageAccountName()
    Get the storageAccountName property: The name of the storage account that contains the Azure File share.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    void
    validate()
    Validates the instance.
    AzureFileVolume
    withReadOnly(Boolean readOnly)
    Set the readOnly property: The flag indicating whether the Azure File shared mounted as a volume is read-only.
    AzureFileVolume
    withShareName(String shareName)
    Set the shareName property: The name of the Azure File share to be mounted as a volume.
    AzureFileVolume
    withStorageAccountKey(String storageAccountKey)
    Set the storageAccountKey property: The storage account access key used to access the Azure File share.
    AzureFileVolume
    withStorageAccountName(String storageAccountName)
    Set the storageAccountName property: The name of the storage account that contains the Azure File share.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • AzureFileVolume

      public AzureFileVolume()
      Creates an instance of AzureFileVolume class.

  • Method Details

    • shareName

      public String shareName()
      Get the shareName property: The name of the Azure File share to be mounted as a volume.
      Returns:
      the shareName value.

    • withShareName

      public AzureFileVolume withShareName(String shareName)
      Set the shareName property: The name of the Azure File share to be mounted as a volume.
      Parameters:
      shareName - the shareName value to set.
      Returns:
      the AzureFileVolume object itself.

    • readOnly

      public Boolean readOnly()
      Get the readOnly property: The flag indicating whether the Azure File shared mounted as a volume is read-only.
      Returns:
      the readOnly value.

    • withReadOnly

      public AzureFileVolume withReadOnly(Boolean readOnly)
      Set the readOnly property: The flag indicating whether the Azure File shared mounted as a volume is read-only.
      Parameters:
      readOnly - the readOnly value to set.
      Returns:
      the AzureFileVolume object itself.

    • storageAccountName

      public String storageAccountName()
      Get the storageAccountName property: The name of the storage account that contains the Azure File share.
      Returns:
      the storageAccountName value.

    • withStorageAccountName

      public AzureFileVolume withStorageAccountName(String storageAccountName)
      Set the storageAccountName property: The name of the storage account that contains the Azure File share.
      Parameters:
      storageAccountName - the storageAccountName value to set.
      Returns:
      the AzureFileVolume object itself.

    • storageAccountKey

      public String storageAccountKey()
      Get the storageAccountKey property: The storage account access key used to access the Azure File share.
      Returns:
      the storageAccountKey value.

    • withStorageAccountKey

      public AzureFileVolume withStorageAccountKey(String storageAccountKey)
      Set the storageAccountKey property: The storage account access key used to access the Azure File share.
      Parameters:
      storageAccountKey - the storageAccountKey value to set.
      Returns:
      the AzureFileVolume object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

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

    • fromJson

      public static AzureFileVolume fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AzureFileVolume from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AzureFileVolume 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 AzureFileVolume.