RestorableSqlContainerPropertiesResourceContainer 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
  • • com.azure.resourcemanager.cosmos.models.RestorableSqlContainerPropertiesResourceContainer

public final class RestorableSqlContainerPropertiesResourceContainer
extends SqlContainerResource

Cosmos DB SQL container resource object.

Constructor Summary

Constructor	Description
RestorableSqlContainerPropertiesResourceContainer()	Creates an instance of RestorableSqlContainerPropertiesResourceContainer 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 RestorableSqlContainerPropertiesResourceContainer	fromJson(JsonReader jsonReader) Reads an instance of RestorableSqlContainerPropertiesResourceContainer from the JsonReader.
String	rid() Get the rid property: A system generated property.
String	self() Get the self property: A system generated property that specifies the addressable path of the container resource.
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.
RestorableSqlContainerPropertiesResourceContainer	withAnalyticalStorageTtl(Long analyticalStorageTtl) Set the analyticalStorageTtl property: Analytical TTL.
RestorableSqlContainerPropertiesResourceContainer	withClientEncryptionPolicy(ClientEncryptionPolicy clientEncryptionPolicy) Set the clientEncryptionPolicy property: The client encryption policy for the container.
RestorableSqlContainerPropertiesResourceContainer	withComputedProperties(List<ComputedProperty> computedProperties) Set the computedProperties property: List of computed properties.
RestorableSqlContainerPropertiesResourceContainer	withConflictResolutionPolicy(ConflictResolutionPolicy conflictResolutionPolicy) Set the conflictResolutionPolicy property: The conflict resolution policy for the container.
RestorableSqlContainerPropertiesResourceContainer	withCreateMode(CreateMode createMode) Set the createMode property: Enum to indicate the mode of resource creation.
RestorableSqlContainerPropertiesResourceContainer	withDefaultTtl(Integer defaultTtl) Set the defaultTtl property: Default time to live.
RestorableSqlContainerPropertiesResourceContainer	withId(String id) Set the id property: Name of the Cosmos DB SQL container.
RestorableSqlContainerPropertiesResourceContainer	withIndexingPolicy(IndexingPolicy indexingPolicy) Set the indexingPolicy property: The configuration of the indexing policy.
RestorableSqlContainerPropertiesResourceContainer	withPartitionKey(ContainerPartitionKey partitionKey) Set the partitionKey property: The configuration of the partition key to be used for partitioning data into multiple partitions.
RestorableSqlContainerPropertiesResourceContainer	withRestoreParameters(ResourceRestoreParameters restoreParameters) Set the restoreParameters property: Parameters to indicate the information about the restore.
RestorableSqlContainerPropertiesResourceContainer	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.
RestorableSqlContainerPropertiesResourceContainer	withVectorEmbeddingPolicy(VectorEmbeddingPolicy vectorEmbeddingPolicy) Set the vectorEmbeddingPolicy property: The vector embedding policy for the container.

Methods inherited from SqlContainerResource

analyticalStorageTtl clientEncryptionPolicy computedProperties conflictResolutionPolicy createMode defaultTtl fromJson id indexingPolicy partitionKey restoreParameters toJson uniqueKeyPolicy validate vectorEmbeddingPolicy withAnalyticalStorageTtl withClientEncryptionPolicy withComputedProperties withConflictResolutionPolicy withCreateMode withDefaultTtl withId withIndexingPolicy withPartitionKey withRestoreParameters withUniqueKeyPolicy withVectorEmbeddingPolicy

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RestorableSqlContainerPropertiesResourceContainer

public RestorableSqlContainerPropertiesResourceContainer()

Creates an instance of RestorableSqlContainerPropertiesResourceContainer 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 RestorableSqlContainerPropertiesResourceContainer fromJson(JsonReader jsonReader)

Reads an instance of RestorableSqlContainerPropertiesResourceContainer from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

self

public String self()

Get the self property: A system generated property that specifies the addressable path of the container resource.

Returns:

the self value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

RestorableSqlContainerPropertiesResourceContainer.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:

RestorableSqlContainerPropertiesResourceContainer.validate()

withAnalyticalStorageTtl

public RestorableSqlContainerPropertiesResourceContainer withAnalyticalStorageTtl(Long analyticalStorageTtl)

Set the analyticalStorageTtl property: Analytical TTL.

Overrides:

RestorableSqlContainerPropertiesResourceContainer.withAnalyticalStorageTtl(Long analyticalStorageTtl)

Parameters:

analyticalStorageTtl

withClientEncryptionPolicy

public RestorableSqlContainerPropertiesResourceContainer withClientEncryptionPolicy(ClientEncryptionPolicy clientEncryptionPolicy)

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

Overrides:

RestorableSqlContainerPropertiesResourceContainer.withClientEncryptionPolicy(ClientEncryptionPolicy clientEncryptionPolicy)

Parameters:

clientEncryptionPolicy

withComputedProperties

public RestorableSqlContainerPropertiesResourceContainer withComputedProperties(List computedProperties)

Set the computedProperties property: List of computed properties.

Overrides:

RestorableSqlContainerPropertiesResourceContainer.withComputedProperties(List<ComputedProperty> computedProperties)

Parameters:

computedProperties

withConflictResolutionPolicy

public RestorableSqlContainerPropertiesResourceContainer withConflictResolutionPolicy(ConflictResolutionPolicy conflictResolutionPolicy)

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

Overrides:

RestorableSqlContainerPropertiesResourceContainer.withConflictResolutionPolicy(ConflictResolutionPolicy conflictResolutionPolicy)

Parameters:

conflictResolutionPolicy

withCreateMode

public RestorableSqlContainerPropertiesResourceContainer withCreateMode(CreateMode createMode)

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

Overrides:

RestorableSqlContainerPropertiesResourceContainer.withCreateMode(CreateMode createMode)

Parameters:

createMode

withDefaultTtl

public RestorableSqlContainerPropertiesResourceContainer withDefaultTtl(Integer defaultTtl)

Set the defaultTtl property: Default time to live.

Overrides:

RestorableSqlContainerPropertiesResourceContainer.withDefaultTtl(Integer defaultTtl)

Parameters:

defaultTtl

withId

public RestorableSqlContainerPropertiesResourceContainer withId(String id)

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

Overrides:

RestorableSqlContainerPropertiesResourceContainer.withId(String id)

Parameters:

id

withIndexingPolicy

public RestorableSqlContainerPropertiesResourceContainer 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:

RestorableSqlContainerPropertiesResourceContainer.withIndexingPolicy(IndexingPolicy indexingPolicy)

Parameters:

indexingPolicy

withPartitionKey

public RestorableSqlContainerPropertiesResourceContainer withPartitionKey(ContainerPartitionKey partitionKey)

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

Overrides:

RestorableSqlContainerPropertiesResourceContainer.withPartitionKey(ContainerPartitionKey partitionKey)

Parameters:

partitionKey

withRestoreParameters

public RestorableSqlContainerPropertiesResourceContainer withRestoreParameters(ResourceRestoreParameters restoreParameters)

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

Overrides:

RestorableSqlContainerPropertiesResourceContainer.withRestoreParameters(ResourceRestoreParameters restoreParameters)

Parameters:

restoreParameters

withUniqueKeyPolicy

public RestorableSqlContainerPropertiesResourceContainer 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:

RestorableSqlContainerPropertiesResourceContainer.withUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

Parameters:

uniqueKeyPolicy

withVectorEmbeddingPolicy

public RestorableSqlContainerPropertiesResourceContainer withVectorEmbeddingPolicy(VectorEmbeddingPolicy vectorEmbeddingPolicy)

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

Overrides:

RestorableSqlContainerPropertiesResourceContainer.withVectorEmbeddingPolicy(VectorEmbeddingPolicy vectorEmbeddingPolicy)

Parameters:

vectorEmbeddingPolicy