188 строки
15 KiB
YAML
188 строки
15 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.documentdb.Offer"
|
|
fullName: "com.microsoft.azure.documentdb.Offer"
|
|
name: "Offer"
|
|
nameWithType: "Offer"
|
|
summary: "Represents the offer for a resource 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\" />"
|
|
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.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 **Offer**</br> extends <xref href=\"com.microsoft.azure.documentdb.Resource?alt=com.microsoft.azure.documentdb.Resource&text=Resource\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.documentdb.Offer.Offer()"
|
|
fullName: "com.microsoft.azure.documentdb.Offer.Offer()"
|
|
name: "Offer()"
|
|
nameWithType: "Offer.Offer()"
|
|
summary: "Initialize an offer object."
|
|
syntax: "public Offer()"
|
|
desc: "Initialize an offer object."
|
|
- uid: "com.microsoft.azure.documentdb.Offer.Offer(com.microsoft.azure.documentdb.Offer)"
|
|
fullName: "com.microsoft.azure.documentdb.Offer.Offer(Offer otherOffer)"
|
|
name: "Offer(Offer otherOffer)"
|
|
nameWithType: "Offer.Offer(Offer otherOffer)"
|
|
summary: "Initialize an offer object and copy all properties from the other offer."
|
|
parameters:
|
|
- description: "the Offer object whose properties to copy over."
|
|
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 Offer(Offer otherOffer)"
|
|
desc: "Initialize an offer object and copy all properties from the other offer."
|
|
- uid: "com.microsoft.azure.documentdb.Offer.Offer(java.lang.String)"
|
|
fullName: "com.microsoft.azure.documentdb.Offer.Offer(String jsonString)"
|
|
name: "Offer(String jsonString)"
|
|
nameWithType: "Offer.Offer(String jsonString)"
|
|
summary: "Initialize an offer object from json string."
|
|
parameters:
|
|
- description: "the json string that represents the offer."
|
|
name: "jsonString"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Offer(String jsonString)"
|
|
desc: "Initialize an offer object from json string."
|
|
- uid: "com.microsoft.azure.documentdb.Offer.Offer(org.json.JSONObject)"
|
|
fullName: "com.microsoft.azure.documentdb.Offer.Offer(JSONObject jsonObject)"
|
|
name: "Offer(JSONObject jsonObject)"
|
|
nameWithType: "Offer.Offer(JSONObject jsonObject)"
|
|
summary: "Initialize an offer object from json object."
|
|
parameters:
|
|
- description: "the json object that represents the offer."
|
|
name: "jsonObject"
|
|
type: "<xref href=\"org.json.JSONObject?alt=org.json.JSONObject&text=JSONObject\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Offer(JSONObject jsonObject)"
|
|
desc: "Initialize an offer object from json object."
|
|
methods:
|
|
- uid: "com.microsoft.azure.documentdb.Offer.getContent()"
|
|
fullName: "com.microsoft.azure.documentdb.Offer.getContent()"
|
|
name: "getContent()"
|
|
nameWithType: "Offer.getContent()"
|
|
summary: "Gets the content object that contains the details of the offer."
|
|
syntax: "public JSONObject getContent()"
|
|
desc: "Gets the content object that contains the details of the offer."
|
|
returns:
|
|
description: "the offer content."
|
|
type: "<xref href=\"org.json.JSONObject?alt=org.json.JSONObject&text=JSONObject\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.Offer.getOfferResourceId()"
|
|
fullName: "com.microsoft.azure.documentdb.Offer.getOfferResourceId()"
|
|
name: "getOfferResourceId()"
|
|
nameWithType: "Offer.getOfferResourceId()"
|
|
summary: "Sets the target resource id of a resource to which this offer applies."
|
|
syntax: "public String getOfferResourceId()"
|
|
desc: "Sets the target resource id of a resource to which this offer applies."
|
|
returns:
|
|
description: "the resource id."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.Offer.getOfferType()"
|
|
fullName: "com.microsoft.azure.documentdb.Offer.getOfferType()"
|
|
name: "getOfferType()"
|
|
nameWithType: "Offer.getOfferType()"
|
|
summary: "Gets the Offer<wbr>Type for the resource offer."
|
|
syntax: "public String getOfferType()"
|
|
desc: "Gets the OfferType for the resource offer."
|
|
returns:
|
|
description: "the offer type."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.Offer.getOfferVersion()"
|
|
fullName: "com.microsoft.azure.documentdb.Offer.getOfferVersion()"
|
|
name: "getOfferVersion()"
|
|
nameWithType: "Offer.getOfferVersion()"
|
|
summary: "Gets the version of the current offer."
|
|
syntax: "public String getOfferVersion()"
|
|
desc: "Gets the version of the current offer."
|
|
returns:
|
|
description: "the offer version."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.Offer.getResourceLink()"
|
|
fullName: "com.microsoft.azure.documentdb.Offer.getResourceLink()"
|
|
name: "getResourceLink()"
|
|
nameWithType: "Offer.getResourceLink()"
|
|
summary: "Gets the self-link of a resource to which the resource offer applies."
|
|
syntax: "public String getResourceLink()"
|
|
desc: "Gets the self-link of a resource to which the resource offer applies."
|
|
returns:
|
|
description: "the resource link."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.Offer.setContent(org.json.JSONObject)"
|
|
fullName: "com.microsoft.azure.documentdb.Offer.setContent(JSONObject offerContent)"
|
|
name: "setContent(JSONObject offerContent)"
|
|
nameWithType: "Offer.setContent(JSONObject offerContent)"
|
|
summary: "Sets the offer content that contains the details of the offer."
|
|
parameters:
|
|
- description: "the content object."
|
|
name: "offerContent"
|
|
type: "<xref href=\"org.json.JSONObject?alt=org.json.JSONObject&text=JSONObject\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setContent(JSONObject offerContent)"
|
|
desc: "Sets the offer content that contains the details of the offer."
|
|
- uid: "com.microsoft.azure.documentdb.Offer.setOfferType(java.lang.String)"
|
|
fullName: "com.microsoft.azure.documentdb.Offer.setOfferType(String offerType)"
|
|
name: "setOfferType(String offerType)"
|
|
nameWithType: "Offer.setOfferType(String offerType)"
|
|
summary: "Sets the Offer<wbr>Type for the resource offer."
|
|
parameters:
|
|
- description: "the offer type."
|
|
name: "offerType"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setOfferType(String offerType)"
|
|
desc: "Sets the OfferType for the resource offer."
|
|
- uid: "com.microsoft.azure.documentdb.Offer.setOfferVersion(java.lang.String)"
|
|
fullName: "com.microsoft.azure.documentdb.Offer.setOfferVersion(String offerVersion)"
|
|
name: "setOfferVersion(String offerVersion)"
|
|
nameWithType: "Offer.setOfferVersion(String offerVersion)"
|
|
summary: "Sets the offer version."
|
|
parameters:
|
|
- description: "the version of the offer."
|
|
name: "offerVersion"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setOfferVersion(String offerVersion)"
|
|
desc: "Sets the offer version."
|
|
type: "class"
|
|
desc: "Represents the offer for a resource in the Azure Cosmos DB database service."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.documentdb"
|
|
artifact: com.microsoft.azure:azure-documentdb:2.4.7
|