Offer Class

Package:

com.microsoft.azure.documentdb

• java.lang.Object
• • Serializable
  • • JsonSerializable
    • • Resource
      • • com.microsoft.azure.documentdb.Offer

public class Offer extends Resource

Represents the offer for a resource in the Azure Cosmos DB database service.

Constructor Summary

Constructor	Description
Offer()	Initialize an offer object.
Offer(JSONObject jsonObject)	Initialize an offer object from json object.
Offer(Offer otherOffer)	Initialize an offer object and copy all properties from the other offer.
Offer(String jsonString)	Initialize an offer object from json string.

Method Summary

Modifier and Type	Method and Description
JSONObject	getContent() Gets the content object that contains the details of the offer.
String	getOfferResourceId() Sets the target resource id of a resource to which this offer applies.
String	getOfferType() Gets the OfferType for the resource offer.
String	getOfferVersion() Gets the version of the current offer.
String	getResourceLink() Gets the self-link of a resource to which the resource offer applies.
void	setContent(JSONObject offerContent) Sets the offer content that contains the details of the offer.
void	setOfferType(String offerType) Sets the OfferType for the resource offer.
void	setOfferVersion(String offerVersion) Sets the offer version.

Inherited Members

JsonSerializable.get(String propertyName) JsonSerializable.getBoolean(String propertyName) JsonSerializable.getCollection(String propertyName) JsonSerializable.getDouble(String propertyName) Resource.getETag() JsonSerializable.getHashMap() Resource.getId() JsonSerializable.getInt(String propertyName) JsonSerializable.getLogger() JsonSerializable.getLong(String propertyName) JsonSerializable.getMapper() JsonSerializable.getObject(String propertyName) JsonSerializable.getObjectByPath(Collection<String> propertyNames) Resource.getResourceId() Resource.getSelfLink() JsonSerializable.getString(String propertyName) Resource.getTimestamp() JsonSerializable.has(String propertyName) JsonSerializable.JsonSerializable() JsonSerializable.JsonSerializable(String jsonString, ObjectMapper objectMapper) JsonSerializable.JsonSerializable(String jsonString) JsonSerializable.JsonSerializable(JSONObject jsonObject) JsonSerializable.remove(String propertyName) Resource.Resource() Resource.Resource(String jsonString, ObjectMapper objectMapper) Resource.Resource(String jsonString) Resource.Resource(JSONObject jsonObject) Resource.setId(String id) Resource.setResourceId(String resourceId) JsonSerializable.toJson() JsonSerializable.toJson(SerializationFormattingPolicy formattingPolicy) JsonSerializable.toString() JsonSerializable.toString(int indentFactor)

Constructor Details

Offer

public Offer()

Initialize an offer object.

Offer

public Offer(JSONObject jsonObject)

Initialize an offer object from json object.

Parameters:

jsonObject - the json object that represents the offer.

Offer

public Offer(Offer otherOffer)

Initialize an offer object and copy all properties from the other offer.

Parameters:

otherOffer - the Offer object whose properties to copy over.

Offer

public Offer(String jsonString)

Initialize an offer object from json string.

Parameters:

jsonString - the json string that represents the offer.

Method Details

getContent

public JSONObject getContent()

Gets the content object that contains the details of the offer.

Returns:

the offer content.

getOfferResourceId

public String getOfferResourceId()

Sets the target resource id of a resource to which this offer applies.

Returns:

the resource id.

getOfferType

public String getOfferType()

Gets the OfferType for the resource offer.

Returns:

the offer type.

getOfferVersion

public String getOfferVersion()

Gets the version of the current offer.

Returns:

the offer version.

getResourceLink

public String getResourceLink()

Gets the self-link of a resource to which the resource offer applies.

Returns:

the resource link.

setContent

public void setContent(JSONObject offerContent)

Sets the offer content that contains the details of the offer.

Parameters:

offerContent - the content object.

setOfferType

public void setOfferType(String offerType)

Sets the OfferType for the resource offer.

Parameters:

offerType - the offer type.

setOfferVersion

public void setOfferVersion(String offerVersion)

Sets the offer version.

Parameters:

offerVersion - the version of the offer.