MongoDBCollectionGetPropertiesResource Class

Package:

com.azure.resourcemanager.cosmos.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cosmos:2.46.0

• java.lang.Object
• • com.azure.resourcemanager.cosmos.models.MongoDBCollectionResource
  • • com.azure.resourcemanager.cosmos.models.MongoDBCollectionGetPropertiesResource

public final class MongoDBCollectionGetPropertiesResource
extends MongoDBCollectionResource

The MongoDBCollectionGetPropertiesResource model.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
String	etag() Get the etag property: A system generated property representing the resource etag required for optimistic concurrency control.
static MongoDBCollectionGetPropertiesResource	fromJson(JsonReader jsonReader) Reads an instance of MongoDBCollectionGetPropertiesResource from the JsonReader.
String	rid() Get the rid property: A system generated property.
JsonWriter	toJson(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 MongoDBCollectionResource

analyticalStorageTtl createMode fromJson id indexes restoreParameters shardKey toJson validate withAnalyticalStorageTtl withCreateMode withId withIndexes withRestoreParameters withShardKey

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

MongoDBCollectionGetPropertiesResource

public MongoDBCollectionGetPropertiesResource()

Creates an instance of MongoDBCollectionGetPropertiesResource class.

Method Details

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.

fromJson

public static MongoDBCollectionGetPropertiesResource fromJson(JsonReader jsonReader)

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:

IOException

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

rid

public String rid()

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

Returns:

the rid value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

MongoDBCollectionGetPropertiesResource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

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.

validate

public void validate()

Validates the instance.

Overrides:

MongoDBCollectionGetPropertiesResource.validate()

withAnalyticalStorageTtl

public MongoDBCollectionGetPropertiesResource withAnalyticalStorageTtl(Integer analyticalStorageTtl)

Set the analyticalStorageTtl property: Analytical TTL.

Overrides:

MongoDBCollectionGetPropertiesResource.withAnalyticalStorageTtl(Integer analyticalStorageTtl)

Parameters:

analyticalStorageTtl

withCreateMode

public MongoDBCollectionGetPropertiesResource withCreateMode(CreateMode createMode)

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

Overrides:

MongoDBCollectionGetPropertiesResource.withCreateMode(CreateMode createMode)

Parameters:

createMode

withId

public MongoDBCollectionGetPropertiesResource withId(String id)

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

Overrides:

MongoDBCollectionGetPropertiesResource.withId(String id)

Parameters:

id

withIndexes

public MongoDBCollectionGetPropertiesResource withIndexes(List indexes)

Set the indexes property: List of index keys.

Overrides:

MongoDBCollectionGetPropertiesResource.withIndexes(List<MongoIndex> indexes)

Parameters:

indexes

withRestoreParameters

public MongoDBCollectionGetPropertiesResource withRestoreParameters(ResourceRestoreParameters restoreParameters)

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

Overrides:

MongoDBCollectionGetPropertiesResource.withRestoreParameters(ResourceRestoreParameters restoreParameters)

Parameters:

restoreParameters

withShardKey

public MongoDBCollectionGetPropertiesResource withShardKey(Map shardKey)

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

Overrides:

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

Parameters:

shardKey