Package com.azure.resourcemanager.cosmos.models

Class MongoDBCollectionGetPropertiesResource

java.lang.Object

com.azure.resourcemanager.cosmos.models.MongoDBCollectionResource

com.azure.resourcemanager.cosmos.models.MongoDBCollectionGetPropertiesResource

All Implemented Interfaces:

com.azure.json.JsonSerializable<MongoDBCollectionResource>

public final class MongoDBCollectionGetPropertiesResource
extends MongoDBCollectionResource

The MongoDBCollectionGetPropertiesResource model.

Constructor Summary

Constructors

Constructor	Description
MongoDBCollectionGetPropertiesResource()	Creates an instance of MongoDBCollectionGetPropertiesResource class.

Method Summary

Modifier and Type	Method	Description
String	etag()	Get the etag property: A system generated property representing the resource etag required for optimistic concurrency control.
static MongoDBCollectionGetPropertiesResource	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of MongoDBCollectionGetPropertiesResource from the JsonReader.
String	rid()	Get the rid property: A system generated property.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)
Float	ts()	Get the ts property: A system generated property that denotes the last updated timestamp of the resource.
void	validate()	Validates the instance.
MongoDBCollectionGetPropertiesResource	withAnalyticalStorageTtl(Integer analyticalStorageTtl)	Set the analyticalStorageTtl property: Analytical TTL.
MongoDBCollectionGetPropertiesResource	withCreateMode(CreateMode createMode)	Set the createMode property: Enum to indicate the mode of resource creation.
MongoDBCollectionGetPropertiesResource	withId(String id)	Set the id property: Name of the Cosmos DB MongoDB collection.
MongoDBCollectionGetPropertiesResource	withIndexes(List<MongoIndex> indexes)	Set the indexes property: List of index keys.
MongoDBCollectionGetPropertiesResource	withRestoreParameters(ResourceRestoreParameters restoreParameters)	Set the restoreParameters property: Parameters to indicate the information about the restore.
MongoDBCollectionGetPropertiesResource	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 com.azure.resourcemanager.cosmos.models.MongoDBCollectionResource

analyticalStorageTtl, createMode, id, indexes, restoreParameters, shardKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

MongoDBCollectionGetPropertiesResource

public MongoDBCollectionGetPropertiesResource()

Creates an instance of MongoDBCollectionGetPropertiesResource class.

Method Details

rid

public String rid()

Get the rid property: A system generated property. A unique identifier.

Returns:

the rid value.

ts

public Float ts()

Get the ts property: A system generated property that denotes the last updated timestamp of the resource.

Returns:

the ts value.

etag

public String etag()

Get the etag property: A system generated property representing the resource etag required for optimistic concurrency control.

Returns:

the etag value.

withId

public MongoDBCollectionGetPropertiesResource withId(String id)

Set the id property: Name of the Cosmos DB MongoDB collection.

Overrides:

withId in class MongoDBCollectionResource

Parameters:

id - the id value to set.

Returns:

the MongoDBCollectionResource object itself.

withShardKey

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

Set the shardKey property: A key-value pair of shard keys to be applied for the request.

Overrides:

withShardKey in class MongoDBCollectionResource

Parameters:

shardKey - the shardKey value to set.

Returns:

the MongoDBCollectionResource object itself.

withIndexes

public MongoDBCollectionGetPropertiesResource withIndexes(List<MongoIndex> indexes)

Set the indexes property: List of index keys.

Overrides:

withIndexes in class MongoDBCollectionResource

Parameters:

indexes - the indexes value to set.

Returns:

the MongoDBCollectionResource object itself.

withAnalyticalStorageTtl

public MongoDBCollectionGetPropertiesResource withAnalyticalStorageTtl(Integer analyticalStorageTtl)

Set the analyticalStorageTtl property: Analytical TTL.

Overrides:

withAnalyticalStorageTtl in class MongoDBCollectionResource

Parameters:

analyticalStorageTtl - the analyticalStorageTtl value to set.

Returns:

the MongoDBCollectionResource object itself.

withRestoreParameters

public MongoDBCollectionGetPropertiesResource withRestoreParameters(ResourceRestoreParameters restoreParameters)

Set the restoreParameters property: Parameters to indicate the information about the restore.

Overrides:

withRestoreParameters in class MongoDBCollectionResource

Parameters:

restoreParameters - the restoreParameters value to set.

Returns:

the MongoDBCollectionResource object itself.

withCreateMode

public MongoDBCollectionGetPropertiesResource withCreateMode(CreateMode createMode)

Set the createMode property: Enum to indicate the mode of resource creation.

Overrides:

withCreateMode in class MongoDBCollectionResource

Parameters:

createMode - the createMode value to set.

Returns:

the MongoDBCollectionResource object itself.

validate

public void validate()

Validates the instance.

Overrides:

validate in class MongoDBCollectionResource

Throws:

IllegalArgumentException - thrown if the instance is not valid.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<MongoDBCollectionResource>

Overrides:

toJson in class MongoDBCollectionResource

Throws:

IOException

fromJson

public static MongoDBCollectionGetPropertiesResource fromJson(com.azure.json.JsonReader jsonReader)
                                                       throws IOException

Reads an instance of MongoDBCollectionGetPropertiesResource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of MongoDBCollectionGetPropertiesResource if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IllegalStateException - If the deserialized JSON object was missing any required properties.

IOException - If an error occurs while reading the MongoDBCollectionGetPropertiesResource.