Package com.microsoft.azure.management.cosmosdb

Class MongoIndex

java.lang.Object

com.microsoft.azure.management.cosmosdb.MongoIndex

public class MongoIndex
extends Object

Cosmos DB MongoDB collection index key.

Constructor Summary

Constructors

Constructor	Description
MongoIndex()

Method Summary

Modifier and Type	Method	Description
MongoIndexKeys	key()	Get cosmos DB MongoDB collection index keys.
MongoIndexOptions	options()	Get cosmos DB MongoDB collection index key options.
MongoIndex	withKey(MongoIndexKeys key)	Set cosmos DB MongoDB collection index keys.
MongoIndex	withOptions(MongoIndexOptions options)	Set cosmos DB MongoDB collection index key options.

Methods inherited from class java.lang.Object

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

Constructor Details

MongoIndex

public MongoIndex()

Method Details

key

public MongoIndexKeys key()

Get cosmos DB MongoDB collection index keys.

Returns:

the key value

withKey

public MongoIndex withKey(MongoIndexKeys key)

Set cosmos DB MongoDB collection index keys.

Parameters:

key - the key value to set

Returns:

the MongoIndex object itself.

options

public MongoIndexOptions options()

Get cosmos DB MongoDB collection index key options.

Returns:

the options value

withOptions

public MongoIndex withOptions(MongoIndexOptions options)

Set cosmos DB MongoDB collection index key options.

Parameters:

options - the options value to set

Returns:

the MongoIndex object itself.