com.azure.resourcemanager.cosmos.models

Class MongoDBCollectionResource

java.lang.Object

com.azure.resourcemanager.cosmos.models.MongoDBCollectionResource

Direct Known Subclasses:

MongoDBCollectionGetPropertiesResource

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 the id property: Name of the Cosmos DB MongoDB collection.
List<MongoIndex>	indexes() Get the indexes property: List of index keys.
Map<String,String>	shardKey() Get the shardKey property: A key-value pair of shard keys to be applied for the request.
void	validate() Validates the instance.
MongoDBCollectionResource	withId(String id) Set the id property: Name of the Cosmos DB MongoDB collection.
MongoDBCollectionResource	withIndexes(List<MongoIndex> indexes) Set the indexes property: List of index keys.
MongoDBCollectionResource	withShardKey(Map<String,String> shardKey) Set the shardKey property: 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 the id property: Name of the Cosmos DB MongoDB collection.

Returns:

the id value.

withId

public MongoDBCollectionResource withId(String id)

Set the id property: 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 the shardKey property: 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 the shardKey property: 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 the indexes property: List of index keys.

Returns:

the indexes value.

withIndexes

public MongoDBCollectionResource withIndexes(List<MongoIndex> indexes)

Set the indexes property: List of index keys.

Parameters:

indexes - the indexes value to set.

Returns:

the MongoDBCollectionResource object itself.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.