azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.a...

198 строки
13 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.avs.models.Sku"
fullName: "com.azure.resourcemanager.avs.models.Sku"
name: "Sku"
nameWithType: "Sku"
summary: "The resource model definition representing SKU."
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 **Sku**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.avs.models.Sku?alt=com.azure.resourcemanager.avs.models.Sku&text=Sku\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.avs.models.Sku.Sku()"
fullName: "com.azure.resourcemanager.avs.models.Sku.Sku()"
name: "Sku()"
nameWithType: "Sku.Sku()"
summary: "Creates an instance of Sku class."
syntax: "public Sku()"
desc: "Creates an instance of Sku class."
methods:
- uid: "com.azure.resourcemanager.avs.models.Sku.capacity()"
fullName: "com.azure.resourcemanager.avs.models.Sku.capacity()"
name: "capacity()"
nameWithType: "Sku.capacity()"
summary: "Get the capacity property: If the SKU supports scale out/in then the capacity integer should be included."
syntax: "public Integer capacity()"
desc: "Get the capacity property: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted."
returns:
description: "the capacity value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.avs.models.Sku.family()"
fullName: "com.azure.resourcemanager.avs.models.Sku.family()"
name: "family()"
nameWithType: "Sku.family()"
summary: "Get the family property: If the service has different generations of hardware, for the same SKU, then that can be captured here."
syntax: "public String family()"
desc: "Get the family property: If the service has different generations of hardware, for the same SKU, then that can be captured here."
returns:
description: "the family value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.avs.models.Sku.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.avs.models.Sku.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "Sku.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Sku 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 Sku fromJson(JsonReader jsonReader)"
exceptions:
- description: "If the deserialized JSON object was missing any required properties."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of Sku from the JsonReader."
returns:
description: "An instance of Sku 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.avs.models.Sku?alt=com.azure.resourcemanager.avs.models.Sku&text=Sku\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.avs.models.Sku.name()"
fullName: "com.azure.resourcemanager.avs.models.Sku.name()"
name: "name()"
nameWithType: "Sku.name()"
summary: "Get the name property: The name of the SKU."
syntax: "public String name()"
desc: "Get the name property: The name of the SKU. E.g. P3. It is typically a letter+number code."
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.avs.models.Sku.size()"
fullName: "com.azure.resourcemanager.avs.models.Sku.size()"
name: "size()"
nameWithType: "Sku.size()"
summary: "Get the size property: The SKU size."
syntax: "public String size()"
desc: "Get the size property: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code."
returns:
description: "the size value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.avs.models.Sku.tier()"
fullName: "com.azure.resourcemanager.avs.models.Sku.tier()"
name: "tier()"
nameWithType: "Sku.tier()"
summary: "Get the tier property: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT."
syntax: "public SkuTier tier()"
desc: "Get the tier property: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT."
returns:
description: "the tier value."
type: "<xref href=\"com.azure.resourcemanager.avs.models.SkuTier?alt=com.azure.resourcemanager.avs.models.SkuTier&text=SkuTier\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.avs.models.Sku.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.avs.models.Sku.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "Sku.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.avs.models.Sku.validate()"
fullName: "com.azure.resourcemanager.avs.models.Sku.validate()"
name: "validate()"
nameWithType: "Sku.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.avs.models.Sku.withCapacity(java.lang.Integer)"
fullName: "com.azure.resourcemanager.avs.models.Sku.withCapacity(Integer capacity)"
name: "withCapacity(Integer capacity)"
nameWithType: "Sku.withCapacity(Integer capacity)"
summary: "Set the capacity property: If the SKU supports scale out/in then the capacity integer should be included."
parameters:
- description: "the capacity value to set."
name: "capacity"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public Sku withCapacity(Integer capacity)"
desc: "Set the capacity property: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted."
returns:
description: "the Sku object itself."
type: "<xref href=\"com.azure.resourcemanager.avs.models.Sku?alt=com.azure.resourcemanager.avs.models.Sku&text=Sku\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.avs.models.Sku.withFamily(java.lang.String)"
fullName: "com.azure.resourcemanager.avs.models.Sku.withFamily(String family)"
name: "withFamily(String family)"
nameWithType: "Sku.withFamily(String family)"
summary: "Set the family property: If the service has different generations of hardware, for the same SKU, then that can be captured here."
parameters:
- description: "the family value to set."
name: "family"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Sku withFamily(String family)"
desc: "Set the family property: If the service has different generations of hardware, for the same SKU, then that can be captured here."
returns:
description: "the Sku object itself."
type: "<xref href=\"com.azure.resourcemanager.avs.models.Sku?alt=com.azure.resourcemanager.avs.models.Sku&text=Sku\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.avs.models.Sku.withName(java.lang.String)"
fullName: "com.azure.resourcemanager.avs.models.Sku.withName(String name)"
name: "withName(String name)"
nameWithType: "Sku.withName(String name)"
summary: "Set the name property: The name of the SKU."
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 Sku withName(String name)"
desc: "Set the name property: The name of the SKU. E.g. P3. It is typically a letter+number code."
returns:
description: "the Sku object itself."
type: "<xref href=\"com.azure.resourcemanager.avs.models.Sku?alt=com.azure.resourcemanager.avs.models.Sku&text=Sku\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.avs.models.Sku.withSize(java.lang.String)"
fullName: "com.azure.resourcemanager.avs.models.Sku.withSize(String size)"
name: "withSize(String size)"
nameWithType: "Sku.withSize(String size)"
summary: "Set the size property: The SKU size."
parameters:
- description: "the size value to set."
name: "size"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Sku withSize(String size)"
desc: "Set the size property: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code."
returns:
description: "the Sku object itself."
type: "<xref href=\"com.azure.resourcemanager.avs.models.Sku?alt=com.azure.resourcemanager.avs.models.Sku&text=Sku\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.avs.models.Sku.withTier(com.azure.resourcemanager.avs.models.SkuTier)"
fullName: "com.azure.resourcemanager.avs.models.Sku.withTier(SkuTier tier)"
name: "withTier(SkuTier tier)"
nameWithType: "Sku.withTier(SkuTier tier)"
summary: "Set the tier property: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT."
parameters:
- description: "the tier value to set."
name: "tier"
type: "<xref href=\"com.azure.resourcemanager.avs.models.SkuTier?alt=com.azure.resourcemanager.avs.models.SkuTier&text=SkuTier\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Sku withTier(SkuTier tier)"
desc: "Set the tier property: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT."
returns:
description: "the Sku object itself."
type: "<xref href=\"com.azure.resourcemanager.avs.models.Sku?alt=com.azure.resourcemanager.avs.models.Sku&text=Sku\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The resource model definition representing SKU."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.avs.models.Sku?alt=com.azure.resourcemanager.avs.models.Sku&text=Sku\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.avs.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-avs:1.2.0