azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.documen...

154 строки
16 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.documentdb.OfferV2"
fullName: "com.microsoft.azure.documentdb.OfferV2"
name: "OfferV2"
nameWithType: "OfferV2"
summary: "Represents an offer version 2 in the Azure Cosmos DB database service."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Resource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Offer?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable?alt=com.microsoft.azure.documentdb.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>getCollection(java.lang.String,java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>getCollection&text=<T>getCollection\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>getObject(java.lang.String,java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>getObject&text=<T>getObject\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>set(java.lang.String,T)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>set&text=<T>set\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>toObject(java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>toObject&text=<T>toObject\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.get(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.get&text=get\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getBoolean(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getBoolean&text=getBoolean\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getCollection(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getCollection&text=getCollection\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getDouble(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getDouble&text=getDouble\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getHashMap()?alt=com.microsoft.azure.documentdb.JsonSerializable.getHashMap&text=getHashMap\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getInt(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getInt&text=getInt\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getLogger()?alt=com.microsoft.azure.documentdb.JsonSerializable.getLogger&text=getLogger\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getLong(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getLong&text=getLong\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getMapper()?alt=com.microsoft.azure.documentdb.JsonSerializable.getMapper&text=getMapper\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getObject(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getObject&text=getObject\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getObjectByPath(java.util.Collection<java.lang.String>)?alt=com.microsoft.azure.documentdb.JsonSerializable.getObjectByPath&text=getObjectByPath\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getString(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getString&text=getString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.has(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.has&text=has\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.remove(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.remove&text=remove\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toJson()?alt=com.microsoft.azure.documentdb.JsonSerializable.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toJson(com.microsoft.azure.documentdb.SerializationFormattingPolicy)?alt=com.microsoft.azure.documentdb.JsonSerializable.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toString()?alt=com.microsoft.azure.documentdb.JsonSerializable.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toString(int)?alt=com.microsoft.azure.documentdb.JsonSerializable.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- classRef: "<xref href=\"com.microsoft.azure.documentdb.Offer?alt=com.microsoft.azure.documentdb.Offer&text=Offer\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.microsoft.azure.documentdb.Offer.getContent()?alt=com.microsoft.azure.documentdb.Offer.getContent&text=getContent\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Offer.getOfferResourceId()?alt=com.microsoft.azure.documentdb.Offer.getOfferResourceId&text=getOfferResourceId\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Offer.getOfferType()?alt=com.microsoft.azure.documentdb.Offer.getOfferType&text=getOfferType\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Offer.getOfferVersion()?alt=com.microsoft.azure.documentdb.Offer.getOfferVersion&text=getOfferVersion\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Offer.getResourceLink()?alt=com.microsoft.azure.documentdb.Offer.getResourceLink&text=getResourceLink\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Offer.setContent(org.json.JSONObject)?alt=com.microsoft.azure.documentdb.Offer.setContent&text=setContent\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Offer.setOfferType(java.lang.String)?alt=com.microsoft.azure.documentdb.Offer.setOfferType&text=setOfferType\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Offer.setOfferVersion(java.lang.String)?alt=com.microsoft.azure.documentdb.Offer.setOfferVersion&text=setOfferVersion\" data-throw-if-not-resolved=\"False\" />"
- classRef: "<xref href=\"com.microsoft.azure.documentdb.Resource?alt=com.microsoft.azure.documentdb.Resource&text=Resource\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getETag()?alt=com.microsoft.azure.documentdb.Resource.getETag&text=getETag\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getId()?alt=com.microsoft.azure.documentdb.Resource.getId&text=getId\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getResourceId()?alt=com.microsoft.azure.documentdb.Resource.getResourceId&text=getResourceId\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getSelfLink()?alt=com.microsoft.azure.documentdb.Resource.getSelfLink&text=getSelfLink\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getTimestamp()?alt=com.microsoft.azure.documentdb.Resource.getTimestamp&text=getTimestamp\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Resource.setId(java.lang.String)?alt=com.microsoft.azure.documentdb.Resource.setId&text=setId\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.documentdb.Resource.setResourceId(java.lang.String)?alt=com.microsoft.azure.documentdb.Resource.setResourceId&text=setResourceId\" data-throw-if-not-resolved=\"False\" />"
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **OfferV2**</br> extends <xref href=\"com.microsoft.azure.documentdb.Offer?alt=com.microsoft.azure.documentdb.Offer&text=Offer\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.azure.documentdb.OfferV2.OfferV2(com.microsoft.azure.documentdb.Offer)"
fullName: "com.microsoft.azure.documentdb.OfferV2.OfferV2(Offer otherOffer)"
name: "OfferV2(Offer otherOffer)"
nameWithType: "OfferV2.OfferV2(Offer otherOffer)"
summary: "Initialize an new instance of the OfferV2 object, copy the base properties from another Offer object and set the throughput value."
parameters:
- description: "the Offer object whose base properties are to be copied."
name: "otherOffer"
type: "<xref href=\"com.microsoft.azure.documentdb.Offer?alt=com.microsoft.azure.documentdb.Offer&text=Offer\" data-throw-if-not-resolved=\"False\" />"
syntax: "public OfferV2(Offer otherOffer)"
desc: "Initialize an new instance of the OfferV2 object, copy the base properties from another Offer object and set the throughput value."
- uid: "com.microsoft.azure.documentdb.OfferV2.OfferV2(int)"
fullName: "com.microsoft.azure.documentdb.OfferV2.OfferV2(int offerThroughput)"
name: "OfferV2(int offerThroughput)"
nameWithType: "OfferV2.OfferV2(int offerThroughput)"
summary: "Initialize an new instance of the OfferV2 object."
parameters:
- description: "the throughput value for this offer."
name: "offerThroughput"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
syntax: "public OfferV2(int offerThroughput)"
desc: "Initialize an new instance of the OfferV2 object."
- uid: "com.microsoft.azure.documentdb.OfferV2.OfferV2(int,boolean)"
fullName: "com.microsoft.azure.documentdb.OfferV2.OfferV2(int offerThroughput, boolean offerEnableRUPerMinuteThroughput)"
name: "OfferV2(int offerThroughput, boolean offerEnableRUPerMinuteThroughput)"
nameWithType: "OfferV2.OfferV2(int offerThroughput, boolean offerEnableRUPerMinuteThroughput)"
summary: "Initialize an new instance of the OfferV2 object."
parameters:
- description: "the throughput value for this offer."
name: "offerThroughput"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- description: "if RU Per Minute throughput is enabled"
name: "offerEnableRUPerMinuteThroughput"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public OfferV2(int offerThroughput, boolean offerEnableRUPerMinuteThroughput)"
desc: "Initialize an new instance of the OfferV2 object."
methods:
- uid: "com.microsoft.azure.documentdb.OfferV2.getOfferEnableRUPerMinuteThroughput()"
fullName: "com.microsoft.azure.documentdb.OfferV2.getOfferEnableRUPerMinuteThroughput()"
name: "getOfferEnableRUPerMinuteThroughput()"
nameWithType: "OfferV2.getOfferEnableRUPerMinuteThroughput()"
summary: "Gets Request Units(RU)/Minute throughput is enabled/disabled for collection in the Azure Cosmos DB database service."
syntax: "public boolean getOfferEnableRUPerMinuteThroughput()"
desc: "Gets Request Units(RU)/Minute throughput is enabled/disabled for collection in the Azure Cosmos DB database service."
returns:
description: "true if RUPerMin is enabled; otherwise false."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.OfferV2.getOfferThroughput()"
fullName: "com.microsoft.azure.documentdb.OfferV2.getOfferThroughput()"
name: "getOfferThroughput()"
nameWithType: "OfferV2.getOfferThroughput()"
summary: "Gets the offer throughput for this offer."
syntax: "public int getOfferThroughput()"
desc: "Gets the offer throughput for this offer."
returns:
description: "the offer throughput."
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.OfferV2.setOfferEnableRUPerMinuteThroughput(boolean)"
fullName: "com.microsoft.azure.documentdb.OfferV2.setOfferEnableRUPerMinuteThroughput(boolean offerEnableRUPerMinuteThroughput)"
name: "setOfferEnableRUPerMinuteThroughput(boolean offerEnableRUPerMinuteThroughput)"
nameWithType: "OfferV2.setOfferEnableRUPerMinuteThroughput(boolean offerEnableRUPerMinuteThroughput)"
summary: "Sets Request Units(RU)/Minute throughput enabled/disabled for collection in the Azure Cosmos DB database service."
parameters:
- description: "used for enabling or disabling option."
name: "offerEnableRUPerMinuteThroughput"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setOfferEnableRUPerMinuteThroughput(boolean offerEnableRUPerMinuteThroughput)"
desc: "Sets Request Units(RU)/Minute throughput enabled/disabled for collection in the Azure Cosmos DB database service."
- uid: "com.microsoft.azure.documentdb.OfferV2.setOfferThroughput(int)"
fullName: "com.microsoft.azure.documentdb.OfferV2.setOfferThroughput(int throughput)"
name: "setOfferThroughput(int throughput)"
nameWithType: "OfferV2.setOfferThroughput(int throughput)"
summary: "Sets the offer throughput for this offer."
parameters:
- description: "the throughput of this offer."
name: "throughput"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setOfferThroughput(int throughput)"
desc: "Sets the offer throughput for this offer."
type: "class"
desc: "Represents an offer version 2 in the Azure Cosmos DB database service."
metadata: {}
package: "com.microsoft.azure.documentdb"
artifact: com.microsoft.azure:azure-documentdb:2.4.7