SqlContainerGetPropertiesResource Class

Package:

com.azure.resourcemanager.cosmos.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cosmos:2.45.0

• java.lang.Object
• • com.azure.resourcemanager.cosmos.models.SqlContainerResource
  • • com.azure.resourcemanager.cosmos.models.SqlContainerGetPropertiesResource

public final class SqlContainerGetPropertiesResource
extends SqlContainerResource

The SqlContainerGetPropertiesResource model.

Constructor Summary

Constructor	Description
SqlContainerGetPropertiesResource()	Creates an instance of SqlContainerGetPropertiesResource 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 SqlContainerGetPropertiesResource	fromJson(JsonReader jsonReader) Reads an instance of SqlContainerGetPropertiesResource 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.
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	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.

Methods inherited from SqlContainerResource

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

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SqlContainerGetPropertiesResource

public SqlContainerGetPropertiesResource()

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

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:

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:

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

SqlContainerGetPropertiesResource.validate()

withAnalyticalStorageTtl

public SqlContainerGetPropertiesResource withAnalyticalStorageTtl(Long analyticalStorageTtl)

Set the analyticalStorageTtl property: Analytical TTL.

Overrides:

SqlContainerGetPropertiesResource.withAnalyticalStorageTtl(Long analyticalStorageTtl)

Parameters:

analyticalStorageTtl

withClientEncryptionPolicy

public SqlContainerGetPropertiesResource withClientEncryptionPolicy(ClientEncryptionPolicy clientEncryptionPolicy)

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

Overrides:

SqlContainerGetPropertiesResource.withClientEncryptionPolicy(ClientEncryptionPolicy clientEncryptionPolicy)

Parameters:

clientEncryptionPolicy

withComputedProperties

public SqlContainerGetPropertiesResource withComputedProperties(List computedProperties)

Set the computedProperties property: List of computed properties.

Overrides:

SqlContainerGetPropertiesResource.withComputedProperties(List<ComputedProperty> computedProperties)

Parameters:

computedProperties

withConflictResolutionPolicy

public SqlContainerGetPropertiesResource withConflictResolutionPolicy(ConflictResolutionPolicy conflictResolutionPolicy)

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

Overrides:

SqlContainerGetPropertiesResource.withConflictResolutionPolicy(ConflictResolutionPolicy conflictResolutionPolicy)

Parameters:

conflictResolutionPolicy

withCreateMode

public SqlContainerGetPropertiesResource withCreateMode(CreateMode createMode)

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

Overrides:

SqlContainerGetPropertiesResource.withCreateMode(CreateMode createMode)

Parameters:

createMode

withDefaultTtl

public SqlContainerGetPropertiesResource withDefaultTtl(Integer defaultTtl)

Set the defaultTtl property: Default time to live.

Overrides:

SqlContainerGetPropertiesResource.withDefaultTtl(Integer defaultTtl)

Parameters:

defaultTtl

withId

public SqlContainerGetPropertiesResource withId(String id)

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

Overrides:

SqlContainerGetPropertiesResource.withId(String id)

Parameters:

id

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:

SqlContainerGetPropertiesResource.withIndexingPolicy(IndexingPolicy indexingPolicy)

Parameters:

indexingPolicy

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:

SqlContainerGetPropertiesResource.withPartitionKey(ContainerPartitionKey partitionKey)

Parameters:

partitionKey

withRestoreParameters

public SqlContainerGetPropertiesResource withRestoreParameters(ResourceRestoreParameters restoreParameters)

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

Overrides:

SqlContainerGetPropertiesResource.withRestoreParameters(ResourceRestoreParameters restoreParameters)

Parameters:

restoreParameters

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:

SqlContainerGetPropertiesResource.withUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

Parameters:

uniqueKeyPolicy