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

294 строки
22 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.billing.models.PurchaseRequest"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest"
name: "PurchaseRequest"
nameWithType: "PurchaseRequest"
summary: "Purchase request."
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 **PurchaseRequest**</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.billing.models.PurchaseRequest?alt=com.azure.resourcemanager.billing.models.PurchaseRequest&text=PurchaseRequest\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.PurchaseRequest()"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.PurchaseRequest()"
name: "PurchaseRequest()"
nameWithType: "PurchaseRequest.PurchaseRequest()"
summary: "Creates an instance of Purchase<wbr>Request class."
syntax: "public PurchaseRequest()"
desc: "Creates an instance of PurchaseRequest class."
methods:
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.appliedScopeProperties()"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.appliedScopeProperties()"
name: "appliedScopeProperties()"
nameWithType: "PurchaseRequest.appliedScopeProperties()"
summary: "Get the applied<wbr>Scope<wbr>Properties property: Properties specific to applied scope type."
syntax: "public AppliedScopeProperties appliedScopeProperties()"
desc: "Get the appliedScopeProperties property: Properties specific to applied scope type. Not required if not applicable."
returns:
description: "the appliedScopeProperties value."
type: "<xref href=\"com.azure.resourcemanager.billing.models.AppliedScopeProperties?alt=com.azure.resourcemanager.billing.models.AppliedScopeProperties&text=AppliedScopeProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.appliedScopeType()"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.appliedScopeType()"
name: "appliedScopeType()"
nameWithType: "PurchaseRequest.appliedScopeType()"
summary: "Get the applied<wbr>Scope<wbr>Type property: Type of the Applied Scope."
syntax: "public AppliedScopeType appliedScopeType()"
desc: "Get the appliedScopeType property: Type of the Applied Scope."
returns:
description: "the appliedScopeType value."
type: "<xref href=\"com.azure.resourcemanager.billing.models.AppliedScopeType?alt=com.azure.resourcemanager.billing.models.AppliedScopeType&text=AppliedScopeType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.billingPlan()"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.billingPlan()"
name: "billingPlan()"
nameWithType: "PurchaseRequest.billingPlan()"
summary: "Get the billing<wbr>Plan property: Represents the billing plan in ISO 8601 format."
syntax: "public BillingPlan billingPlan()"
desc: "Get the billingPlan property: Represents the billing plan in ISO 8601 format. Required only for monthly purchases."
returns:
description: "the billingPlan value."
type: "<xref href=\"com.azure.resourcemanager.billing.models.BillingPlan?alt=com.azure.resourcemanager.billing.models.BillingPlan&text=BillingPlan\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.billingScopeId()"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.billingScopeId()"
name: "billingScopeId()"
nameWithType: "PurchaseRequest.billingScopeId()"
summary: "Get the billing<wbr>Scope<wbr>Id property: Subscription that will be charged for purchasing Savings<wbr>Plan."
syntax: "public String billingScopeId()"
desc: "Get the billingScopeId property: Subscription that will be charged for purchasing SavingsPlan."
returns:
description: "the billingScopeId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.commitment()"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.commitment()"
name: "commitment()"
nameWithType: "PurchaseRequest.commitment()"
summary: "Get the commitment property: Commitment towards the benefit."
syntax: "public Commitment commitment()"
desc: "Get the commitment property: Commitment towards the benefit."
returns:
description: "the commitment value."
type: "<xref href=\"com.azure.resourcemanager.billing.models.Commitment?alt=com.azure.resourcemanager.billing.models.Commitment&text=Commitment\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.displayName()"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.displayName()"
name: "displayName()"
nameWithType: "PurchaseRequest.displayName()"
summary: "Get the display<wbr>Name property: Friendly name of the savings plan."
syntax: "public String displayName()"
desc: "Get the displayName property: Friendly name of the savings plan."
returns:
description: "the displayName value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "PurchaseRequest.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Purchase<wbr>Request 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 PurchaseRequest fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the PurchaseRequest."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of PurchaseRequest from the JsonReader."
returns:
description: "An instance of PurchaseRequest if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
type: "<xref href=\"com.azure.resourcemanager.billing.models.PurchaseRequest?alt=com.azure.resourcemanager.billing.models.PurchaseRequest&text=PurchaseRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.renew()"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.renew()"
name: "renew()"
nameWithType: "PurchaseRequest.renew()"
summary: "Get the renew property: Setting this to true will automatically purchase a new benefit on the expiration date time."
syntax: "public Boolean renew()"
desc: "Get the renew property: Setting this to true will automatically purchase a new benefit on the expiration date time."
returns:
description: "the renew value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.sku()"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.sku()"
name: "sku()"
nameWithType: "PurchaseRequest.sku()"
summary: "Get the sku property: The SKU to be applied for this resource."
syntax: "public Sku sku()"
desc: "Get the sku property: The SKU to be applied for this resource."
returns:
description: "the sku value."
type: "<xref href=\"com.azure.resourcemanager.billing.models.Sku?alt=com.azure.resourcemanager.billing.models.Sku&text=Sku\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.term()"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.term()"
name: "term()"
nameWithType: "PurchaseRequest.term()"
summary: "Get the term property: Represents the Savings plan term in ISO 8601 format."
syntax: "public SavingsPlanTerm term()"
desc: "Get the term property: Represents the Savings plan term in ISO 8601 format."
returns:
description: "the term value."
type: "<xref href=\"com.azure.resourcemanager.billing.models.SavingsPlanTerm?alt=com.azure.resourcemanager.billing.models.SavingsPlanTerm&text=SavingsPlanTerm\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "PurchaseRequest.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.billing.models.PurchaseRequest.validate()"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.validate()"
name: "validate()"
nameWithType: "PurchaseRequest.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.withAppliedScopeProperties(com.azure.resourcemanager.billing.models.AppliedScopeProperties)"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.withAppliedScopeProperties(AppliedScopeProperties appliedScopeProperties)"
name: "withAppliedScopeProperties(AppliedScopeProperties appliedScopeProperties)"
nameWithType: "PurchaseRequest.withAppliedScopeProperties(AppliedScopeProperties appliedScopeProperties)"
summary: "Set the applied<wbr>Scope<wbr>Properties property: Properties specific to applied scope type."
parameters:
- description: "the appliedScopeProperties value to set."
name: "appliedScopeProperties"
type: "<xref href=\"com.azure.resourcemanager.billing.models.AppliedScopeProperties?alt=com.azure.resourcemanager.billing.models.AppliedScopeProperties&text=AppliedScopeProperties\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PurchaseRequest withAppliedScopeProperties(AppliedScopeProperties appliedScopeProperties)"
desc: "Set the appliedScopeProperties property: Properties specific to applied scope type. Not required if not applicable."
returns:
description: "the PurchaseRequest object itself."
type: "<xref href=\"com.azure.resourcemanager.billing.models.PurchaseRequest?alt=com.azure.resourcemanager.billing.models.PurchaseRequest&text=PurchaseRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.withAppliedScopeType(com.azure.resourcemanager.billing.models.AppliedScopeType)"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.withAppliedScopeType(AppliedScopeType appliedScopeType)"
name: "withAppliedScopeType(AppliedScopeType appliedScopeType)"
nameWithType: "PurchaseRequest.withAppliedScopeType(AppliedScopeType appliedScopeType)"
summary: "Set the applied<wbr>Scope<wbr>Type property: Type of the Applied Scope."
parameters:
- description: "the appliedScopeType value to set."
name: "appliedScopeType"
type: "<xref href=\"com.azure.resourcemanager.billing.models.AppliedScopeType?alt=com.azure.resourcemanager.billing.models.AppliedScopeType&text=AppliedScopeType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PurchaseRequest withAppliedScopeType(AppliedScopeType appliedScopeType)"
desc: "Set the appliedScopeType property: Type of the Applied Scope."
returns:
description: "the PurchaseRequest object itself."
type: "<xref href=\"com.azure.resourcemanager.billing.models.PurchaseRequest?alt=com.azure.resourcemanager.billing.models.PurchaseRequest&text=PurchaseRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.withBillingPlan(com.azure.resourcemanager.billing.models.BillingPlan)"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.withBillingPlan(BillingPlan billingPlan)"
name: "withBillingPlan(BillingPlan billingPlan)"
nameWithType: "PurchaseRequest.withBillingPlan(BillingPlan billingPlan)"
summary: "Set the billing<wbr>Plan property: Represents the billing plan in ISO 8601 format."
parameters:
- description: "the billingPlan value to set."
name: "billingPlan"
type: "<xref href=\"com.azure.resourcemanager.billing.models.BillingPlan?alt=com.azure.resourcemanager.billing.models.BillingPlan&text=BillingPlan\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PurchaseRequest withBillingPlan(BillingPlan billingPlan)"
desc: "Set the billingPlan property: Represents the billing plan in ISO 8601 format. Required only for monthly purchases."
returns:
description: "the PurchaseRequest object itself."
type: "<xref href=\"com.azure.resourcemanager.billing.models.PurchaseRequest?alt=com.azure.resourcemanager.billing.models.PurchaseRequest&text=PurchaseRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.withBillingScopeId(java.lang.String)"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.withBillingScopeId(String billingScopeId)"
name: "withBillingScopeId(String billingScopeId)"
nameWithType: "PurchaseRequest.withBillingScopeId(String billingScopeId)"
summary: "Set the billing<wbr>Scope<wbr>Id property: Subscription that will be charged for purchasing Savings<wbr>Plan."
parameters:
- description: "the billingScopeId value to set."
name: "billingScopeId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public PurchaseRequest withBillingScopeId(String billingScopeId)"
desc: "Set the billingScopeId property: Subscription that will be charged for purchasing SavingsPlan."
returns:
description: "the PurchaseRequest object itself."
type: "<xref href=\"com.azure.resourcemanager.billing.models.PurchaseRequest?alt=com.azure.resourcemanager.billing.models.PurchaseRequest&text=PurchaseRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.withCommitment(com.azure.resourcemanager.billing.models.Commitment)"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.withCommitment(Commitment commitment)"
name: "withCommitment(Commitment commitment)"
nameWithType: "PurchaseRequest.withCommitment(Commitment commitment)"
summary: "Set the commitment property: Commitment towards the benefit."
parameters:
- description: "the commitment value to set."
name: "commitment"
type: "<xref href=\"com.azure.resourcemanager.billing.models.Commitment?alt=com.azure.resourcemanager.billing.models.Commitment&text=Commitment\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PurchaseRequest withCommitment(Commitment commitment)"
desc: "Set the commitment property: Commitment towards the benefit."
returns:
description: "the PurchaseRequest object itself."
type: "<xref href=\"com.azure.resourcemanager.billing.models.PurchaseRequest?alt=com.azure.resourcemanager.billing.models.PurchaseRequest&text=PurchaseRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.withDisplayName(java.lang.String)"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.withDisplayName(String displayName)"
name: "withDisplayName(String displayName)"
nameWithType: "PurchaseRequest.withDisplayName(String displayName)"
summary: "Set the display<wbr>Name property: Friendly name of the savings plan."
parameters:
- description: "the displayName value to set."
name: "displayName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public PurchaseRequest withDisplayName(String displayName)"
desc: "Set the displayName property: Friendly name of the savings plan."
returns:
description: "the PurchaseRequest object itself."
type: "<xref href=\"com.azure.resourcemanager.billing.models.PurchaseRequest?alt=com.azure.resourcemanager.billing.models.PurchaseRequest&text=PurchaseRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.withRenew(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.withRenew(Boolean renew)"
name: "withRenew(Boolean renew)"
nameWithType: "PurchaseRequest.withRenew(Boolean renew)"
summary: "Set the renew property: Setting this to true will automatically purchase a new benefit on the expiration date time."
parameters:
- description: "the renew value to set."
name: "renew"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public PurchaseRequest withRenew(Boolean renew)"
desc: "Set the renew property: Setting this to true will automatically purchase a new benefit on the expiration date time."
returns:
description: "the PurchaseRequest object itself."
type: "<xref href=\"com.azure.resourcemanager.billing.models.PurchaseRequest?alt=com.azure.resourcemanager.billing.models.PurchaseRequest&text=PurchaseRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.withSku(com.azure.resourcemanager.billing.models.Sku)"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.withSku(Sku sku)"
name: "withSku(Sku sku)"
nameWithType: "PurchaseRequest.withSku(Sku sku)"
summary: "Set the sku property: The SKU to be applied for this resource."
parameters:
- description: "the sku value to set."
name: "sku"
type: "<xref href=\"com.azure.resourcemanager.billing.models.Sku?alt=com.azure.resourcemanager.billing.models.Sku&text=Sku\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PurchaseRequest withSku(Sku sku)"
desc: "Set the sku property: The SKU to be applied for this resource."
returns:
description: "the PurchaseRequest object itself."
type: "<xref href=\"com.azure.resourcemanager.billing.models.PurchaseRequest?alt=com.azure.resourcemanager.billing.models.PurchaseRequest&text=PurchaseRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.billing.models.PurchaseRequest.withTerm(com.azure.resourcemanager.billing.models.SavingsPlanTerm)"
fullName: "com.azure.resourcemanager.billing.models.PurchaseRequest.withTerm(SavingsPlanTerm term)"
name: "withTerm(SavingsPlanTerm term)"
nameWithType: "PurchaseRequest.withTerm(SavingsPlanTerm term)"
summary: "Set the term property: Represents the Savings plan term in ISO 8601 format."
parameters:
- description: "the term value to set."
name: "term"
type: "<xref href=\"com.azure.resourcemanager.billing.models.SavingsPlanTerm?alt=com.azure.resourcemanager.billing.models.SavingsPlanTerm&text=SavingsPlanTerm\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PurchaseRequest withTerm(SavingsPlanTerm term)"
desc: "Set the term property: Represents the Savings plan term in ISO 8601 format."
returns:
description: "the PurchaseRequest object itself."
type: "<xref href=\"com.azure.resourcemanager.billing.models.PurchaseRequest?alt=com.azure.resourcemanager.billing.models.PurchaseRequest&text=PurchaseRequest\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Purchase request."
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.billing.models.PurchaseRequest?alt=com.azure.resourcemanager.billing.models.PurchaseRequest&text=PurchaseRequest\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.billing.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-billing:1.0.0