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

Implements

JsonSerializable<SqlContainerResource>

public class SqlContainerResource
implements JsonSerializable<SqlContainerResource>

Cosmos DB SQL container resource object.

Constructor Summary

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

Method Summary

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

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SqlContainerResource

public SqlContainerResource()

Creates an instance of SqlContainerResource class.

Method Details

analyticalStorageTtl

public Long analyticalStorageTtl()

Get the analyticalStorageTtl property: Analytical TTL.

Returns:

the analyticalStorageTtl value.

clientEncryptionPolicy

public ClientEncryptionPolicy clientEncryptionPolicy()

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

Returns:

the clientEncryptionPolicy value.

computedProperties

public List computedProperties()

Get the computedProperties property: List of computed properties.

Returns:

the computedProperties value.

conflictResolutionPolicy

public ConflictResolutionPolicy conflictResolutionPolicy()

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

Returns:

the conflictResolutionPolicy value.

createMode

public CreateMode createMode()

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

Returns:

the createMode value.

defaultTtl

public Integer defaultTtl()

Get the defaultTtl property: Default time to live.

Returns:

the defaultTtl value.

fromJson

public static SqlContainerResource fromJson(JsonReader jsonReader)

Reads an instance of SqlContainerResource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

id

public String id()

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

Returns:

the id value.

indexingPolicy

public IndexingPolicy indexingPolicy()

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

Returns:

the indexingPolicy value.

partitionKey

public ContainerPartitionKey partitionKey()

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

Returns:

the partitionKey value.

restoreParameters

public ResourceRestoreParameters restoreParameters()

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

Returns:

the restoreParameters value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

uniqueKeyPolicy

public UniqueKeyPolicy uniqueKeyPolicy()

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

Returns:

the uniqueKeyPolicy value.

validate

public void validate()

Validates the instance.

vectorEmbeddingPolicy

public VectorEmbeddingPolicy vectorEmbeddingPolicy()

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

Returns:

the vectorEmbeddingPolicy value.

withAnalyticalStorageTtl

public SqlContainerResource withAnalyticalStorageTtl(Long analyticalStorageTtl)

Set the analyticalStorageTtl property: Analytical TTL.

Parameters:

analyticalStorageTtl - the analyticalStorageTtl value to set.

Returns:

the SqlContainerResource object itself.

withClientEncryptionPolicy

public SqlContainerResource withClientEncryptionPolicy(ClientEncryptionPolicy clientEncryptionPolicy)

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

Parameters:

clientEncryptionPolicy - the clientEncryptionPolicy value to set.

Returns:

the SqlContainerResource object itself.

withComputedProperties

public SqlContainerResource withComputedProperties(List computedProperties)

Set the computedProperties property: List of computed properties.

Parameters:

computedProperties - the computedProperties value to set.

Returns:

the SqlContainerResource object itself.

withConflictResolutionPolicy

public SqlContainerResource withConflictResolutionPolicy(ConflictResolutionPolicy conflictResolutionPolicy)

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

Parameters:

conflictResolutionPolicy - the conflictResolutionPolicy value to set.

Returns:

the SqlContainerResource object itself.

withCreateMode

public SqlContainerResource withCreateMode(CreateMode createMode)

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

Parameters:

createMode - the createMode value to set.

Returns:

the SqlContainerResource object itself.

withDefaultTtl

public SqlContainerResource withDefaultTtl(Integer defaultTtl)

Set the defaultTtl property: Default time to live.

Parameters:

defaultTtl - the defaultTtl value to set.

Returns:

the SqlContainerResource object itself.

withId

public SqlContainerResource withId(String id)

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

Parameters:

id - the id value to set.

Returns:

the SqlContainerResource object itself.

withIndexingPolicy

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

Parameters:

indexingPolicy - the indexingPolicy value to set.

Returns:

the SqlContainerResource object itself.

withPartitionKey

public SqlContainerResource withPartitionKey(ContainerPartitionKey partitionKey)

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

Parameters:

partitionKey - the partitionKey value to set.

Returns:

the SqlContainerResource object itself.

withRestoreParameters

public SqlContainerResource withRestoreParameters(ResourceRestoreParameters restoreParameters)

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

Parameters:

restoreParameters - the restoreParameters value to set.

Returns:

the SqlContainerResource object itself.

withUniqueKeyPolicy

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

Parameters:

uniqueKeyPolicy - the uniqueKeyPolicy value to set.

Returns:

the SqlContainerResource object itself.

withVectorEmbeddingPolicy

public SqlContainerResource withVectorEmbeddingPolicy(VectorEmbeddingPolicy vectorEmbeddingPolicy)

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

Parameters:

vectorEmbeddingPolicy - the vectorEmbeddingPolicy value to set.

Returns:

the SqlContainerResource object itself.