198 строки
14 KiB
YAML
198 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.appcontainers.models.Volume"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Volume"
|
|
name: "Volume"
|
|
nameWithType: "Volume"
|
|
summary: "Volume definitions for the Container App."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **Volume**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.appcontainers.models.Volume?alt=com.azure.resourcemanager.appcontainers.models.Volume&text=Volume\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.Volume()"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.Volume()"
|
|
name: "Volume()"
|
|
nameWithType: "Volume.Volume()"
|
|
summary: "Creates an instance of Volume class."
|
|
syntax: "public Volume()"
|
|
desc: "Creates an instance of Volume class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "Volume.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Volume from the Json<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The JsonReader being read."
|
|
name: "jsonReader"
|
|
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static Volume fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while reading the Volume."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of Volume from the JsonReader."
|
|
returns:
|
|
description: "An instance of Volume if the JsonReader was pointing to an instance of it, or null if it was pointing to\n JSON null."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.Volume?alt=com.azure.resourcemanager.appcontainers.models.Volume&text=Volume\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.mountOptions()"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.mountOptions()"
|
|
name: "mountOptions()"
|
|
nameWithType: "Volume.mountOptions()"
|
|
summary: "Get the mount<wbr>Options property: Mount options used while mounting the Azure<wbr>File."
|
|
syntax: "public String mountOptions()"
|
|
desc: "Get the mountOptions property: Mount options used while mounting the AzureFile. Must be a comma-separated string."
|
|
returns:
|
|
description: "the mountOptions value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.name()"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.name()"
|
|
name: "name()"
|
|
nameWithType: "Volume.name()"
|
|
summary: "Get the name property: Volume name."
|
|
syntax: "public String name()"
|
|
desc: "Get the name property: Volume name."
|
|
returns:
|
|
description: "the name value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.secrets()"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.secrets()"
|
|
name: "secrets()"
|
|
nameWithType: "Volume.secrets()"
|
|
summary: "Get the secrets property: List of secrets to be added in volume."
|
|
syntax: "public List<SecretVolumeItem> secrets()"
|
|
desc: "Get the secrets property: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume."
|
|
returns:
|
|
description: "the secrets value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.appcontainers.models.SecretVolumeItem?alt=com.azure.resourcemanager.appcontainers.models.SecretVolumeItem&text=SecretVolumeItem\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.storageName()"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.storageName()"
|
|
name: "storageName()"
|
|
nameWithType: "Volume.storageName()"
|
|
summary: "Get the storage<wbr>Name property: Name of storage resource."
|
|
syntax: "public String storageName()"
|
|
desc: "Get the storageName property: Name of storage resource. No need to provide for EmptyDir and Secret."
|
|
returns:
|
|
description: "the storageName value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.storageType()"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.storageType()"
|
|
name: "storageType()"
|
|
nameWithType: "Volume.storageType()"
|
|
summary: "Get the storage<wbr>Type property: Storage type for the volume."
|
|
syntax: "public StorageType storageType()"
|
|
desc: "Get the storageType property: Storage type for the volume. If not provided, use EmptyDir."
|
|
returns:
|
|
description: "the storageType value."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.StorageType?alt=com.azure.resourcemanager.appcontainers.models.StorageType&text=StorageType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "Volume.toJson(JsonWriter jsonWriter)"
|
|
parameters:
|
|
- name: "jsonWriter"
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.validate()"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.validate()"
|
|
name: "validate()"
|
|
nameWithType: "Volume.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.withMountOptions(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.withMountOptions(String mountOptions)"
|
|
name: "withMountOptions(String mountOptions)"
|
|
nameWithType: "Volume.withMountOptions(String mountOptions)"
|
|
summary: "Set the mount<wbr>Options property: Mount options used while mounting the Azure<wbr>File."
|
|
parameters:
|
|
- description: "the mountOptions value to set."
|
|
name: "mountOptions"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Volume withMountOptions(String mountOptions)"
|
|
desc: "Set the mountOptions property: Mount options used while mounting the AzureFile. Must be a comma-separated string."
|
|
returns:
|
|
description: "the Volume object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.Volume?alt=com.azure.resourcemanager.appcontainers.models.Volume&text=Volume\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.withName(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.withName(String name)"
|
|
name: "withName(String name)"
|
|
nameWithType: "Volume.withName(String name)"
|
|
summary: "Set the name property: Volume name."
|
|
parameters:
|
|
- description: "the name value to set."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Volume withName(String name)"
|
|
desc: "Set the name property: Volume name."
|
|
returns:
|
|
description: "the Volume object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.Volume?alt=com.azure.resourcemanager.appcontainers.models.Volume&text=Volume\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.withSecrets(java.util.List<com.azure.resourcemanager.appcontainers.models.SecretVolumeItem>)"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.withSecrets(List<SecretVolumeItem> secrets)"
|
|
name: "withSecrets(List<SecretVolumeItem> secrets)"
|
|
nameWithType: "Volume.withSecrets(List<SecretVolumeItem> secrets)"
|
|
summary: "Set the secrets property: List of secrets to be added in volume."
|
|
parameters:
|
|
- description: "the secrets value to set."
|
|
name: "secrets"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.appcontainers.models.SecretVolumeItem?alt=com.azure.resourcemanager.appcontainers.models.SecretVolumeItem&text=SecretVolumeItem\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public Volume withSecrets(List<SecretVolumeItem> secrets)"
|
|
desc: "Set the secrets property: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume."
|
|
returns:
|
|
description: "the Volume object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.Volume?alt=com.azure.resourcemanager.appcontainers.models.Volume&text=Volume\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.withStorageName(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.withStorageName(String storageName)"
|
|
name: "withStorageName(String storageName)"
|
|
nameWithType: "Volume.withStorageName(String storageName)"
|
|
summary: "Set the storage<wbr>Name property: Name of storage resource."
|
|
parameters:
|
|
- description: "the storageName value to set."
|
|
name: "storageName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Volume withStorageName(String storageName)"
|
|
desc: "Set the storageName property: Name of storage resource. No need to provide for EmptyDir and Secret."
|
|
returns:
|
|
description: "the Volume object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.Volume?alt=com.azure.resourcemanager.appcontainers.models.Volume&text=Volume\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Volume.withStorageType(com.azure.resourcemanager.appcontainers.models.StorageType)"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Volume.withStorageType(StorageType storageType)"
|
|
name: "withStorageType(StorageType storageType)"
|
|
nameWithType: "Volume.withStorageType(StorageType storageType)"
|
|
summary: "Set the storage<wbr>Type property: Storage type for the volume."
|
|
parameters:
|
|
- description: "the storageType value to set."
|
|
name: "storageType"
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.StorageType?alt=com.azure.resourcemanager.appcontainers.models.StorageType&text=StorageType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Volume withStorageType(StorageType storageType)"
|
|
desc: "Set the storageType property: Storage type for the volume. If not provided, use EmptyDir."
|
|
returns:
|
|
description: "the Volume object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.Volume?alt=com.azure.resourcemanager.appcontainers.models.Volume&text=Volume\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Volume definitions for the Container App."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.appcontainers.models.Volume?alt=com.azure.resourcemanager.appcontainers.models.Volume&text=Volume\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.appcontainers.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-appcontainers:1.0.0
|