Package com.azure.resourcemanager.cosmos.models

Class SqlContainerGetPropertiesResource

java.lang.Object

com.azure.resourcemanager.cosmos.models.SqlContainerResource

com.azure.resourcemanager.cosmos.models.SqlContainerGetPropertiesResource

All Implemented Interfaces:

com.azure.json.JsonSerializable<SqlContainerResource>

public final class SqlContainerGetPropertiesResource
extends SqlContainerResource

The SqlContainerGetPropertiesResource model.

Constructor Summary

Constructors

Constructor	Description
SqlContainerGetPropertiesResource()	Creates an instance of SqlContainerGetPropertiesResource 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 SqlContainerGetPropertiesResource	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of SqlContainerGetPropertiesResource 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.
SqlContainerGetPropertiesResource	withAnalyticalStorageTtl(Long analyticalStorageTtl)	Set the analyticalStorageTtl property: Analytical TTL.
SqlContainerGetPropertiesResource	withClientEncryptionPolicy(ClientEncryptionPolicy clientEncryptionPolicy)	Set the clientEncryptionPolicy property: The client encryption policy for the container.
SqlContainerGetPropertiesResource	withComputedProperties(List<ComputedProperty> computedProperties)	Set the computedProperties property: List of computed properties.
SqlContainerGetPropertiesResource	withConflictResolutionPolicy(ConflictResolutionPolicy conflictResolutionPolicy)	Set the conflictResolutionPolicy property: The conflict resolution policy for the container.
SqlContainerGetPropertiesResource	withCreateMode(CreateMode createMode)	Set the createMode property: Enum to indicate the mode of resource creation.
SqlContainerGetPropertiesResource	withDefaultTtl(Integer defaultTtl)	Set the defaultTtl property: Default time to live.
SqlContainerGetPropertiesResource	withFullTextPolicy(FullTextPolicy fullTextPolicy)	Set the fullTextPolicy property: The FullText policy for the container.
SqlContainerGetPropertiesResource	withId(String id)	Set the id property: Name of the Cosmos DB SQL container.
SqlContainerGetPropertiesResource	withIndexingPolicy(IndexingPolicy indexingPolicy)	Set the indexingPolicy property: The configuration of the indexing policy.
SqlContainerGetPropertiesResource	withPartitionKey(ContainerPartitionKey partitionKey)	Set the partitionKey property: The configuration of the partition key to be used for partitioning data into multiple partitions.
SqlContainerGetPropertiesResource	withRestoreParameters(ResourceRestoreParameters restoreParameters)	Set the restoreParameters property: Parameters to indicate the information about the restore.
SqlContainerGetPropertiesResource	withUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)	Set the uniqueKeyPolicy property: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
SqlContainerGetPropertiesResource	withVectorEmbeddingPolicy(VectorEmbeddingPolicy vectorEmbeddingPolicy)	Set the vectorEmbeddingPolicy property: The vector embedding policy for the container.

Methods inherited from class com.azure.resourcemanager.cosmos.models.SqlContainerResource

analyticalStorageTtl, clientEncryptionPolicy, computedProperties, conflictResolutionPolicy, createMode, defaultTtl, fullTextPolicy, id, indexingPolicy, partitionKey, restoreParameters, uniqueKeyPolicy, vectorEmbeddingPolicy

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

SqlContainerGetPropertiesResource

public SqlContainerGetPropertiesResource()

Creates an instance of SqlContainerGetPropertiesResource 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 SqlContainerGetPropertiesResource withId(String id)

Set the id property: Name of the Cosmos DB SQL container.

Overrides:

withId in class SqlContainerResource

Parameters:

id - the id value to set.

Returns:

the SqlContainerResource object itself.

withIndexingPolicy

public SqlContainerGetPropertiesResource withIndexingPolicy(IndexingPolicy indexingPolicy)

Set the indexingPolicy property: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container.

Overrides:

withIndexingPolicy in class SqlContainerResource

Parameters:

indexingPolicy - the indexingPolicy value to set.

Returns:

the SqlContainerResource object itself.

withPartitionKey

public SqlContainerGetPropertiesResource withPartitionKey(ContainerPartitionKey partitionKey)

Set the partitionKey property: The configuration of the partition key to be used for partitioning data into multiple partitions.

Overrides:

withPartitionKey in class SqlContainerResource

Parameters:

partitionKey - the partitionKey value to set.

Returns:

the SqlContainerResource object itself.

withDefaultTtl

public SqlContainerGetPropertiesResource withDefaultTtl(Integer defaultTtl)

Set the defaultTtl property: Default time to live.

Overrides:

withDefaultTtl in class SqlContainerResource

Parameters:

defaultTtl - the defaultTtl value to set.

Returns:

the SqlContainerResource object itself.

withUniqueKeyPolicy

public SqlContainerGetPropertiesResource withUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

Set the uniqueKeyPolicy property: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

Overrides:

withUniqueKeyPolicy in class SqlContainerResource

Parameters:

uniqueKeyPolicy - the uniqueKeyPolicy value to set.

Returns:

the SqlContainerResource object itself.

withConflictResolutionPolicy

public SqlContainerGetPropertiesResource withConflictResolutionPolicy(ConflictResolutionPolicy conflictResolutionPolicy)

Set the conflictResolutionPolicy property: The conflict resolution policy for the container.

Overrides:

withConflictResolutionPolicy in class SqlContainerResource

Parameters:

conflictResolutionPolicy - the conflictResolutionPolicy value to set.

Returns:

the SqlContainerResource object itself.

withClientEncryptionPolicy

public SqlContainerGetPropertiesResource withClientEncryptionPolicy(ClientEncryptionPolicy clientEncryptionPolicy)

Set the clientEncryptionPolicy property: The client encryption policy for the container.

Overrides:

withClientEncryptionPolicy in class SqlContainerResource

Parameters:

clientEncryptionPolicy - the clientEncryptionPolicy value to set.

Returns:

the SqlContainerResource object itself.

withAnalyticalStorageTtl

public SqlContainerGetPropertiesResource withAnalyticalStorageTtl(Long analyticalStorageTtl)

Set the analyticalStorageTtl property: Analytical TTL.

Overrides:

withAnalyticalStorageTtl in class SqlContainerResource

Parameters:

analyticalStorageTtl - the analyticalStorageTtl value to set.

Returns:

the SqlContainerResource object itself.

withRestoreParameters

public SqlContainerGetPropertiesResource withRestoreParameters(ResourceRestoreParameters restoreParameters)

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

Overrides:

withRestoreParameters in class SqlContainerResource

Parameters:

restoreParameters - the restoreParameters value to set.

Returns:

the SqlContainerResource object itself.

withCreateMode

public SqlContainerGetPropertiesResource withCreateMode(CreateMode createMode)

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

Overrides:

withCreateMode in class SqlContainerResource

Parameters:

createMode - the createMode value to set.

Returns:

the SqlContainerResource object itself.

withComputedProperties

public SqlContainerGetPropertiesResource withComputedProperties(List<ComputedProperty> computedProperties)

Set the computedProperties property: List of computed properties.

Overrides:

withComputedProperties in class SqlContainerResource

Parameters:

computedProperties - the computedProperties value to set.

Returns:

the SqlContainerResource object itself.

withVectorEmbeddingPolicy

public SqlContainerGetPropertiesResource withVectorEmbeddingPolicy(VectorEmbeddingPolicy vectorEmbeddingPolicy)

Set the vectorEmbeddingPolicy property: The vector embedding policy for the container.

Overrides:

withVectorEmbeddingPolicy in class SqlContainerResource

Parameters:

vectorEmbeddingPolicy - the vectorEmbeddingPolicy value to set.

Returns:

the SqlContainerResource object itself.

withFullTextPolicy

public SqlContainerGetPropertiesResource withFullTextPolicy(FullTextPolicy fullTextPolicy)

Set the fullTextPolicy property: The FullText policy for the container.

Overrides:

withFullTextPolicy in class SqlContainerResource

Parameters:

fullTextPolicy - the fullTextPolicy value to set.

Returns:

the SqlContainerResource object itself.

validate

public void validate()

Validates the instance.

Overrides:

validate in class SqlContainerResource

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<SqlContainerResource>

Overrides:

toJson in class SqlContainerResource

Throws:

IOException

fromJson

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

Reads an instance of SqlContainerGetPropertiesResource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SqlContainerGetPropertiesResource 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 SqlContainerGetPropertiesResource.