com.microsoft.azure.management.cosmosdb

Class MongoDBCollectionResource

java.lang.Object

com.microsoft.azure.management.cosmosdb.MongoDBCollectionResource

public class MongoDBCollectionResource
extends Object

Cosmos DB MongoDB collection resource object.

Constructor Summary

Constructors

Constructor and Description
MongoDBCollectionResource()

Method Summary

Modifier and Type	Method and Description
String	id() Get name of the Cosmos DB MongoDB collection.
List<MongoIndex>	indexes() Get list of index keys.
Map<String,String>	shardKey() Get a key-value pair of shard keys to be applied for the request.
MongoDBCollectionResource	withId(String id) Set name of the Cosmos DB MongoDB collection.
MongoDBCollectionResource	withIndexes(List<MongoIndex> indexes) Set list of index keys.
MongoDBCollectionResource	withShardKey(Map<String,String> shardKey) Set a key-value pair of shard keys to be applied for the request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MongoDBCollectionResource

public MongoDBCollectionResource()

Method Detail

id

public String id()

Get name of the Cosmos DB MongoDB collection.

Returns:

the id value

withId

public MongoDBCollectionResource withId(String id)

Set name of the Cosmos DB MongoDB collection.

Parameters:

id - the id value to set

Returns:

the MongoDBCollectionResource object itself.

shardKey

public Map<String,String> shardKey()

Get a key-value pair of shard keys to be applied for the request.

Returns:

the shardKey value

withShardKey

public MongoDBCollectionResource withShardKey(Map<String,String> shardKey)

Set a key-value pair of shard keys to be applied for the request.

Parameters:

shardKey - the shardKey value to set

Returns:

the MongoDBCollectionResource object itself.

indexes

public List<MongoIndex> indexes()

Get list of index keys.

Returns:

the indexes value

withIndexes

public MongoDBCollectionResource withIndexes(List<MongoIndex> indexes)

Set list of index keys.

Parameters:

indexes - the indexes value to set

Returns:

the MongoDBCollectionResource object itself.