Class AzureFileVolume

java.lang.Object
com.azure.resourcemanager.appplatform.models.CustomPersistentDiskProperties
com.azure.resourcemanager.appplatform.models.AzureFileVolume
All Implemented Interfaces:
com.azure.json.JsonSerializable<CustomPersistentDiskProperties>

public final class AzureFileVolume extends CustomPersistentDiskProperties
The properties of the Azure File volume. Azure File shares are mounted as volumes.
  • Constructor Details

    • AzureFileVolume

      public AzureFileVolume()
      Creates an instance of AzureFileVolume class.
  • Method Details

    • type

      public Type type()
      Get the type property: The type of the underlying resource to mount as a persistent disk.
      Overrides:
      type in class CustomPersistentDiskProperties
      Returns:
      the type value.
    • shareName

      public String shareName()
      Get the shareName property: The share name of the Azure File share.
      Returns:
      the shareName value.
    • withShareName

      public AzureFileVolume withShareName(String shareName)
      Set the shareName property: The share name of the Azure File share.
      Parameters:
      shareName - the shareName value to set.
      Returns:
      the AzureFileVolume object itself.
    • withMountPath

      public AzureFileVolume withMountPath(String mountPath)
      Set the mountPath property: The mount path of the persistent disk.
      Overrides:
      withMountPath in class CustomPersistentDiskProperties
      Parameters:
      mountPath - the mountPath value to set.
      Returns:
      the CustomPersistentDiskProperties object itself.
    • withReadOnly

      public AzureFileVolume withReadOnly(Boolean readOnly)
      Set the readOnly property: Indicates whether the persistent disk is a readOnly one.
      Overrides:
      withReadOnly in class CustomPersistentDiskProperties
      Parameters:
      readOnly - the readOnly value to set.
      Returns:
      the CustomPersistentDiskProperties object itself.
    • withEnableSubPath

      public AzureFileVolume withEnableSubPath(Boolean enableSubPath)
      Set the enableSubPath property: If set to true, it will create and mount a dedicated directory for every individual app instance.
      Overrides:
      withEnableSubPath in class CustomPersistentDiskProperties
      Parameters:
      enableSubPath - the enableSubPath value to set.
      Returns:
      the CustomPersistentDiskProperties object itself.
    • withMountOptions

      public AzureFileVolume withMountOptions(List<String> mountOptions)
      Set the mountOptions property: These are the mount options for a persistent disk.
      Overrides:
      withMountOptions in class CustomPersistentDiskProperties
      Parameters:
      mountOptions - the mountOptions value to set.
      Returns:
      the CustomPersistentDiskProperties object itself.
    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class CustomPersistentDiskProperties
      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<CustomPersistentDiskProperties>
      Overrides:
      toJson in class CustomPersistentDiskProperties
      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.