275 строки
25 KiB
YAML
275 строки
25 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.documentdb.DocumentCollection"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection"
|
|
name: "DocumentCollection"
|
|
nameWithType: "DocumentCollection"
|
|
summary: "Represents a document collection 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 final class **DocumentCollection**</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.DocumentCollection.DocumentCollection()"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.DocumentCollection()"
|
|
name: "DocumentCollection()"
|
|
nameWithType: "DocumentCollection.DocumentCollection()"
|
|
summary: "Initialize a document collection object."
|
|
syntax: "public DocumentCollection()"
|
|
desc: "Initialize a document collection object."
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.DocumentCollection(java.lang.String)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.DocumentCollection(String jsonString)"
|
|
name: "DocumentCollection(String jsonString)"
|
|
nameWithType: "DocumentCollection.DocumentCollection(String jsonString)"
|
|
summary: "Initialize a document collection object from json string."
|
|
parameters:
|
|
- description: "the json string that represents the document collection."
|
|
name: "jsonString"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DocumentCollection(String jsonString)"
|
|
desc: "Initialize a document collection object from json string."
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.DocumentCollection(org.json.JSONObject)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.DocumentCollection(JSONObject jsonObject)"
|
|
name: "DocumentCollection(JSONObject jsonObject)"
|
|
nameWithType: "DocumentCollection.DocumentCollection(JSONObject jsonObject)"
|
|
summary: "Initialize a document collection object from json object."
|
|
parameters:
|
|
- description: "the json object that represents the document collection."
|
|
name: "jsonObject"
|
|
type: "<xref href=\"org.json.JSONObject?alt=org.json.JSONObject&text=JSONObject\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DocumentCollection(JSONObject jsonObject)"
|
|
desc: "Initialize a document collection object from json object."
|
|
methods:
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.equals(java.lang.Object)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.equals(Object obj)"
|
|
name: "equals(Object obj)"
|
|
nameWithType: "DocumentCollection.equals(Object obj)"
|
|
overridden: "java.lang.Object.equals(java.lang.Object)"
|
|
parameters:
|
|
- name: "obj"
|
|
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public boolean equals(Object obj)"
|
|
returns:
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.getCollectionPartitionStatistics()"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.getCollectionPartitionStatistics()"
|
|
name: "getCollectionPartitionStatistics()"
|
|
nameWithType: "DocumentCollection.getCollectionPartitionStatistics()"
|
|
summary: "Gets the collection's partition key statistics for each physical partition in the collection."
|
|
syntax: "public Collection<PartitionKeyRangeStatistics> getCollectionPartitionStatistics()"
|
|
desc: "Gets the collection's partition key statistics for each physical partition in the collection."
|
|
returns:
|
|
description: "the partition key statistics for each physical partition in the collection."
|
|
type: "<xref href=\"java.util.Collection?alt=java.util.Collection&text=Collection\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.documentdb.PartitionKeyRangeStatistics?alt=com.microsoft.azure.documentdb.PartitionKeyRangeStatistics&text=PartitionKeyRangeStatistics\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.getConflictResolutionPolicy()"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.getConflictResolutionPolicy()"
|
|
name: "getConflictResolutionPolicy()"
|
|
nameWithType: "DocumentCollection.getConflictResolutionPolicy()"
|
|
summary: "Gets the conflict<wbr>Resolution<wbr>Policy that is used for resolving conflicting writes on documents in different regions, in a collection in the Azure Cosmos DB service."
|
|
syntax: "public ConflictResolutionPolicy getConflictResolutionPolicy()"
|
|
desc: "Gets the conflictResolutionPolicy that is used for resolving conflicting writes on documents in different regions, in a collection in the Azure Cosmos DB service."
|
|
returns:
|
|
description: "ConflictResolutionPolicy"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.ConflictResolutionPolicy?alt=com.microsoft.azure.documentdb.ConflictResolutionPolicy&text=ConflictResolutionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.getConflictsLink()"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.getConflictsLink()"
|
|
name: "getConflictsLink()"
|
|
nameWithType: "DocumentCollection.getConflictsLink()"
|
|
summary: "Gets the self-link for conflicts in a collection."
|
|
syntax: "public String getConflictsLink()"
|
|
desc: "Gets the self-link for conflicts in a collection."
|
|
returns:
|
|
description: "the conflicts link."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.getDefaultTimeToLive()"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.getDefaultTimeToLive()"
|
|
name: "getDefaultTimeToLive()"
|
|
nameWithType: "DocumentCollection.getDefaultTimeToLive()"
|
|
summary: "Gets the collection's default time-to-live value."
|
|
syntax: "public Integer getDefaultTimeToLive()"
|
|
desc: "Gets the collection's default time-to-live value."
|
|
returns:
|
|
description: "the the default time-to-live value in seconds."
|
|
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.getDocumentsLink()"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.getDocumentsLink()"
|
|
name: "getDocumentsLink()"
|
|
nameWithType: "DocumentCollection.getDocumentsLink()"
|
|
summary: "Gets the self-link for documents in a collection."
|
|
syntax: "public String getDocumentsLink()"
|
|
desc: "Gets the self-link for documents in a collection."
|
|
returns:
|
|
description: "the document link."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.getIndexingPolicy()"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.getIndexingPolicy()"
|
|
name: "getIndexingPolicy()"
|
|
nameWithType: "DocumentCollection.getIndexingPolicy()"
|
|
summary: "Gets the indexing policy."
|
|
syntax: "public IndexingPolicy getIndexingPolicy()"
|
|
desc: "Gets the indexing policy."
|
|
returns:
|
|
description: "the indexing policy."
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.IndexingPolicy?alt=com.microsoft.azure.documentdb.IndexingPolicy&text=IndexingPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.getPartitionKey()"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.getPartitionKey()"
|
|
name: "getPartitionKey()"
|
|
nameWithType: "DocumentCollection.getPartitionKey()"
|
|
summary: "Gets the collection's partition key definition."
|
|
syntax: "public PartitionKeyDefinition getPartitionKey()"
|
|
desc: "Gets the collection's partition key definition."
|
|
returns:
|
|
description: "the partition key definition."
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.PartitionKeyDefinition?alt=com.microsoft.azure.documentdb.PartitionKeyDefinition&text=PartitionKeyDefinition\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.getStoredProceduresLink()"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.getStoredProceduresLink()"
|
|
name: "getStoredProceduresLink()"
|
|
nameWithType: "DocumentCollection.getStoredProceduresLink()"
|
|
summary: "Gets the self-link for stored procedures in a collection."
|
|
syntax: "public String getStoredProceduresLink()"
|
|
desc: "Gets the self-link for stored procedures in a collection."
|
|
returns:
|
|
description: "the stored procedures link."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.getTriggersLink()"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.getTriggersLink()"
|
|
name: "getTriggersLink()"
|
|
nameWithType: "DocumentCollection.getTriggersLink()"
|
|
summary: "Gets the self-link for triggers in a collection."
|
|
syntax: "public String getTriggersLink()"
|
|
desc: "Gets the self-link for triggers in a collection."
|
|
returns:
|
|
description: "the trigger link."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.getUniqueKeyPolicy()"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.getUniqueKeyPolicy()"
|
|
name: "getUniqueKeyPolicy()"
|
|
nameWithType: "DocumentCollection.getUniqueKeyPolicy()"
|
|
summary: "Sets the Uni that guarantees uniqueness of documents in collection in the Azure Cosmos DB service."
|
|
syntax: "public UniqueKeyPolicy getUniqueKeyPolicy()"
|
|
desc: "Sets the Uni that guarantees uniqueness of documents in collection in the Azure Cosmos DB service."
|
|
returns:
|
|
description: "UniqueKeyPolicy"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.UniqueKeyPolicy?alt=com.microsoft.azure.documentdb.UniqueKeyPolicy&text=UniqueKeyPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.getUserDefinedFunctionsLink()"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.getUserDefinedFunctionsLink()"
|
|
name: "getUserDefinedFunctionsLink()"
|
|
nameWithType: "DocumentCollection.getUserDefinedFunctionsLink()"
|
|
summary: "Gets the self-link for user defined functions in a collection."
|
|
syntax: "public String getUserDefinedFunctionsLink()"
|
|
desc: "Gets the self-link for user defined functions in a collection."
|
|
returns:
|
|
description: "the user defined functions link."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.hashCode()"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.hashCode()"
|
|
name: "hashCode()"
|
|
nameWithType: "DocumentCollection.hashCode()"
|
|
overridden: "java.lang.Object.hashCode()"
|
|
syntax: "public int hashCode()"
|
|
returns:
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.setConflictResolutionPolicy(com.microsoft.azure.documentdb.ConflictResolutionPolicy)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.setConflictResolutionPolicy(ConflictResolutionPolicy value)"
|
|
name: "setConflictResolutionPolicy(ConflictResolutionPolicy value)"
|
|
nameWithType: "DocumentCollection.setConflictResolutionPolicy(ConflictResolutionPolicy value)"
|
|
summary: "Sets the conflict<wbr>Resolution<wbr>Policy that is used for resolving conflicting writes on documents in different regions, in a collection in the Azure Cosmos DB service."
|
|
parameters:
|
|
- description: "ConflictResolutionPolicy to be used."
|
|
name: "value"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.ConflictResolutionPolicy?alt=com.microsoft.azure.documentdb.ConflictResolutionPolicy&text=ConflictResolutionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setConflictResolutionPolicy(ConflictResolutionPolicy value)"
|
|
desc: "Sets the conflictResolutionPolicy that is used for resolving conflicting writes on documents in different regions, in a collection in the Azure Cosmos DB service."
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.setDefaultTimeToLive(java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.setDefaultTimeToLive(Integer timeToLive)"
|
|
name: "setDefaultTimeToLive(Integer timeToLive)"
|
|
nameWithType: "DocumentCollection.setDefaultTimeToLive(Integer timeToLive)"
|
|
summary: "Sets the collection's default time-to-live value."
|
|
parameters:
|
|
- description: "the default time-to-live value in seconds."
|
|
name: "timeToLive"
|
|
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setDefaultTimeToLive(Integer timeToLive)"
|
|
desc: "Sets the collection's default time-to-live value.\n\nThe default time-to-live value on a collection is an optional property. If set, the documents within the collection expires after the specified number of seconds since their last write time. The value of this property should be one of the following:\n\nnull - indicates evaluation of time-to-live is disabled and documents within the collection will never expire, regardless whether individual documents have their time-to-live set.\n\nnonzero positive integer - indicates the default time-to-live value for all documents within the collection. This value can be overridden by individual documents' time-to-live value.\n\n\\-1 - indicates by default all documents within the collection never expire. This value can be overridden by individual documents' time-to-live value."
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.setIndexingPolicy(com.microsoft.azure.documentdb.IndexingPolicy)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.setIndexingPolicy(IndexingPolicy indexingPolicy)"
|
|
name: "setIndexingPolicy(IndexingPolicy indexingPolicy)"
|
|
nameWithType: "DocumentCollection.setIndexingPolicy(IndexingPolicy indexingPolicy)"
|
|
summary: "Sets the indexing policy."
|
|
parameters:
|
|
- description: "the indexing policy."
|
|
name: "indexingPolicy"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.IndexingPolicy?alt=com.microsoft.azure.documentdb.IndexingPolicy&text=IndexingPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setIndexingPolicy(IndexingPolicy indexingPolicy)"
|
|
desc: "Sets the indexing policy."
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.setPartitionKey(com.microsoft.azure.documentdb.PartitionKeyDefinition)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.setPartitionKey(PartitionKeyDefinition partitionKey)"
|
|
name: "setPartitionKey(PartitionKeyDefinition partitionKey)"
|
|
nameWithType: "DocumentCollection.setPartitionKey(PartitionKeyDefinition partitionKey)"
|
|
summary: "Sets the collection's partition key definition."
|
|
parameters:
|
|
- description: "the partition key definition."
|
|
name: "partitionKey"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.PartitionKeyDefinition?alt=com.microsoft.azure.documentdb.PartitionKeyDefinition&text=PartitionKeyDefinition\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setPartitionKey(PartitionKeyDefinition partitionKey)"
|
|
desc: "Sets the collection's partition key definition."
|
|
- uid: "com.microsoft.azure.documentdb.DocumentCollection.setUniqueKeyPolicy(com.microsoft.azure.documentdb.UniqueKeyPolicy)"
|
|
fullName: "com.microsoft.azure.documentdb.DocumentCollection.setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)"
|
|
name: "setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)"
|
|
nameWithType: "DocumentCollection.setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)"
|
|
parameters:
|
|
- name: "uniqueKeyPolicy"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.UniqueKeyPolicy?alt=com.microsoft.azure.documentdb.UniqueKeyPolicy&text=UniqueKeyPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)"
|
|
type: "class"
|
|
desc: "Represents a document collection in the Azure Cosmos DB database service. A collection is a named logical container for documents.\n\nA database may contain zero or more named collections and each collection consists of zero or more JSON documents. Being schema-free, the documents in a collection do not need to share the same structure or fields. Since collections are application resources, they can be authorized using either the master key or resource keys."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.documentdb"
|
|
artifact: com.microsoft.azure:azure-documentdb:2.4.7
|