108 строки
8.1 KiB
YAML
108 строки
8.1 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource"
|
|
name: "MongoDBCollectionResource"
|
|
nameWithType: "MongoDBCollectionResource"
|
|
summary: "Cosmos DB MongoDB collection resource object."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- 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.toString()?alt=java.lang.Object.toString&text=toString\" 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 **MongoDBCollectionResource**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource.MongoDBCollectionResource()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource.MongoDBCollectionResource()"
|
|
name: "MongoDBCollectionResource()"
|
|
nameWithType: "MongoDBCollectionResource.MongoDBCollectionResource()"
|
|
syntax: "public MongoDBCollectionResource()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource.id()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource.id()"
|
|
name: "id()"
|
|
nameWithType: "MongoDBCollectionResource.id()"
|
|
summary: "Get name of the Cosmos DB MongoDB collection."
|
|
syntax: "public String id()"
|
|
desc: "Get name of the Cosmos DB MongoDB collection."
|
|
returns:
|
|
description: "the id value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource.indexes()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource.indexes()"
|
|
name: "indexes()"
|
|
nameWithType: "MongoDBCollectionResource.indexes()"
|
|
summary: "Get list of index keys."
|
|
syntax: "public List<MongoIndex> indexes()"
|
|
desc: "Get list of index keys."
|
|
returns:
|
|
description: "the indexes value"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.MongoIndex?alt=com.microsoft.azure.management.cosmosdb.MongoIndex&text=MongoIndex\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource.shardKey()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource.shardKey()"
|
|
name: "shardKey()"
|
|
nameWithType: "MongoDBCollectionResource.shardKey()"
|
|
summary: "Get a key-value pair of shard keys to be applied for the request."
|
|
syntax: "public Map<String,String> shardKey()"
|
|
desc: "Get a key-value pair of shard keys to be applied for the request."
|
|
returns:
|
|
description: "the shardKey value"
|
|
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource.withId(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource.withId(String id)"
|
|
name: "withId(String id)"
|
|
nameWithType: "MongoDBCollectionResource.withId(String id)"
|
|
summary: "Set name of the Cosmos DB MongoDB collection."
|
|
parameters:
|
|
- description: "the id value to set"
|
|
name: "id"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MongoDBCollectionResource withId(String id)"
|
|
desc: "Set name of the Cosmos DB MongoDB collection."
|
|
returns:
|
|
description: "the MongoDBCollectionResource object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource?alt=com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource&text=MongoDBCollectionResource\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource.withIndexes(java.util.List<com.microsoft.azure.management.cosmosdb.MongoIndex>)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource.withIndexes(List<MongoIndex> indexes)"
|
|
name: "withIndexes(List<MongoIndex> indexes)"
|
|
nameWithType: "MongoDBCollectionResource.withIndexes(List<MongoIndex> indexes)"
|
|
summary: "Set list of index keys."
|
|
parameters:
|
|
- description: "the indexes value to set"
|
|
name: "indexes"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.MongoIndex?alt=com.microsoft.azure.management.cosmosdb.MongoIndex&text=MongoIndex\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public MongoDBCollectionResource withIndexes(List<MongoIndex> indexes)"
|
|
desc: "Set list of index keys."
|
|
returns:
|
|
description: "the MongoDBCollectionResource object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource?alt=com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource&text=MongoDBCollectionResource\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource.withShardKey(java.util.Map<java.lang.String,java.lang.String>)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource.withShardKey(Map<String,String> shardKey)"
|
|
name: "withShardKey(Map<String,String> shardKey)"
|
|
nameWithType: "MongoDBCollectionResource.withShardKey(Map<String,String> shardKey)"
|
|
summary: "Set a key-value pair of shard keys to be applied for the request."
|
|
parameters:
|
|
- description: "the shardKey value to set"
|
|
name: "shardKey"
|
|
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public MongoDBCollectionResource withShardKey(Map<String,String> shardKey)"
|
|
desc: "Set a key-value pair of shard keys to be applied for the request."
|
|
returns:
|
|
description: "the MongoDBCollectionResource object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource?alt=com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource&text=MongoDBCollectionResource\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Cosmos DB MongoDB collection resource object."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.management.cosmosdb"
|
|
artifact: com.microsoft.azure:azure-mgmt-cosmosdb:1.41.4
|