### YamlMime:JavaType
uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource"
name: "SqlContainerResource"
nameWithType: "SqlContainerResource"
summary: "Cosmos DB SQL container resource object."
inheritances:
- ""
inheritedClassMethods:
- classRef: "java.lang.Object"
methodsRef:
- "clone"
- "equals"
- "finalize"
- "getClass"
- "hashCode"
- "notify"
- "notifyAll"
- "toString"
- "wait"
- "wait"
- "wait"
syntax: "public class **SqlContainerResource** implements <>"
constructors:
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.SqlContainerResource()"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.SqlContainerResource()"
name: "SqlContainerResource()"
nameWithType: "SqlContainerResource.SqlContainerResource()"
summary: "Creates an instance of SqlContainerResource class."
syntax: "public SqlContainerResource()"
desc: "Creates an instance of SqlContainerResource class."
methods:
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.analyticalStorageTtl()"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.analyticalStorageTtl()"
name: "analyticalStorageTtl()"
nameWithType: "SqlContainerResource.analyticalStorageTtl()"
summary: "Get the analyticalStorageTtl property: Analytical TTL."
syntax: "public Long analyticalStorageTtl()"
desc: "Get the analyticalStorageTtl property: Analytical TTL."
returns:
description: "the analyticalStorageTtl value."
type: "Long"
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.clientEncryptionPolicy()"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.clientEncryptionPolicy()"
name: "clientEncryptionPolicy()"
nameWithType: "SqlContainerResource.clientEncryptionPolicy()"
summary: "Get the clientEncryptionPolicy property: The client encryption policy for the container."
syntax: "public ClientEncryptionPolicy clientEncryptionPolicy()"
desc: "Get the clientEncryptionPolicy property: The client encryption policy for the container."
returns:
description: "the clientEncryptionPolicy value."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.computedProperties()"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.computedProperties()"
name: "computedProperties()"
nameWithType: "SqlContainerResource.computedProperties()"
summary: "Get the computedProperties property: List of computed properties."
syntax: "public List computedProperties()"
desc: "Get the computedProperties property: List of computed properties."
returns:
description: "the computedProperties value."
type: "List<>"
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.conflictResolutionPolicy()"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.conflictResolutionPolicy()"
name: "conflictResolutionPolicy()"
nameWithType: "SqlContainerResource.conflictResolutionPolicy()"
summary: "Get the conflictResolutionPolicy property: The conflict resolution policy for the container."
syntax: "public ConflictResolutionPolicy conflictResolutionPolicy()"
desc: "Get the conflictResolutionPolicy property: The conflict resolution policy for the container."
returns:
description: "the conflictResolutionPolicy value."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.createMode()"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.createMode()"
name: "createMode()"
nameWithType: "SqlContainerResource.createMode()"
summary: "Get the createMode property: Enum to indicate the mode of resource creation."
syntax: "public CreateMode createMode()"
desc: "Get the createMode property: Enum to indicate the mode of resource creation."
returns:
description: "the createMode value."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.defaultTtl()"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.defaultTtl()"
name: "defaultTtl()"
nameWithType: "SqlContainerResource.defaultTtl()"
summary: "Get the defaultTtl property: Default time to live."
syntax: "public Integer defaultTtl()"
desc: "Get the defaultTtl property: Default time to live."
returns:
description: "the defaultTtl value."
type: "Integer"
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "SqlContainerResource.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of SqlContainerResource from the JsonReader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: ""
syntax: "public static SqlContainerResource fromJson(JsonReader jsonReader)"
exceptions:
- description: "If the deserialized JSON object was missing any required properties."
type: "IOException"
desc: "Reads an instance of SqlContainerResource from the JsonReader."
returns:
description: "An instance of SqlContainerResource if the JsonReader was pointing to an instance of it, or null if it\n was pointing to JSON null."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.id()"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.id()"
name: "id()"
nameWithType: "SqlContainerResource.id()"
summary: "Get the id property: Name of the Cosmos DB SQL container."
syntax: "public String id()"
desc: "Get the id property: Name of the Cosmos DB SQL container."
returns:
description: "the id value."
type: "String"
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.indexingPolicy()"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.indexingPolicy()"
name: "indexingPolicy()"
nameWithType: "SqlContainerResource.indexingPolicy()"
summary: "Get the indexingPolicy property: The configuration of the indexing policy."
syntax: "public IndexingPolicy indexingPolicy()"
desc: "Get the indexingPolicy property: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container."
returns:
description: "the indexingPolicy value."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.partitionKey()"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.partitionKey()"
name: "partitionKey()"
nameWithType: "SqlContainerResource.partitionKey()"
summary: "Get the partitionKey property: The configuration of the partition key to be used for partitioning data into multiple partitions."
syntax: "public ContainerPartitionKey partitionKey()"
desc: "Get the partitionKey property: The configuration of the partition key to be used for partitioning data into multiple partitions."
returns:
description: "the partitionKey value."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.restoreParameters()"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.restoreParameters()"
name: "restoreParameters()"
nameWithType: "SqlContainerResource.restoreParameters()"
summary: "Get the restoreParameters property: Parameters to indicate the information about the restore."
syntax: "public ResourceRestoreParameters restoreParameters()"
desc: "Get the restoreParameters property: Parameters to indicate the information about the restore."
returns:
description: "the restoreParameters value."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "SqlContainerResource.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: ""
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "IOException"
returns:
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.uniqueKeyPolicy()"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.uniqueKeyPolicy()"
name: "uniqueKeyPolicy()"
nameWithType: "SqlContainerResource.uniqueKeyPolicy()"
summary: "Get the uniqueKeyPolicy property: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service."
syntax: "public UniqueKeyPolicy uniqueKeyPolicy()"
desc: "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:
description: "the uniqueKeyPolicy value."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.validate()"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.validate()"
name: "validate()"
nameWithType: "SqlContainerResource.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withAnalyticalStorageTtl(java.lang.Long)"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withAnalyticalStorageTtl(Long analyticalStorageTtl)"
name: "withAnalyticalStorageTtl(Long analyticalStorageTtl)"
nameWithType: "SqlContainerResource.withAnalyticalStorageTtl(Long analyticalStorageTtl)"
summary: "Set the analyticalStorageTtl property: Analytical TTL."
parameters:
- description: "the analyticalStorageTtl value to set."
name: "analyticalStorageTtl"
type: "Long"
syntax: "public SqlContainerResource withAnalyticalStorageTtl(Long analyticalStorageTtl)"
desc: "Set the analyticalStorageTtl property: Analytical TTL."
returns:
description: "the SqlContainerResource object itself."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withClientEncryptionPolicy(com.azure.resourcemanager.cosmos.models.ClientEncryptionPolicy)"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withClientEncryptionPolicy(ClientEncryptionPolicy clientEncryptionPolicy)"
name: "withClientEncryptionPolicy(ClientEncryptionPolicy clientEncryptionPolicy)"
nameWithType: "SqlContainerResource.withClientEncryptionPolicy(ClientEncryptionPolicy clientEncryptionPolicy)"
summary: "Set the clientEncryptionPolicy property: The client encryption policy for the container."
parameters:
- description: "the clientEncryptionPolicy value to set."
name: "clientEncryptionPolicy"
type: ""
syntax: "public SqlContainerResource withClientEncryptionPolicy(ClientEncryptionPolicy clientEncryptionPolicy)"
desc: "Set the clientEncryptionPolicy property: The client encryption policy for the container."
returns:
description: "the SqlContainerResource object itself."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withComputedProperties(java.util.List)"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withComputedProperties(List computedProperties)"
name: "withComputedProperties(List computedProperties)"
nameWithType: "SqlContainerResource.withComputedProperties(List computedProperties)"
summary: "Set the computedProperties property: List of computed properties."
parameters:
- description: "the computedProperties value to set."
name: "computedProperties"
type: "List<>"
syntax: "public SqlContainerResource withComputedProperties(List computedProperties)"
desc: "Set the computedProperties property: List of computed properties."
returns:
description: "the SqlContainerResource object itself."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withConflictResolutionPolicy(com.azure.resourcemanager.cosmos.models.ConflictResolutionPolicy)"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withConflictResolutionPolicy(ConflictResolutionPolicy conflictResolutionPolicy)"
name: "withConflictResolutionPolicy(ConflictResolutionPolicy conflictResolutionPolicy)"
nameWithType: "SqlContainerResource.withConflictResolutionPolicy(ConflictResolutionPolicy conflictResolutionPolicy)"
summary: "Set the conflictResolutionPolicy property: The conflict resolution policy for the container."
parameters:
- description: "the conflictResolutionPolicy value to set."
name: "conflictResolutionPolicy"
type: ""
syntax: "public SqlContainerResource withConflictResolutionPolicy(ConflictResolutionPolicy conflictResolutionPolicy)"
desc: "Set the conflictResolutionPolicy property: The conflict resolution policy for the container."
returns:
description: "the SqlContainerResource object itself."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withCreateMode(com.azure.resourcemanager.cosmos.models.CreateMode)"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withCreateMode(CreateMode createMode)"
name: "withCreateMode(CreateMode createMode)"
nameWithType: "SqlContainerResource.withCreateMode(CreateMode createMode)"
summary: "Set the createMode property: Enum to indicate the mode of resource creation."
parameters:
- description: "the createMode value to set."
name: "createMode"
type: ""
syntax: "public SqlContainerResource withCreateMode(CreateMode createMode)"
desc: "Set the createMode property: Enum to indicate the mode of resource creation."
returns:
description: "the SqlContainerResource object itself."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withDefaultTtl(java.lang.Integer)"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withDefaultTtl(Integer defaultTtl)"
name: "withDefaultTtl(Integer defaultTtl)"
nameWithType: "SqlContainerResource.withDefaultTtl(Integer defaultTtl)"
summary: "Set the defaultTtl property: Default time to live."
parameters:
- description: "the defaultTtl value to set."
name: "defaultTtl"
type: "Integer"
syntax: "public SqlContainerResource withDefaultTtl(Integer defaultTtl)"
desc: "Set the defaultTtl property: Default time to live."
returns:
description: "the SqlContainerResource object itself."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withId(java.lang.String)"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withId(String id)"
name: "withId(String id)"
nameWithType: "SqlContainerResource.withId(String id)"
summary: "Set the id property: Name of the Cosmos DB SQL container."
parameters:
- description: "the id value to set."
name: "id"
type: "String"
syntax: "public SqlContainerResource withId(String id)"
desc: "Set the id property: Name of the Cosmos DB SQL container."
returns:
description: "the SqlContainerResource object itself."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withIndexingPolicy(com.azure.resourcemanager.cosmos.models.IndexingPolicy)"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withIndexingPolicy(IndexingPolicy indexingPolicy)"
name: "withIndexingPolicy(IndexingPolicy indexingPolicy)"
nameWithType: "SqlContainerResource.withIndexingPolicy(IndexingPolicy indexingPolicy)"
summary: "Set the indexingPolicy property: The configuration of the indexing policy."
parameters:
- description: "the indexingPolicy value to set."
name: "indexingPolicy"
type: ""
syntax: "public SqlContainerResource withIndexingPolicy(IndexingPolicy indexingPolicy)"
desc: "Set the indexingPolicy property: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container."
returns:
description: "the SqlContainerResource object itself."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withPartitionKey(com.azure.resourcemanager.cosmos.models.ContainerPartitionKey)"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withPartitionKey(ContainerPartitionKey partitionKey)"
name: "withPartitionKey(ContainerPartitionKey partitionKey)"
nameWithType: "SqlContainerResource.withPartitionKey(ContainerPartitionKey partitionKey)"
summary: "Set the partitionKey property: The configuration of the partition key to be used for partitioning data into multiple partitions."
parameters:
- description: "the partitionKey value to set."
name: "partitionKey"
type: ""
syntax: "public SqlContainerResource withPartitionKey(ContainerPartitionKey partitionKey)"
desc: "Set the partitionKey property: The configuration of the partition key to be used for partitioning data into multiple partitions."
returns:
description: "the SqlContainerResource object itself."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withRestoreParameters(com.azure.resourcemanager.cosmos.models.ResourceRestoreParameters)"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withRestoreParameters(ResourceRestoreParameters restoreParameters)"
name: "withRestoreParameters(ResourceRestoreParameters restoreParameters)"
nameWithType: "SqlContainerResource.withRestoreParameters(ResourceRestoreParameters restoreParameters)"
summary: "Set the restoreParameters property: Parameters to indicate the information about the restore."
parameters:
- description: "the restoreParameters value to set."
name: "restoreParameters"
type: ""
syntax: "public SqlContainerResource withRestoreParameters(ResourceRestoreParameters restoreParameters)"
desc: "Set the restoreParameters property: Parameters to indicate the information about the restore."
returns:
description: "the SqlContainerResource object itself."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withUniqueKeyPolicy(com.azure.resourcemanager.cosmos.models.UniqueKeyPolicy)"
fullName: "com.azure.resourcemanager.cosmos.models.SqlContainerResource.withUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)"
name: "withUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)"
nameWithType: "SqlContainerResource.withUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)"
summary: "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:
- description: "the uniqueKeyPolicy value to set."
name: "uniqueKeyPolicy"
type: ""
syntax: "public SqlContainerResource withUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)"
desc: "Set the uniqueKeyPolicy property: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service."
returns:
description: "the SqlContainerResource object itself."
type: ""
type: "class"
desc: "Cosmos DB SQL container resource object."
implements:
- "<>"
metadata: {}
package: "com.azure.resourcemanager.cosmos.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.0