Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- add(boolean) - Method in class com.azure.cosmos.models.PartitionKeyBuilder
-
Adds partition value of type boolean
- add(double) - Method in class com.azure.cosmos.models.PartitionKeyBuilder
-
Adds partition value of type double
- add(String) - Method in class com.azure.cosmos.models.PartitionKeyBuilder
-
Adds partition value of type string
- add(String, T) - Method in class com.azure.cosmos.models.CosmosPatchOperations
-
This performs one of the following functions, depending upon what the target location references: 1.
- addMetricCategories(CosmosMetricCategory...) - Method in class com.azure.cosmos.models.CosmosMicrometerMetricsOptions
-
Adds categories of metrics that should be emitted.
- addNoneValue() - Method in class com.azure.cosmos.models.PartitionKeyBuilder
-
Deprecated.PartitionKey.None value should only be used with PartitionKey constructor.
- addNullValue() - Method in class com.azure.cosmos.models.PartitionKeyBuilder
-
Deprecated.Null value should only be used with PartitionKey constructor.
- addOperationPolicy(CosmosOperationPolicy) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Adds a policy for modifying request options dynamically.
- ADDRESS_RESOLUTION_COLLECTION_MAP_REFRESH - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
An indicator whether an address resolution refresh requested a collection routing map cache refresh Applicable to address resolutions
- ADDRESS_RESOLUTION_FORCED_REFRESH - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
An indicator whether an address resolution refresh requested a cache refresh Applicable to address resolutions
- ALL - Enum constant in enum com.azure.cosmos.models.PermissionMode
-
Permission applicable for all operations.
- ALL - Enum constant in enum com.azure.cosmos.models.ShowQueryMode
-
Print both parameterized and non parameterized query.
- ALL - Enum constant in enum com.azure.cosmos.models.TriggerOperation
-
ALL operations.
- ALL - Static variable in class com.azure.cosmos.models.CosmosMetricCategory
-
All metrics enabled
- ALL - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
All possible tags
- allVersionsAndDeletes() - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Changes the change feed mode so that the change feed will contain events for creations, deletes as well as all intermediary snapshots for updates.
- applyDiagnosticThresholds(boolean) - Method in class com.azure.cosmos.models.CosmosMicrometerMeterOptions
-
Sets a flag whether the diagnostic thresholds should be applied for this meter.
- applyDiagnosticThresholdsForTransportLevelMeters(boolean) - Method in class com.azure.cosmos.models.CosmosMicrometerMetricsOptions
-
Sets a flag indicating whether for transport level (rntbd) meters should only be emitted when diagnostic thresholds are violated.
- ASCENDING - Enum constant in enum com.azure.cosmos.models.CompositePathSortOrder
-
ASCENDING sort order for composite paths.
- authorizationTokenResolver(CosmosAuthorizationTokenResolver) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the token resolver
- availabilityStrategy(AvailabilityStrategy) - Method in class com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfigBuilder
-
Sets the availability strategy to be used for the policy.
- AvailabilityStrategy - Class in com.azure.cosmos
-
The type Availability strategy.
B
- Beta - Annotation Type in com.azure.cosmos.util
-
Indicates functionality that is in preview and as such is subject to change in non-backwards compatible ways in future releases, including removal, regardless of any compatibility expectations set by the containing library version.
- Beta.SinceVersion - Enum in com.azure.cosmos.util
-
Azure library version numbers
- BOUNDED_STALENESS - Enum constant in enum com.azure.cosmos.ConsistencyLevel
-
Bounded Staleness guarantees that reads are not too out-of-date.
- build() - Method in class com.azure.cosmos.CosmosContainerProactiveInitConfigBuilder
-
Builds
CosmosContainerProactiveInitConfig
with the provided properties - build() - Method in class com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfigBuilder
-
Builds
CosmosEndToEndOperationLatencyPolicyConfig
with specified properties - build() - Method in class com.azure.cosmos.GlobalThroughputControlConfigBuilder
-
Validate the throughput global control configuration and create a new throughput global control config item.
- build() - Method in class com.azure.cosmos.models.PartitionKeyBuilder
-
Builds a new instance of the type PartitionKey with the specified Partition Key values.
- build() - Method in class com.azure.cosmos.SessionRetryOptionsBuilder
-
Builds an instance of
SessionRetryOptions
- build() - Method in class com.azure.cosmos.ThroughputControlGroupConfigBuilder
-
Validate the throughput configuration and create a new throughput control group config item.
- buildAsyncClient() - Method in class com.azure.cosmos.CosmosClientBuilder
-
Builds a cosmos async client with the provided properties
- buildChangeFeedProcessor() - Method in class com.azure.cosmos.ChangeFeedProcessorBuilder
-
Builds a new instance of the
ChangeFeedProcessor
with the specified configuration. - buildClient() - Method in class com.azure.cosmos.CosmosClientBuilder
-
Builds a cosmos sync client with the provided properties
- byPage() - Method in class com.azure.cosmos.util.CosmosPagedFlux
- byPage(int) - Method in class com.azure.cosmos.util.CosmosPagedFlux
- byPage(String) - Method in class com.azure.cosmos.util.CosmosPagedFlux
- byPage(String, int) - Method in class com.azure.cosmos.util.CosmosPagedFlux
C
- ChangeFeedMetaData - Class in com.azure.cosmos.models
-
Change Feed response meta data
- ChangeFeedMetaData() - Constructor for class com.azure.cosmos.models.ChangeFeedMetaData
- ChangeFeedOperationType - Enum in com.azure.cosmos.models
-
Change feed operation type
- ChangeFeedPolicy - Class in com.azure.cosmos.models
-
Represents the change feed policy configuration for the container in the Azure Cosmos DB service.
- ChangeFeedProcessor - Interface in com.azure.cosmos
-
Simple host for distributing change feed events across observers, simplifying the process of reading the change feeds and distributing the processing events across multiple consumers effectively.
- ChangeFeedProcessorBuilder - Class in com.azure.cosmos
-
Helper class to build a
ChangeFeedProcessor
instance. - ChangeFeedProcessorBuilder() - Constructor for class com.azure.cosmos.ChangeFeedProcessorBuilder
-
Instantiates a new Cosmos a new ChangeFeedProcessor builder.
- ChangeFeedProcessorContext - Interface in com.azure.cosmos
-
Encapsulates properties which are mapped to a batch of change feed documents processed when
ChangeFeedProcessorBuilder.handleAllVersionsAndDeletesChanges(BiConsumer)
lambda is invoked. - ChangeFeedProcessorItem - Class in com.azure.cosmos.models
-
Change Feed processor item.
- ChangeFeedProcessorItem() - Constructor for class com.azure.cosmos.models.ChangeFeedProcessorItem
- ChangeFeedProcessorOptions - Class in com.azure.cosmos.models
-
Specifies the options associated with
ChangeFeedProcessor
. - ChangeFeedProcessorOptions() - Constructor for class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Instantiates a new Change feed processor options.
- ChangeFeedProcessorState - Class in com.azure.cosmos.models
-
Specifies the
ChangeFeedProcessor
state for a particular lease/worker. - ChangeFeedProcessorState() - Constructor for class com.azure.cosmos.models.ChangeFeedProcessorState
- CLIENT_CORRELATION_ID - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
An identifier for the instance of the Cosmos client Applicable to all meters
- clientCorrelationId(String) - Method in class com.azure.cosmos.models.CosmosClientTelemetryConfig
-
Sets the client correlationId used for tags in metrics.
- ClientEncryptionIncludedPath - Class in com.azure.cosmos.models
-
Path that needs encryption and the associated settings within
ClientEncryptionPolicy
. - ClientEncryptionIncludedPath() - Constructor for class com.azure.cosmos.models.ClientEncryptionIncludedPath
- ClientEncryptionPolicy - Class in com.azure.cosmos.models
-
Client encryption policy.
- ClientEncryptionPolicy() - Constructor for class com.azure.cosmos.models.ClientEncryptionPolicy
-
Constructor.
- ClientEncryptionPolicy(List<ClientEncryptionIncludedPath>) - Constructor for class com.azure.cosmos.models.ClientEncryptionPolicy
-
Constructor.
- ClientEncryptionPolicy(List<ClientEncryptionIncludedPath>, int) - Constructor for class com.azure.cosmos.models.ClientEncryptionPolicy
-
Constructor.
- clientTelemetryConfig(CosmosClientTelemetryConfig) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Returns the client telemetry config instance for this builder
- clientTelemetryEnabled(boolean) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the flag to enable client telemetry which will periodically collect database operations aggregation statistics, system information like cpu/memory and send it to cosmos monitoring service, which will be helpful during debugging.
- close() - Method in class com.azure.cosmos.CosmosAsyncClient
-
Close this
CosmosAsyncClient
instance and cleans up the resources. - close() - Method in class com.azure.cosmos.CosmosClient
-
Close this
CosmosClient
instance. - com.azure.cosmos - package com.azure.cosmos
-
This package provides interfaces for interacting with Azure Cosmos DB.
- com.azure.cosmos.models - package com.azure.cosmos.models
-
This package provides rest contracts for interacting with Azure Cosmos DB SQL APIs.
- com.azure.cosmos.util - package com.azure.cosmos.util
-
This package provides utilities such as
CosmosPagedFlux
andCosmosPagedIterable
for interacting with Azure Cosmos DB SQL APIs. - CompositePath - Class in com.azure.cosmos.models
-
Represents a composite path of the IndexingPolicy in the Azure Cosmos DB database service.
- CompositePath() - Constructor for class com.azure.cosmos.models.CompositePath
-
Constructor.
- CompositePathSortOrder - Enum in com.azure.cosmos.models
-
Represents the sorting order for a path in a composite index, for a container in the Azure Cosmos DB database service.
- ComputedProperty - Class in com.azure.cosmos.models
-
Represents a computed property definition for a Cosmos DB container.
- ComputedProperty(String, String) - Constructor for class com.azure.cosmos.models.ComputedProperty
-
Instantiates a new Computed properties with name and query.
- configureDefaultPercentiles(double...) - Method in class com.azure.cosmos.models.CosmosMicrometerMetricsOptions
-
Sets the default percentiles that should be captured for metrics (where applicable) unless overridden for a specific meter in its
CosmosMicrometerMeterOptions
By default percentiles 0.95 and 0.99 are captured. - configureDefaultTagNames(CosmosMetricTagName...) - Method in class com.azure.cosmos.models.CosmosMicrometerMetricsOptions
-
Sets the default tags that should be used for metrics (where applicable) unless overridden for a specific meter in its
CosmosMicrometerMeterOptions
By default all applicable tags are added for each metric. - configureMeter(CosmosMetricName, CosmosMicrometerMeterOptions) - Method in class com.azure.cosmos.models.CosmosMicrometerMetricsOptions
-
Allows overriding meter-specific options.
- configurePercentiles(double...) - Method in class com.azure.cosmos.models.CosmosMicrometerMeterOptions
-
Sets the percentiles that should be captured for this meter (when applicable)
- ConflictResolutionMode - Enum in com.azure.cosmos.models
-
The enum Conflict resolution mode.
- ConflictResolutionPolicy - Class in com.azure.cosmos.models
-
Represents the conflict resolution policy configuration for specifying how to resolve conflicts in case writes from different regions result in conflicts on items in the container in the Azure Cosmos DB service.
- ConnectionMode - Enum in com.azure.cosmos
-
Represents the connection mode to be used by the client in the Azure Cosmos DB database service.
- connectionSharingAcrossClientsEnabled(boolean) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Enables connections sharing across multiple Cosmos Clients.
- CONSISTENCY_LEVEL - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
Effective Consistency model Applicable to operations and requests
- consistencyLevel(ConsistencyLevel) - Method in class com.azure.cosmos.CosmosClientBuilder
- ConsistencyLevel - Enum in com.azure.cosmos
-
Represents the consistency levels supported for Azure Cosmos DB client operations in the Azure Cosmos DB service.
- CONSISTENT - Enum constant in enum com.azure.cosmos.models.IndexingMode
-
Index is updated synchronously with a create or update operation.
- CONSISTENT_PREFIX - Enum constant in enum com.azure.cosmos.ConsistencyLevel
-
CONSISTENT_PREFIX Consistency guarantees that reads will return some prefix of all writes with no gaps.
- CONTAINER - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
Container identifier applicable to operations and requests
- ContainerChildResourceType - Enum in com.azure.cosmos.models
-
Specifies the kind of resource that has a Cosmos container as parent resource.
- contentResponseOnWriteEnabled(boolean) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations on CosmosItem.
- continueOnInitError() - Method in class com.azure.cosmos.ThroughputControlGroupConfig
-
Get whether request is allowed to continue on original request flow if throughput control controller failed on initialization.
- continueOnInitError(boolean) - Method in class com.azure.cosmos.ThroughputControlGroupConfigBuilder
-
Set whether allow request to continue on original request flow if throughput control controller failed on initialization.
- COSINE - Enum constant in enum com.azure.cosmos.models.CosmosVectorDistanceFunction
-
Represents the cosine distance function.
- CosmosAsyncClient - Class in com.azure.cosmos
-
Provides a client-side logical representation of the Azure Cosmos DB service.
- CosmosAsyncClientEncryptionKey - Class in com.azure.cosmos
-
The type Cosmos async clientEncryptionKey.
- CosmosAsyncConflict - Class in com.azure.cosmos
-
Read and delete conflicts
- CosmosAsyncContainer - Class in com.azure.cosmos
-
Provides methods for reading, deleting, and replacing existing Containers.
- CosmosAsyncDatabase - Class in com.azure.cosmos
-
Perform read and delete databases, update database throughput, and perform operations on child resources
- CosmosAsyncPermission - Class in com.azure.cosmos
-
Has methods to operate on a per-User Permission to access a specific resource
- CosmosAsyncScripts - Class in com.azure.cosmos
-
The type Cosmos async scripts.
- CosmosAsyncStoredProcedure - Class in com.azure.cosmos
-
The type Cosmos async stored procedure.
- CosmosAsyncTrigger - Class in com.azure.cosmos
-
The type Cosmos async trigger.
- CosmosAsyncUser - Class in com.azure.cosmos
-
The type Cosmos async user.
- CosmosAsyncUserDefinedFunction - Class in com.azure.cosmos
-
The type Cosmos async user defined function.
- CosmosAuthorizationTokenResolver - Interface in com.azure.cosmos.models
-
This interface is for client side implementation, which can be used for initializing CosmosAsyncClient without passing master key, resource token and permission feed.
Each time the SDK create request for CosmosDB, authorization token is generated based on that request at client side which enables creation of one CosmosAsyncClient per application shared across various users with different resource permissions. - CosmosBatch - Class in com.azure.cosmos.models
-
Represents a batch of operations against items with the same
PartitionKey
in a container that will be performed in a Cosmos manner at the Azure Cosmos DB service. - CosmosBatchItemRequestOptions - Class in com.azure.cosmos.models
-
Encapsulates options that can be specified for an operation within a
CosmosBatch
. - CosmosBatchItemRequestOptions() - Constructor for class com.azure.cosmos.models.CosmosBatchItemRequestOptions
-
Creates a new
CosmosBatchItemRequestOptions
object. - CosmosBatchOperationResult - Class in com.azure.cosmos.models
-
Represents a result for a specific operation that was part of a
CosmosBatch
request. - CosmosBatchPatchItemRequestOptions - Class in com.azure.cosmos.models
-
Encapsulates options that can be specified for an operation within a
CosmosBatch
. - CosmosBatchPatchItemRequestOptions() - Constructor for class com.azure.cosmos.models.CosmosBatchPatchItemRequestOptions
-
Constructor
- CosmosBatchRequestOptions - Class in com.azure.cosmos.models
-
Encapsulates options that can be specified for a
CosmosBatch
. - CosmosBatchRequestOptions() - Constructor for class com.azure.cosmos.models.CosmosBatchRequestOptions
-
Creates an instance of the CosmosBatchRequestOptions class
- CosmosBatchResponse - Class in com.azure.cosmos.models
-
Response of a
CosmosBatch
request. - CosmosBulkExecutionOptions - Class in com.azure.cosmos.models
-
Encapsulates options that can be specified for operations used in Bulk execution.
- CosmosBulkExecutionOptions() - Constructor for class com.azure.cosmos.models.CosmosBulkExecutionOptions
-
Constructor
- CosmosBulkExecutionOptions(CosmosBulkExecutionThresholdsState) - Constructor for class com.azure.cosmos.models.CosmosBulkExecutionOptions
-
Constructor
- CosmosBulkExecutionThresholdsState - Class in com.azure.cosmos.models
-
Encapsulates internal state used to dynamically determine max micro batch size for bulk operations.
- CosmosBulkExecutionThresholdsState() - Constructor for class com.azure.cosmos.models.CosmosBulkExecutionThresholdsState
-
Constructor
- CosmosBulkItemRequestOptions - Class in com.azure.cosmos.models
-
Encapsulates options that can be specified for an operation used in Bulk execution.
- CosmosBulkItemRequestOptions() - Constructor for class com.azure.cosmos.models.CosmosBulkItemRequestOptions
-
Constructor
- CosmosBulkItemResponse - Class in com.azure.cosmos.models
-
Response of a
CosmosItemOperation
request when processed using Bulk by callingCosmosAsyncContainer.executeBulkOperations(Flux, CosmosBulkExecutionOptions)
. - CosmosBulkOperationResponse<TContext> - Class in com.azure.cosmos.models
-
Request, response and the exception(if any) for a
CosmosItemOperation
request when processed using Bulk by callingCosmosAsyncContainer.executeBulkOperations(Flux, CosmosBulkExecutionOptions)
. - CosmosBulkOperations - Class in com.azure.cosmos.models
-
Utility for creating bulk operations which can be executed by calling
CosmosAsyncContainer.executeBulkOperations(Flux, CosmosBulkExecutionOptions)
. - CosmosBulkOperations() - Constructor for class com.azure.cosmos.models.CosmosBulkOperations
- CosmosBulkPatchItemRequestOptions - Class in com.azure.cosmos.models
-
Encapsulates options that can be specified for an patch operation used in Bulk execution.
- CosmosBulkPatchItemRequestOptions() - Constructor for class com.azure.cosmos.models.CosmosBulkPatchItemRequestOptions
-
Constructor
- CosmosChangeFeedRequestOptions - Class in com.azure.cosmos.models
-
Encapsulates options that can be specified for an operation within a change feed request.
- CosmosClient - Class in com.azure.cosmos
-
Provides a client-side logical representation of the Azure Cosmos DB service.
- CosmosClientBuilder - Class in com.azure.cosmos
-
Helper class to build
CosmosAsyncClient
andCosmosClient
instances as logical representation of the Azure Cosmos database service. - CosmosClientBuilder() - Constructor for class com.azure.cosmos.CosmosClientBuilder
-
Instantiates a new Cosmos client builder.
- CosmosClientEncryptionKey - Class in com.azure.cosmos
-
The type Cosmos clientEncryptionKey.
- CosmosClientEncryptionKeyProperties - Class in com.azure.cosmos.models
-
Details of an encryption key for use with the Azure Cosmos DB service.
- CosmosClientEncryptionKeyProperties(String, String, byte[], EncryptionKeyWrapMetadata) - Constructor for class com.azure.cosmos.models.CosmosClientEncryptionKeyProperties
-
Constructor.
- CosmosClientEncryptionKeyResponse - Class in com.azure.cosmos.models
-
The type Cosmos client encryption key response.
- CosmosClientTelemetryConfig - Class in com.azure.cosmos.models
-
Class with config options for Cosmos Client telemetry
- CosmosClientTelemetryConfig() - Constructor for class com.azure.cosmos.models.CosmosClientTelemetryConfig
-
Instantiates a new Cosmos client telemetry configuration.
- CosmosConflictProperties - Class in com.azure.cosmos.models
-
The type Cosmos conflict properties.
- CosmosConflictRequestOptions - Class in com.azure.cosmos.models
-
The type Cosmos conflict request options.
- CosmosConflictRequestOptions() - Constructor for class com.azure.cosmos.models.CosmosConflictRequestOptions
-
Creates a new
CosmosConflictRequestOptions
object. - CosmosConflictRequestOptions(PartitionKey) - Constructor for class com.azure.cosmos.models.CosmosConflictRequestOptions
-
Creates a new
CosmosConflictRequestOptions
object. - CosmosConflictResponse - Class in com.azure.cosmos.models
-
The type Cosmos conflict response.
- CosmosContainer - Class in com.azure.cosmos
-
Provides synchronous methods for reading, deleting, and replacing existing Containers Provides methods for interacting with child resources (Items, Scripts, Conflicts)
- CosmosContainerIdentity - Class in com.azure.cosmos.models
-
Encapsulates the container link associated with the container.
- CosmosContainerIdentity(String, String) - Constructor for class com.azure.cosmos.models.CosmosContainerIdentity
-
Instantiates a
CosmosContainerIdentity
class - CosmosContainerProactiveInitConfig - Class in com.azure.cosmos
-
Encapsulates the list of container identities and no.
- CosmosContainerProactiveInitConfigBuilder - Class in com.azure.cosmos
-
A builder to build
CosmosContainerProactiveInitConfig
- CosmosContainerProactiveInitConfigBuilder(List<CosmosContainerIdentity>) - Constructor for class com.azure.cosmos.CosmosContainerProactiveInitConfigBuilder
-
Instantiates
CosmosContainerProactiveInitConfigBuilder
- CosmosContainerProperties - Class in com.azure.cosmos.models
-
Represents a container in the Azure Cosmos DB database service.
- CosmosContainerProperties(String, PartitionKeyDefinition) - Constructor for class com.azure.cosmos.models.CosmosContainerProperties
-
Constructor
- CosmosContainerProperties(String, String) - Constructor for class com.azure.cosmos.models.CosmosContainerProperties
-
Constructor
- CosmosContainerRequestOptions - Class in com.azure.cosmos.models
-
Encapsulates options that can be specified for a request issued to Cosmos container.
- CosmosContainerRequestOptions() - Constructor for class com.azure.cosmos.models.CosmosContainerRequestOptions
- CosmosContainerResponse - Class in com.azure.cosmos.models
-
The type Cosmos container response.
- CosmosDatabase - Class in com.azure.cosmos
-
Perform read and delete databases, update database throughput, and perform operations on child resources in a synchronous way
- CosmosDatabaseProperties - Class in com.azure.cosmos.models
-
Represents a CosmosAsyncDatabase in the Azure Cosmos database service.
- CosmosDatabaseProperties(String) - Constructor for class com.azure.cosmos.models.CosmosDatabaseProperties
-
Constructor
- CosmosDatabaseRequestOptions - Class in com.azure.cosmos.models
-
Encapsulates options that can be specified for a request issued to cosmos database.
- CosmosDatabaseRequestOptions() - Constructor for class com.azure.cosmos.models.CosmosDatabaseRequestOptions
- CosmosDatabaseResponse - Class in com.azure.cosmos.models
-
The type Cosmos database response.
- CosmosDiagnostics - Class in com.azure.cosmos
-
This class represents response diagnostic statistics associated with a request to Azure Cosmos DB
- CosmosDiagnosticsContext - Class in com.azure.cosmos
-
This class provides metadata for an operation in the Cosmos DB SDK that can be used by diagnostic handlers
- CosmosDiagnosticsHandler - Interface in com.azure.cosmos
-
And interface that can be implemented to add custom diagnostic processors
- CosmosDiagnosticsRequestEvent - Class in com.azure.cosmos
-
This class represents diagnostic information for different steps in the request pipeline when processing a data plane request (for example to issue a point operation against a certain replica).
- CosmosDiagnosticsRequestInfo - Class in com.azure.cosmos
-
This class represents diagnostic information for transport requests (calls to a replica in direct mode, calls to the Gateway for example to get metadata like physical addresses of replica for a partition.
- CosmosDiagnosticsThresholds - Class in com.azure.cosmos
-
This class describes the thresholds when more details diagnostics are emitted for an operation due to high latency, high RU consumption or high payload sizes.
- CosmosDiagnosticsThresholds() - Constructor for class com.azure.cosmos.CosmosDiagnosticsThresholds
-
Creates an instance of the CosmosDiagnosticsThresholds class with default values
- CosmosEndToEndOperationLatencyPolicyConfig - Class in com.azure.cosmos
-
Represents End to end operation latency policy config This enables requests to get cancelled by the client once the specified timeout is reached
- CosmosEndToEndOperationLatencyPolicyConfigBuilder - Class in com.azure.cosmos
-
Builder for CosmosEndToEndOperationLatencyPolicyConfig
- CosmosEndToEndOperationLatencyPolicyConfigBuilder(Duration) - Constructor for class com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfigBuilder
-
Create a builder for
CosmosEndToEndOperationLatencyPolicyConfig
with end to end operation timeout - CosmosException - Exception in com.azure.cosmos
-
This class defines a custom exception type for all operations on CosmosClient in the Azure Cosmos DB database service.
- CosmosException(int, CosmosError, Map<String, String>) - Constructor for exception com.azure.cosmos.CosmosException
-
Creates a new instance of the CosmosException class.
- CosmosException(int, Exception) - Constructor for exception com.azure.cosmos.CosmosException
-
Creates a new instance of the CosmosException class.
- CosmosException(int, String) - Constructor for exception com.azure.cosmos.CosmosException
-
Creates a new instance of the CosmosException class.
- CosmosException(int, String, Map<String, String>, Throwable) - Constructor for exception com.azure.cosmos.CosmosException
-
Creates a new instance of the CosmosException class.
- CosmosException(String, int, CosmosError, Map<String, String>) - Constructor for exception com.azure.cosmos.CosmosException
-
Creates a new instance of the CosmosException class.
- CosmosException(String, int, CosmosError, Map<String, String>, Throwable) - Constructor for exception com.azure.cosmos.CosmosException
-
Creates a new instance of the CosmosException class.
- CosmosException(String, Exception, Map<String, String>, int, String) - Constructor for exception com.azure.cosmos.CosmosException
-
Creates a new instance of the CosmosException class.
- CosmosExcludedRegions - Class in com.azure.cosmos
-
A class which encapsulates a set of excluded regions.
- CosmosExcludedRegions(Set<String>) - Constructor for class com.azure.cosmos.CosmosExcludedRegions
-
Instantiates
CosmosExcludedRegions
. - CosmosItemIdentity - Class in com.azure.cosmos.models
-
Encapsulates the PartitionKey/id tuple that uniquely identifies a CosmosItem
- CosmosItemIdentity(PartitionKey, String) - Constructor for class com.azure.cosmos.models.CosmosItemIdentity
-
Instantiates an instance of the CosmosItemIdentity class
- CosmosItemOperation - Interface in com.azure.cosmos.models
-
Encapsulates Cosmos Item Operation
- CosmosItemOperationType - Enum in com.azure.cosmos.models
-
Depicts type of Cosmos Item Operation
- CosmosItemRequestOptions - Class in com.azure.cosmos.models
-
Encapsulates options that can be specified for a request issued to cosmos Item.
- CosmosItemRequestOptions() - Constructor for class com.azure.cosmos.models.CosmosItemRequestOptions
-
Constructor
- CosmosItemResponse<T> - Class in com.azure.cosmos.models
-
The type Cosmos item response.
- CosmosItemSerializer - Class in com.azure.cosmos
-
The
CosmosItemSerializer
allows customizing the serialization of Cosmos Items - either to transform payload (for example wrap/unwrap in custom envelopes) or use custom serialization settings or json serializer stacks. - CosmosItemSerializer() - Constructor for class com.azure.cosmos.CosmosItemSerializer
-
Used to instantiate subclasses
- CosmosMetricCategory - Class in com.azure.cosmos.models
-
Categories for Cosmos DB client-side metrics
- CosmosMetricName - Class in com.azure.cosmos.models
-
Names of Cosmos DB client-side meters
- CosmosMetricTagName - Class in com.azure.cosmos.models
-
The tag names that can be used for Cosmos client-side meters.
- CosmosMicrometerMeterOptions - Class in com.azure.cosmos.models
-
Options of a Cosmos client-side meter that can be used to enable/disable it, change the percentile and histogram capturing (if percentiles are applicable for the meter) and allows suppressing tags that are not desired.
- CosmosMicrometerMeterOptions() - Constructor for class com.azure.cosmos.models.CosmosMicrometerMeterOptions
-
Instantiates new options for a specific Cosmos DB meter
- CosmosMicrometerMetricsOptions - Class in com.azure.cosmos.models
-
Micrometer-specific Azure Cosmos DB SDK metrics options
- CosmosMicrometerMetricsOptions() - Constructor for class com.azure.cosmos.models.CosmosMicrometerMetricsOptions
-
Instantiates new Micrometer-specific Azure Cosmos DB SDK metrics options
- CosmosOperationDetails - Class in com.azure.cosmos.models
-
Encapsulates the details of an operation and allows for overriding some properties in the internal request options.
- CosmosOperationPolicy - Interface in com.azure.cosmos
-
Represents a policy that can be used with
CosmosClientBuilder
to customize the request sent to Azure Cosmos DB. - CosmosPagedFlux<T> - Class in com.azure.cosmos.util
-
Cosmos implementation of
ContinuablePagedFlux
. - CosmosPagedIterable<T> - Class in com.azure.cosmos.util
-
Cosmos implementation of
ContinuablePagedIterable
. - CosmosPagedIterable(CosmosPagedFlux<T>) - Constructor for class com.azure.cosmos.util.CosmosPagedIterable
-
Creates instance given
CosmosPagedFlux
. - CosmosPagedIterable(CosmosPagedFlux<T>, int) - Constructor for class com.azure.cosmos.util.CosmosPagedIterable
-
Creates instance given
CosmosPagedFlux
. - CosmosPagedIterable(CosmosPagedFlux<T>, int, int) - Constructor for class com.azure.cosmos.util.CosmosPagedIterable
-
Creates instance given
CosmosPagedFlux
. - CosmosPatchItemRequestOptions - Class in com.azure.cosmos.models
-
Encapsulates options for
CosmosPatchOperations
- CosmosPatchItemRequestOptions() - Constructor for class com.azure.cosmos.models.CosmosPatchItemRequestOptions
-
Constructor
- CosmosPatchOperations - Class in com.azure.cosmos.models
-
Grammar is a super set of this RFC: https://tools.ietf.org/html/rfc6902#section-4.1 Contains a list of Patch operations to be applied on an item.
- CosmosPermissionProperties - Class in com.azure.cosmos.models
-
The type Cosmos permission properties.
- CosmosPermissionProperties() - Constructor for class com.azure.cosmos.models.CosmosPermissionProperties
-
Initialize a permission object.
- CosmosPermissionRequestOptions - Class in com.azure.cosmos.models
-
Contains the request options of CosmosAsyncPermission
- CosmosPermissionRequestOptions() - Constructor for class com.azure.cosmos.models.CosmosPermissionRequestOptions
- CosmosPermissionResponse - Class in com.azure.cosmos.models
-
The type Cosmos permission response.
- CosmosQueryRequestOptions - Class in com.azure.cosmos.models
-
Specifies the options associated with query methods (enumeration operations) in the Azure Cosmos DB database service.
- CosmosQueryRequestOptions() - Constructor for class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Instantiates a new query request options.
- CosmosReadManyRequestOptions - Class in com.azure.cosmos.models
-
Specifies the options associated with read many operation in the Azure Cosmos DB database service.
- CosmosReadManyRequestOptions() - Constructor for class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Instantiates a new read many request options.
- CosmosRegionSwitchHint - Class in com.azure.cosmos
-
CosmosRegionSwitchHint
encapsulates hints which guide SDK-internal retry policies on how early to switch retries to a different region. - CosmosRequestContext - Class in com.azure.cosmos
-
Getters for the common request context for operations in CosmosDB.
- CosmosRequestOptions - Class in com.azure.cosmos.models
-
The common request options for operations.
- CosmosRequestOptions() - Constructor for class com.azure.cosmos.models.CosmosRequestOptions
- CosmosResponse<T> - Class in com.azure.cosmos.models
-
The cosmos response
- CosmosScripts - Class in com.azure.cosmos
-
The type Cosmos sync scripts.
- CosmosStoredProcedure - Class in com.azure.cosmos
-
The type Cosmos sync stored procedure.
- CosmosStoredProcedure(String, CosmosContainer, CosmosAsyncStoredProcedure) - Constructor for class com.azure.cosmos.CosmosStoredProcedure
-
Instantiates a new Cosmos sync stored procedure.
- CosmosStoredProcedureProperties - Class in com.azure.cosmos.models
-
Represents a stored procedure in the Azure Cosmos DB database service.
- CosmosStoredProcedureProperties(String, String) - Constructor for class com.azure.cosmos.models.CosmosStoredProcedureProperties
-
Constructor.
- CosmosStoredProcedureRequestOptions - Class in com.azure.cosmos.models
-
Encapsulates options that can be specified for a request issued to cosmos stored procedure.
- CosmosStoredProcedureRequestOptions() - Constructor for class com.azure.cosmos.models.CosmosStoredProcedureRequestOptions
- CosmosStoredProcedureResponse - Class in com.azure.cosmos.models
-
The type Cosmos stored procedure response.
- CosmosTrigger - Class in com.azure.cosmos
-
The type Cosmos sync trigger.
- CosmosTriggerProperties - Class in com.azure.cosmos.models
-
The type Cosmos trigger properties.
- CosmosTriggerProperties(String, String) - Constructor for class com.azure.cosmos.models.CosmosTriggerProperties
-
Constructor.
- CosmosTriggerResponse - Class in com.azure.cosmos.models
-
The type Cosmos trigger response.
- CosmosUser - Class in com.azure.cosmos
-
The type Cosmos sync user.
- CosmosUserDefinedFunction - Class in com.azure.cosmos
-
The type Cosmos sync user defined function.
- CosmosUserDefinedFunctionProperties - Class in com.azure.cosmos.models
-
The type Cosmos user defined function properties.
- CosmosUserDefinedFunctionProperties(String, String) - Constructor for class com.azure.cosmos.models.CosmosUserDefinedFunctionProperties
-
Constructor.
- CosmosUserDefinedFunctionResponse - Class in com.azure.cosmos.models
-
The type Cosmos user defined function response.
- CosmosUserProperties - Class in com.azure.cosmos.models
-
The Cosmos user properties.
- CosmosUserProperties() - Constructor for class com.azure.cosmos.models.CosmosUserProperties
-
Initialize a user object.
- CosmosUserResponse - Class in com.azure.cosmos.models
-
The type Cosmos user response.
- CosmosVectorDataType - Enum in com.azure.cosmos.models
-
Data types for the embeddings in Cosmos DB database service.
- CosmosVectorDistanceFunction - Enum in com.azure.cosmos.models
-
Distance Function for the embeddings in the Cosmos DB database service.
- CosmosVectorEmbedding - Class in com.azure.cosmos.models
-
Embedding settings within
CosmosVectorEmbeddingPolicy
- CosmosVectorEmbedding() - Constructor for class com.azure.cosmos.models.CosmosVectorEmbedding
-
Constructor
- CosmosVectorEmbeddingPolicy - Class in com.azure.cosmos.models
-
Vector Embedding Policy
- CosmosVectorEmbeddingPolicy() - Constructor for class com.azure.cosmos.models.CosmosVectorEmbeddingPolicy
-
Constructor
- CosmosVectorIndexSpec - Class in com.azure.cosmos.models
-
Vector Indexes spec for Azure CosmosDB service.
- CosmosVectorIndexSpec() - Constructor for class com.azure.cosmos.models.CosmosVectorIndexSpec
-
Constructor
- CosmosVectorIndexType - Enum in com.azure.cosmos.models
-
Defines the index type of vector index specification in the Azure Cosmos DB service.
- create() - Static method in class com.azure.cosmos.models.CosmosPatchOperations
-
Initializes a new instance of
CosmosPatchOperations
that will contain operations to be performed on a item atomically. - CREATE - Enum constant in enum com.azure.cosmos.models.ChangeFeedOperationType
-
Represents Create operation
- CREATE - Enum constant in enum com.azure.cosmos.models.CosmosItemOperationType
-
Create operation type.
- CREATE - Enum constant in enum com.azure.cosmos.models.TriggerOperation
-
CREATE operations only.
- createAllVersionsAndDeletesPolicy(Duration) - Static method in class com.azure.cosmos.models.ChangeFeedPolicy
-
Creates a ChangeFeedPolicy with retention duration for AllVersionsAndDeletes processing
- createAutoscaledThroughput(int) - Static method in class com.azure.cosmos.models.ThroughputProperties
-
Create auto scaled provisioned throughput throughput properties.
- createClientEncryptionKey(CosmosClientEncryptionKeyProperties) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Creates a client encryption key after subscription the operation will be performed.
- createContainer(CosmosContainerProperties) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Creates a Cosmos container.
- createContainer(CosmosContainerProperties) - Method in class com.azure.cosmos.CosmosDatabase
-
Creates a Cosmos container.
- createContainer(CosmosContainerProperties, CosmosContainerRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Creates a Cosmos container.
- createContainer(CosmosContainerProperties, CosmosContainerRequestOptions) - Method in class com.azure.cosmos.CosmosDatabase
-
Creates a Cosmos container while passing additional request options.
- createContainer(CosmosContainerProperties, ThroughputProperties) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Creates a Cosmos container with custom throughput properties.
- createContainer(CosmosContainerProperties, ThroughputProperties) - Method in class com.azure.cosmos.CosmosDatabase
-
Creates a Cosmos container with custom throughput setting.
- createContainer(CosmosContainerProperties, ThroughputProperties, CosmosContainerRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Creates a container.
- createContainer(CosmosContainerProperties, ThroughputProperties, CosmosContainerRequestOptions) - Method in class com.azure.cosmos.CosmosDatabase
-
Creates a Cosmos container.
- createContainer(String, String) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Creates a Cosmos container.
- createContainer(String, String) - Method in class com.azure.cosmos.CosmosDatabase
-
Create a Cosmos container.
- createContainer(String, String, ThroughputProperties) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Creates a Cosmos container.
- createContainer(String, String, ThroughputProperties) - Method in class com.azure.cosmos.CosmosDatabase
-
Create a Cosmos container.
- createContainerIfNotExists(CosmosContainerProperties) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Creates a Cosmos container if it does not exist on the service.
- createContainerIfNotExists(CosmosContainerProperties) - Method in class com.azure.cosmos.CosmosDatabase
-
Create container if one matching the id in the properties object does not exist.
- createContainerIfNotExists(CosmosContainerProperties, ThroughputProperties) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Creates a Cosmos container if it does not exist on the service.
- createContainerIfNotExists(CosmosContainerProperties, ThroughputProperties) - Method in class com.azure.cosmos.CosmosDatabase
-
Creates a Cosmos container if one matching the id in the properties object does not exist.
- createContainerIfNotExists(String, String) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Creates a Cosmos container if it does not exist on the service.
- createContainerIfNotExists(String, String) - Method in class com.azure.cosmos.CosmosDatabase
-
Creates a Cosmos container if one matching the id does not exist.
- createContainerIfNotExists(String, String, ThroughputProperties) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Creates a Cosmos container if it does not exist on the service.
- createContainerIfNotExists(String, String, ThroughputProperties) - Method in class com.azure.cosmos.CosmosDatabase
-
Creates a Cosmos container if one matching the id does not exist.
- createCosmosBatch(PartitionKey) - Static method in class com.azure.cosmos.models.CosmosBatch
-
Initializes a new instance of
CosmosBatch
that will contain operations to be performed across multiple items in the container with the provided partition key in a transactional manner - createCustomPolicy() - Static method in class com.azure.cosmos.models.ConflictResolutionPolicy
-
Creates a CUSTOM
ConflictResolutionPolicy
without anyStoredProcedure
. - createCustomPolicy(String) - Static method in class com.azure.cosmos.models.ConflictResolutionPolicy
-
Creates a CUSTOM
ConflictResolutionPolicy
which uses the specified stored procedure to perform conflict resolution - createCustomPolicy(String, String, String) - Static method in class com.azure.cosmos.models.ConflictResolutionPolicy
-
Creates a CUSTOM
ConflictResolutionPolicy
which uses the specified stored procedure to perform conflict resolution - createDatabase(CosmosDatabaseProperties) - Method in class com.azure.cosmos.CosmosAsyncClient
-
Creates a database.
- createDatabase(CosmosDatabaseProperties) - Method in class com.azure.cosmos.CosmosClient
-
Creates a Cosmos database.
- createDatabase(CosmosDatabaseProperties, CosmosDatabaseRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncClient
-
Creates a database.
- createDatabase(CosmosDatabaseProperties, CosmosDatabaseRequestOptions) - Method in class com.azure.cosmos.CosmosClient
-
Creates a database.
- createDatabase(CosmosDatabaseProperties, ThroughputProperties) - Method in class com.azure.cosmos.CosmosAsyncClient
-
Creates a database.
- createDatabase(CosmosDatabaseProperties, ThroughputProperties) - Method in class com.azure.cosmos.CosmosClient
-
Creates a Cosmos database.
- createDatabase(CosmosDatabaseProperties, ThroughputProperties, CosmosDatabaseRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncClient
-
Creates a database.
- createDatabase(CosmosDatabaseProperties, ThroughputProperties, CosmosDatabaseRequestOptions) - Method in class com.azure.cosmos.CosmosClient
-
Creates a Cosmos database.
- createDatabase(String) - Method in class com.azure.cosmos.CosmosAsyncClient
-
Creates a database.
- createDatabase(String) - Method in class com.azure.cosmos.CosmosClient
-
Creates a Cosmos database.
- createDatabase(String, ThroughputProperties) - Method in class com.azure.cosmos.CosmosAsyncClient
-
Creates a database.
- createDatabase(String, ThroughputProperties) - Method in class com.azure.cosmos.CosmosClient
-
Creates a Cosmos database.
- createDatabaseIfNotExists(CosmosDatabaseProperties) - Method in class com.azure.cosmos.CosmosAsyncClient
-
CREATE a Database if it does not already exist on the service.
- createDatabaseIfNotExists(String) - Method in class com.azure.cosmos.CosmosAsyncClient
-
Create a Database if it does not already exist on the service.
- createDatabaseIfNotExists(String) - Method in class com.azure.cosmos.CosmosClient
-
Create a Cosmos database if it does not already exist on the service.
- createDatabaseIfNotExists(String, ThroughputProperties) - Method in class com.azure.cosmos.CosmosAsyncClient
-
Create a Database if it does not already exist on the service.
- createDatabaseIfNotExists(String, ThroughputProperties) - Method in class com.azure.cosmos.CosmosClient
-
Create a Cosmos database if it does not already exist on the service.
- createForProcessingFromBeginning(FeedRange) - Static method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Creates a new
CosmosChangeFeedRequestOptions
instance to start processing change feed items from the beginning of the change feed - createForProcessingFromContinuation(String) - Static method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Creates a new
CosmosChangeFeedRequestOptions
instance to start processing change feed items from a previous continuation - createForProcessingFromNow(FeedRange) - Static method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Creates a new
CosmosChangeFeedRequestOptions
instance to start processing change feed items from the current time - so only events for all future changes will be retrieved - createForProcessingFromPointInTime(Instant, FeedRange) - Static method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Creates a new
CosmosChangeFeedRequestOptions
instance to start processing change feed items from a certain point in time - createFullFidelityPolicy(Duration) - Static method in class com.azure.cosmos.models.ChangeFeedPolicy
-
Deprecated.
- createGlobalThroughputControlConfigBuilder(String, String) - Method in class com.azure.cosmos.CosmosAsyncClient
-
Create global throughput control config builder which will be used to build
GlobalThroughputControlConfig
. - createGlobalThroughputControlConfigBuilder(String, String) - Method in class com.azure.cosmos.CosmosClient
-
Create global throughput control config builder which will be used to build
GlobalThroughputControlConfig
. - createIncrementalPolicy() - Static method in class com.azure.cosmos.models.ChangeFeedPolicy
-
Deprecated.use
ChangeFeedPolicy.createLatestVersionPolicy()
instead. - createItem(T) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Creates an item.
- createItem(T) - Method in class com.azure.cosmos.CosmosContainer
-
Creates a new item synchronously and returns its respective Cosmos item response.
- createItem(T, CosmosItemRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Creates a Cosmos item.
- createItem(T, CosmosItemRequestOptions) - Method in class com.azure.cosmos.CosmosContainer
-
Creates a new item synchronously and returns its respective Cosmos item response while specifying additional options.
- createItem(T, PartitionKey, CosmosItemRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Creates an item.
- createItem(T, PartitionKey, CosmosItemRequestOptions) - Method in class com.azure.cosmos.CosmosContainer
-
Creates a new item synchronously and returns its respective Cosmos item response while specifying additional options.
- createItemOperation(T) - Method in class com.azure.cosmos.models.CosmosBatch
-
Adds an operation to create an item into the batch.
- createItemOperation(T, CosmosBatchItemRequestOptions) - Method in class com.azure.cosmos.models.CosmosBatch
-
Adds an operation to create an item into the batch.
- createLastWriterWinsPolicy() - Static method in class com.azure.cosmos.models.ConflictResolutionPolicy
-
Creates a LAST_WRITER_WINS
ConflictResolutionPolicy
with "/_ts" as the resolution path. - createLastWriterWinsPolicy(String) - Static method in class com.azure.cosmos.models.ConflictResolutionPolicy
-
Creates a LAST_WRITER_WINS
ConflictResolutionPolicy
with path as the resolution path. - createLatestVersionPolicy() - Static method in class com.azure.cosmos.models.ChangeFeedPolicy
-
Creates a default ChangeFeedPolicy without retention duration specified.
- createManualThroughput(int) - Static method in class com.azure.cosmos.models.ThroughputProperties
-
Create fixed throughput properties.
- createPermission(CosmosPermissionProperties, CosmosPermissionRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncUser
-
Creates a permission.
- createStoredProcedure(CosmosStoredProcedureProperties) - Method in class com.azure.cosmos.CosmosAsyncScripts
-
Creates a cosmos stored procedure.
- createStoredProcedure(CosmosStoredProcedureProperties) - Method in class com.azure.cosmos.CosmosScripts
-
Create stored procedure
- createStoredProcedure(CosmosStoredProcedureProperties, CosmosStoredProcedureRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncScripts
-
Creates a cosmos stored procedure.
- createStoredProcedure(CosmosStoredProcedureProperties, CosmosStoredProcedureRequestOptions) - Method in class com.azure.cosmos.CosmosScripts
-
Create stored procedure cosmos
- createTrigger(CosmosTriggerProperties) - Method in class com.azure.cosmos.CosmosAsyncScripts
-
Creates a Cosmos trigger.
- createTrigger(CosmosTriggerProperties) - Method in class com.azure.cosmos.CosmosScripts
-
Create trigger
- createUser(CosmosUserProperties) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Creates a user After subscription the operation will be performed.
- createUser(CosmosUserProperties) - Method in class com.azure.cosmos.CosmosDatabase
-
Create Cosmos user.
- createUserDefinedFunction(CosmosUserDefinedFunctionProperties) - Method in class com.azure.cosmos.CosmosAsyncScripts
-
Creates a cosmos user defined function.
- createUserDefinedFunction(CosmosUserDefinedFunctionProperties) - Method in class com.azure.cosmos.CosmosScripts
-
Create user defined function
- credential(AzureKeyCredential) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the
AzureKeyCredential
to be used - credential(TokenCredential) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the
TokenCredential
used to authorize requests sent to the service. - CUSTOM - Enum constant in enum com.azure.cosmos.models.ConflictResolutionMode
-
CUSTOM conflict resolution mode
- customItemSerializer(CosmosItemSerializer) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets a custom serializer that should be used for conversion between POJOs and Json payload stored in the Cosmos DB service.
D
- DedicatedGatewayRequestOptions - Class in com.azure.cosmos.models
-
Dedicated Gateway Request Options
- DedicatedGatewayRequestOptions() - Constructor for class com.azure.cosmos.models.DedicatedGatewayRequestOptions
-
Constructor
- DEFAULT - Enum constant in enum com.azure.cosmos.models.IndexingDirective
-
Use any pre-defined/pre-configured defaults.
- DEFAULT - Static variable in class com.azure.cosmos.models.CosmosMetricCategory
-
Default metrics (categories OperationSummary, RequestSummary, System, DirectChannels and DirectRequests) enabled.
- DEFAULT - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
Default tags
- DEFAULT_ACQUIRE_INTERVAL - Static variable in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Default acquire interval.
- DEFAULT_EXPIRATION_INTERVAL - Static variable in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Default expiration interval.
- DEFAULT_FEED_POLL_DELAY - Static variable in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Default feed poll delay.
- DEFAULT_LOGGING_HANDLER - Static variable in interface com.azure.cosmos.CosmosDiagnosticsHandler
-
A Cosmos diagnostics handler which will log operations to log4j - Failures (contains diagnostics string) --> Error - Threshold violations (contains diagnostics string) --> Info - Successful operations --> Debug If Trace level is enabled also, the diagnostics string will be logged for successful operations.
- DEFAULT_NON_POINT_OPERATION_LATENCY_THRESHOLD - Static variable in class com.azure.cosmos.CosmosDiagnosticsThresholds
-
The default latency threshold to determine whether to include request diagnostics or not for non-point operations
- DEFAULT_PAYLOAD_SIZE_THRESHOLD_IN_BYTES - Static variable in class com.azure.cosmos.CosmosDiagnosticsThresholds
-
The default payload size (in bytes) threshold to determine whether to include request diagnostics or not
- DEFAULT_POINT_OPERATION_LATENCY_THRESHOLD - Static variable in class com.azure.cosmos.CosmosDiagnosticsThresholds
-
The default latency threshold to determine whether to include request diagnostics or not for point operations
- DEFAULT_RENEW_INTERVAL - Static variable in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Default renew interval.
- DEFAULT_REQUEST_CHARGE_THRESHOLD - Static variable in class com.azure.cosmos.CosmosDiagnosticsThresholds
-
The default request charge (RU) threshold to determine whether to include request diagnostics or not
- DEFAULT_SERIALIZER - Static variable in class com.azure.cosmos.CosmosItemSerializer
-
Gets the default Cosmos item serializer.
- defaultControlGroup(boolean) - Method in class com.azure.cosmos.ThroughputControlGroupConfigBuilder
-
Set whether this throughput control group will be used by default.
- delete() - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Deletes the current container.
- delete() - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Deletes the current Cosmos database.
- delete() - Method in class com.azure.cosmos.CosmosAsyncStoredProcedure
-
Deletes a stored procedure
- delete() - Method in class com.azure.cosmos.CosmosAsyncTrigger
-
Deletes a cosmos trigger.
- delete() - Method in class com.azure.cosmos.CosmosAsyncUser
-
Delete a cosmos user
- delete() - Method in class com.azure.cosmos.CosmosAsyncUserDefinedFunction
-
Deletes a cosmos user defined function.
- delete() - Method in class com.azure.cosmos.CosmosContainer
-
Deletes the current cosmos container.
- delete() - Method in class com.azure.cosmos.CosmosDatabase
-
Deletes the current Cosmos database.
- delete() - Method in class com.azure.cosmos.CosmosStoredProcedure
-
Delete cosmos stored procedure.
- delete() - Method in class com.azure.cosmos.CosmosTrigger
-
Delete cosmos trigger.
- delete() - Method in class com.azure.cosmos.CosmosUser
-
Delete cosmos user.
- delete() - Method in class com.azure.cosmos.CosmosUserDefinedFunction
-
Delete cosmos user defined function.
- delete(CosmosConflictRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncConflict
-
Deletes a conflict.
- delete(CosmosContainerRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Deletes the container
- delete(CosmosContainerRequestOptions) - Method in class com.azure.cosmos.CosmosContainer
-
Deletes the current Cosmos container while specifying additional options such as If-Match.
- delete(CosmosDatabaseRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Deletes the current Cosmos database while specifying additional request options.
- delete(CosmosDatabaseRequestOptions) - Method in class com.azure.cosmos.CosmosDatabase
-
Delete the current Cosmos database while specifying additional request options.
- delete(CosmosPermissionRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncPermission
-
Deletes a permission.
- delete(CosmosStoredProcedureRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncStoredProcedure
-
Deletes a stored procedure
- DELETE - Enum constant in enum com.azure.cosmos.models.ChangeFeedOperationType
-
Represents Delete operation
- DELETE - Enum constant in enum com.azure.cosmos.models.CosmosItemOperationType
-
Delete operation type.
- DELETE - Enum constant in enum com.azure.cosmos.models.TriggerOperation
-
DELETE operations only.
- deleteAllItemsByPartitionKey(PartitionKey, CosmosItemRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Deletes all items in the Container with the specified partitionKey value.
- deleteAllItemsByPartitionKey(PartitionKey, CosmosItemRequestOptions) - Method in class com.azure.cosmos.CosmosContainer
-
Deletes all items in the Container with the specified partitionKey value.
- deleteItem(String, PartitionKey) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Deletes an item.
- deleteItem(String, PartitionKey, CosmosItemRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Deletes the item.
- deleteItem(String, PartitionKey, CosmosItemRequestOptions) - Method in class com.azure.cosmos.CosmosContainer
-
Deletes an item in the current container.
- deleteItem(T, CosmosItemRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Deletes the item.
- deleteItem(T, CosmosItemRequestOptions) - Method in class com.azure.cosmos.CosmosContainer
-
Deletes an item in the current container.
- deleteItemOperation(String) - Method in class com.azure.cosmos.models.CosmosBatch
-
Adds an operation to delete an item into the batch.
- deleteItemOperation(String, CosmosBatchItemRequestOptions) - Method in class com.azure.cosmos.models.CosmosBatch
-
Adds an operation to delete an item into the batch.
- DESCENDING - Enum constant in enum com.azure.cosmos.models.CompositePathSortOrder
-
DESCENDING sort order for composite paths.
- deserialize(Map<String, Object>, Class<T>) - Method in class com.azure.cosmos.CosmosItemSerializer
-
Used to deserialize the json tree stored in the Cosmos DB item as a POJO
- diagnosticsHandler(CosmosDiagnosticsHandler) - Method in class com.azure.cosmos.models.CosmosClientTelemetryConfig
-
Injects a custom diagnostics handler
- diagnosticsThresholds(CosmosDiagnosticsThresholds) - Method in class com.azure.cosmos.models.CosmosClientTelemetryConfig
-
Request diagnostics for operations will be logged if their latency, request charge or payload size exceeds one of the defined thresholds.
- DIRECT - Enum constant in enum com.azure.cosmos.ConnectionMode
-
Specifies that requests to server resources are made directly to the data nodes.
- DIRECT_ADDRESS_RESOLUTION_LATENCY - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Latency of the RNTBD address resolution request (Timer)
- DIRECT_ADDRESS_RESOLUTION_REQUESTS - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Number of RNTBD address resolution requests (Counter)
- DIRECT_ADDRESS_RESOLUTIONS - Static variable in class com.azure.cosmos.models.CosmosMetricCategory
-
The metrics in the AddressResolutions category emit metrics for calls made to get replica addresses for a certain physical partition when using direct mode.
- DIRECT_CHANNELS - Static variable in class com.azure.cosmos.models.CosmosMetricCategory
-
The metrics in the DirectChannels category emit metrics allowing to monitor connection handling by service endpoint.
- DIRECT_CHANNELS_ACQUIRED_COUNT - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Number of acquired channels (new connections) for this endpoint (FunctionCounter)
- DIRECT_CHANNELS_AVAILABLE_COUNT - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Snapshot of the number of available channels (active connections) for this endpoint (Gauge)
- DIRECT_CHANNELS_CLOSED_COUNT - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Number of closed channels / connections for this endpoint (FunctionCounter)
- DIRECT_ENDPOINTS - Static variable in class com.azure.cosmos.models.CosmosMetricCategory
-
The metrics in the DirectEndpoints category emit metrics allowing to monitor state by service endpoint.
- DIRECT_ENDPOINTS_COUNT - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Snapshot of the number of endpoints (Gauge)
- DIRECT_ENDPOINTS_EVICTED - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Number of evicted/closed endpoints (FunctionCounter)
- DIRECT_REQUEST_CONCURRENT_COUNT - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Snapshot of number of concurrent RNTBD requests for this endpoint (Gauge)
- DIRECT_REQUEST_LATENCY - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Latency of RNTBD requests for this endpoint (Timer)
- DIRECT_REQUEST_LATENCY_FAILED - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Latency of failed RNTBD requests for this endpoint (Timer)
- DIRECT_REQUEST_LATENCY_SUCCESS - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Latency of successful RNTBD requests for this endpoint (Timer)
- DIRECT_REQUEST_QUEUED_COUNT - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Snapshot of number of queued RNTBD requests for this endpoint (Gauge)
- DIRECT_REQUEST_SIZE_REQUEST - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Size of the request payload (DistributionSummary)
- DIRECT_REQUEST_SIZE_RESPONSE - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Size of the response payload (DistributionSummary)
- DIRECT_REQUESTS - Static variable in class com.azure.cosmos.models.CosmosMetricCategory
-
The metrics in the DirectRequests category emit metrics allowing to monitor requests by service endpoint (request rate, error rate, latency etc.).
- DirectConnectionConfig - Class in com.azure.cosmos
-
Represents the connection config with
ConnectionMode.DIRECT
associated with Cosmos Client in the Azure Cosmos DB database service. - DirectConnectionConfig() - Constructor for class com.azure.cosmos.DirectConnectionConfig
-
Constructor
- directMode() - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the default DIRECT connection configuration to be used.
- directMode(DirectConnectionConfig) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the DIRECT connection configuration to be used.
- directMode(DirectConnectionConfig, GatewayConnectionConfig) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the DIRECT connection configuration to be used.
- DISK_ANN - Enum constant in enum com.azure.cosmos.models.CosmosVectorIndexType
-
Represents a disk ANN vector index type.
- DOT_PRODUCT - Enum constant in enum com.azure.cosmos.models.CosmosVectorDistanceFunction
-
Represents the dot product distance function.
E
- enable(boolean) - Method in class com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfigBuilder
-
Enables or disables the policy.
- enableGlobalThroughputControlGroup(ThroughputControlGroupConfig, GlobalThroughputControlConfig) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Enable the throughput control group with global control mode.
- enableGlobalThroughputControlGroup(ThroughputControlGroupConfig, GlobalThroughputControlConfig) - Method in class com.azure.cosmos.CosmosContainer
-
Enable the throughput control group with global control mode.
- enableHistograms(boolean) - Method in class com.azure.cosmos.models.CosmosMicrometerMeterOptions
-
Sets the tags that should be used for this meter (when applicable)
- enableHistogramsByDefault(boolean) - Method in class com.azure.cosmos.models.CosmosMicrometerMetricsOptions
-
Sets a flag indicating whether by default histograms should be published for metrics (where applicable) unless overridden for a specific meter in its
CosmosMicrometerMeterOptions
By default histograms are published. - enableLocalThroughputControlGroup(ThroughputControlGroupConfig) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Enable the throughput control group with local control mode.
- enableLocalThroughputControlGroup(ThroughputControlGroupConfig) - Method in class com.azure.cosmos.CosmosContainer
-
Enable the throughput control group with local control mode.
- enableTransportLevelTracing() - Method in class com.azure.cosmos.models.CosmosClientTelemetryConfig
-
Enables transport level tracing.
- EncryptionKeyWrapMetadata - Class in com.azure.cosmos.models
-
Metadata that can be used to wrap/unwrap a Data Encryption Key using a Customer Managed Key.
- EncryptionKeyWrapMetadata() - Constructor for class com.azure.cosmos.models.EncryptionKeyWrapMetadata
-
For JSON deserialize
- EncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata) - Constructor for class com.azure.cosmos.models.EncryptionKeyWrapMetadata
-
Creates a new instance of key wrap metadata based on an existing instance.
- EncryptionKeyWrapMetadata(String, String, String) - Constructor for class com.azure.cosmos.models.EncryptionKeyWrapMetadata
-
Deprecated.
- EncryptionKeyWrapMetadata(String, String, String, String) - Constructor for class com.azure.cosmos.models.EncryptionKeyWrapMetadata
-
Creates a new instance of key wrap metadata based on an existing instance.
- endpoint(String) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the Azure Cosmos DB endpoint the SDK will connect to
- endpointDiscoveryEnabled(boolean) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the flag to enable endpoint discovery for geo-replicated database accounts.
- endToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the
CosmosEndToEndOperationLatencyPolicyConfig
on the client - equals(Object) - Method in class com.azure.cosmos.models.CompositePath
- equals(Object) - Method in class com.azure.cosmos.models.CosmosContainerIdentity
- equals(Object) - Method in class com.azure.cosmos.models.CosmosItemIdentity
- equals(Object) - Method in class com.azure.cosmos.models.CosmosMetricCategory
- equals(Object) - Method in class com.azure.cosmos.models.CosmosMetricName
- equals(Object) - Method in class com.azure.cosmos.models.CosmosMetricTagName
- equals(Object) - Method in class com.azure.cosmos.models.EncryptionKeyWrapMetadata
-
Returns whether the properties of the passed in key wrap metadata matches with those in the current instance.
- equals(Object) - Method in class com.azure.cosmos.models.ExcludedPath
- equals(Object) - Method in class com.azure.cosmos.models.IncludedPath
- equals(Object) - Method in class com.azure.cosmos.models.PartitionKey
-
Overrides the Equal operator for object comparisons between two instances of
PartitionKey
- equals(Object) - Method in class com.azure.cosmos.models.PriorityLevel
- equals(Object) - Method in class com.azure.cosmos.models.SqlParameter
- EUCLIDEAN - Enum constant in enum com.azure.cosmos.models.CosmosVectorDistanceFunction
-
Represents the euclidean distance function.
- EVENTUAL - Enum constant in enum com.azure.cosmos.ConsistencyLevel
-
EVENTUAL Consistency guarantees that reads will return a subset of writes.
- EXCLUDE - Enum constant in enum com.azure.cosmos.models.IndexingDirective
-
Do not index the resource.
- ExcludedPath - Class in com.azure.cosmos.models
-
Represents an excluded path of the IndexingPolicy in the Azure Cosmos DB database service.
- ExcludedPath(String) - Constructor for class com.azure.cosmos.models.ExcludedPath
-
Constructor.
- excludedRegionsSupplier(Supplier<CosmosExcludedRegions>) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets a
Supplier<CosmosExcludedRegions>
which returns aCosmosExcludedRegions
instance whenSupplier.get()
is invoked. - execute(List<Object>, CosmosStoredProcedureRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncStoredProcedure
-
Executes a stored procedure
- execute(List<Object>, CosmosStoredProcedureRequestOptions) - Method in class com.azure.cosmos.CosmosStoredProcedure
-
Execute cosmos sync stored procedure.
- executeBulkOperations(Iterable<CosmosItemOperation>) - Method in class com.azure.cosmos.CosmosContainer
-
Executes list of operations in Bulk.
- executeBulkOperations(Iterable<CosmosItemOperation>, CosmosBulkExecutionOptions) - Method in class com.azure.cosmos.CosmosContainer
-
Executes list of operations in Bulk.
- executeBulkOperations(Flux<CosmosItemOperation>) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Executes flux of operations in Bulk.
- executeBulkOperations(Flux<CosmosItemOperation>, CosmosBulkExecutionOptions) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Executes flux of operations in Bulk.
- executeCosmosBatch(CosmosBatch) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Executes the transactional batch.
- executeCosmosBatch(CosmosBatch) - Method in class com.azure.cosmos.CosmosContainer
-
Executes the transactional batch.
- executeCosmosBatch(CosmosBatch, CosmosBatchRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Executes the transactional batch.
- executeCosmosBatch(CosmosBatch, CosmosBatchRequestOptions) - Method in class com.azure.cosmos.CosmosContainer
-
Executes the transactional batch.
F
- feedContainer(CosmosAsyncContainer) - Method in class com.azure.cosmos.ChangeFeedProcessorBuilder
-
Sets and existing
CosmosAsyncContainer
to be used to read from the monitored container. - FeedRange - Interface in com.azure.cosmos.models
-
Represents a feed range.
- FeedResponse<T> - Class in com.azure.cosmos.models
-
The type Feed response.
- FLAT - Enum constant in enum com.azure.cosmos.models.CosmosVectorIndexType
-
Represents a flat vector index type.
- FLOAT16 - Enum constant in enum com.azure.cosmos.models.CosmosVectorDataType
-
Represents a float16 data type.
- FLOAT32 - Enum constant in enum com.azure.cosmos.models.CosmosVectorDataType
-
Represents a float32 data type.
- forFullRange() - Static method in interface com.azure.cosmos.models.FeedRange
-
Creates a range for an entire container
- forLogicalPartition(PartitionKey) - Static method in interface com.azure.cosmos.models.FeedRange
-
Creates a range for a certain logical partition
- fromItem(Map<String, Object>, PartitionKeyDefinition) - Static method in class com.azure.cosmos.models.PartitionKey
-
Returns the PartitionKey extracted from the item
- fromObjectArray(Object[], boolean) - Static method in class com.azure.cosmos.models.PartitionKey
-
Returns the PartitionKey from an array of objects that is generated by PartitionKeyInternal
- fromString(String) - Static method in class com.azure.cosmos.models.CosmosMetricCategory
-
Gets the corresponding metric category state from its string representation.
- fromString(String) - Static method in class com.azure.cosmos.models.CosmosMetricName
-
Gets the corresponding metric category state from its string representation.
- fromString(String) - Static method in class com.azure.cosmos.models.CosmosMetricTagName
-
Gets the corresponding metric category state from its string representation.
- fromString(String) - Static method in enum com.azure.cosmos.models.CosmosVectorDataType
-
Method to retrieve the enum constant by its overWireValue.
- fromString(String) - Static method in enum com.azure.cosmos.models.CosmosVectorDistanceFunction
-
Method to retrieve the enum constant by its overWireValue.
- fromString(String) - Static method in interface com.azure.cosmos.models.FeedRange
-
Creates a range from a previously obtained string representation.
- fromString(String) - Static method in class com.azure.cosmos.models.PriorityLevel
-
Gets the corresponding priority level from its string representation.
- fullFidelity() - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Deprecated.
G
- GATEWAY - Enum constant in enum com.azure.cosmos.ConnectionMode
-
Specifies that requests to server resources are made through a gateway proxy using HTTPS.
- GatewayConnectionConfig - Class in com.azure.cosmos
-
Represents the connection config with
ConnectionMode.GATEWAY
associated with Cosmos Client in the Azure Cosmos DB database service. - GatewayConnectionConfig() - Constructor for class com.azure.cosmos.GatewayConnectionConfig
-
Constructor.
- gatewayMode() - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the default GATEWAY connection configuration to be used.
- gatewayMode(GatewayConnectionConfig) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the GATEWAY connection configuration to be used.
- getAccountName() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The name of the account related to the operation
- getActivityId() - Method in class com.azure.cosmos.CosmosDiagnosticsRequestInfo
-
Gets the Activity used to track this request in the Cosmos DB service.
- getActivityId() - Method in exception com.azure.cosmos.CosmosException
-
Gets the activity ID associated with the request.
- getActivityId() - Method in class com.azure.cosmos.models.CosmosBatchResponse
-
Gets the activity ID that identifies the server request made to execute the batch.
- getActivityId() - Method in class com.azure.cosmos.models.CosmosBulkItemResponse
-
Gets the activity ID that identifies the server request made to execute this operation.
- getActivityId() - Method in class com.azure.cosmos.models.CosmosItemResponse
-
Gets the Activity ID for the request.
- getActivityId() - Method in class com.azure.cosmos.models.CosmosResponse
-
Gets the Activity ID for the request.
- getActivityId() - Method in class com.azure.cosmos.models.CosmosStoredProcedureResponse
-
Gets the Activity ID for the request.
- getActivityId() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the activity ID for the request.
- getActualItemCount() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The actual number of items returned by a feed operation
- getAlgorithm() - Method in class com.azure.cosmos.models.EncryptionKeyWrapMetadata
-
Serialized form of metadata.
- getAnalyticalStoreTimeToLiveInSeconds() - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Gets the analytical store time to live in seconds for items in a container from the Azure Cosmos DB service.
- getAuthorizationToken(String, String, String, Map<String, Object>) - Method in interface com.azure.cosmos.models.CosmosAuthorizationTokenResolver
-
This method will consume the request information and based on that it will generate the authorization token.
- getAutoscaleMaxThroughput() - Method in class com.azure.cosmos.models.ThroughputProperties
-
Gets max auto-scale throughput.
- getAvailabilityStrategy() - Method in class com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig
-
Gets the availability strategy to be used for the policy.
- getBackendLatency() - Method in class com.azure.cosmos.CosmosDiagnosticsRequestInfo
-
Gets the backend latency if available or null when backend latency isn't available for a request
- getBatchContext() - Method in class com.azure.cosmos.models.CosmosBulkOperationResponse
-
Gets the BatchContext
- getBody() - Method in class com.azure.cosmos.models.CosmosStoredProcedureProperties
-
Get the body of the stored procedure.
- getBody() - Method in class com.azure.cosmos.models.CosmosTriggerProperties
-
Get the body of the trigger.
- getBody() - Method in class com.azure.cosmos.models.CosmosUserDefinedFunctionProperties
-
Get the body of the user defined function.
- getCategory() - Method in class com.azure.cosmos.models.CosmosMetricName
-
Gets the meter category of the meter
- getChangeFeedMetaData() - Method in class com.azure.cosmos.models.ChangeFeedProcessorItem
-
Gets the change feed metadata.
- getChangeFeedPolicy() - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Gets the changeFeedPolicy for this container in the Azure Cosmos DB service.
- getClientEncryptionKey(String) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Gets a CosmosAsyncClientEncryptionKey object without making a service call
- getClientEncryptionKey(String) - Method in class com.azure.cosmos.CosmosDatabase
-
Gets a CosmosClientEncryptionKey object without making a service call
- getClientEncryptionKeyId() - Method in class com.azure.cosmos.models.ClientEncryptionIncludedPath
-
Gets the identifier of the Data Encryption Key to be used to encrypt the path.
- getClientEncryptionPolicy() - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Gets the ClientEncryptionPolicy that is used for encrypting item fields
- getCollectionQuota() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the maximum quota for container resources within an account from the Azure Cosmos DB service.
- getCollectionSizeQuota() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the maximum size of a container in kilobytes from the Azure Cosmos DB service.
- getCollectionSizeUsage() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the current size of a container in kilobytes from the Azure Cosmos DB service.
- getCollectionUsage() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the current number of container resources within the account from the Azure Cosmos DB service.
- getCompositeIndexes() - Method in class com.azure.cosmos.models.IndexingPolicy
-
Gets the composite indexes for additional indexes.
- getComputedProperties() - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Gets the computedProperties for this container in the Azure Cosmos DB service.
- getConflict(String) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Gets a
CosmosAsyncConflict
object using current container for context. - getConflictResolutionPath() - Method in class com.azure.cosmos.models.ConflictResolutionPolicy
-
Gets the path which is present in each item in the Azure Cosmos DB service for last writer wins conflict-resolution.
- getConflictResolutionPolicy() - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Gets the conflictResolutionPolicy that is used for resolving conflicting writes on items in different regions, in a container in the Azure Cosmos DB service.
- getConflictResolutionProcedure() - Method in class com.azure.cosmos.models.ConflictResolutionPolicy
-
Gets the
StoredProcedure
which is used for conflict resolution in the Azure Cosmos DB service. - getConflictResolutionTimestamp() - Method in class com.azure.cosmos.models.ChangeFeedMetaData
-
Gets the conflict resolution timestamp
- getConnectionMode() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
Returns the connection mode used in the client.
- getConnectTimeout() - Method in class com.azure.cosmos.DirectConnectionConfig
-
Gets the connect timeout for direct client, represents timeout for establishing connections with an endpoint.
- getConsistencyLevel() - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the consistency level.
- getConsistencyLevel() - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Gets the consistency level required for the request.
- getConsistencyLevel() - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Gets the consistency level required for the request.
- getConsistencyLevel() - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Gets the consistency level required for the request.
- getConsistencyLevel() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the consistency level.
- getContactedRegionNames() - Method in class com.azure.cosmos.CosmosDiagnostics
-
Regions contacted for this request
- getContactedRegionNames() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
Returns the set of contacted regions
- getContainer(String) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Gets a CosmosAsyncContainer object without making a service call
- getContainer(String) - Method in class com.azure.cosmos.CosmosDatabase
-
Gets a Cosmos container instance without making a service call.
- getContainerName() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The name of the container related to the operation
- getContainerName() - Method in class com.azure.cosmos.models.CosmosPermissionProperties
-
Gets the name of the Cosmos container as the parent resource which is associated with this permission object.
- getContext() - Method in interface com.azure.cosmos.models.CosmosItemOperation
- getContinuationToken() - Method in class com.azure.cosmos.models.ChangeFeedProcessorState
-
Gets a marker representing the last item that was processed.
- getContinuationToken() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the continuation token to be used for continuing the enumeration.
- getControlItemExpireInterval() - Method in class com.azure.cosmos.GlobalThroughputControlConfig
-
Get the control item expire interval.
- getControlItemRenewInterval() - Method in class com.azure.cosmos.GlobalThroughputControlConfig
-
Get the control item renew interval.
- getCorrelationActivityId() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the correlation activity ID for the responses of a query operation or null if no correlation activity id is present
- getCosmosContainerIdentities() - Method in class com.azure.cosmos.CosmosContainerProactiveInitConfig
-
Gets the list of container identities.
- getCosmosDiagnostics() - Method in class com.azure.cosmos.models.CosmosBulkItemResponse
-
Gets the cosmos diagnostic for this operation.
- getCosmosDiagnostics() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the feed response diagnostics
- getCosmosEndToEndLatencyPolicyConfig() - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the CosmosEndToEndLatencyPolicyConfig.
- getCosmosEndToEndLatencyPolicyConfig() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the CosmosEndToEndLatencyPolicyConfig.
- getCreateItemOperation(T, PartitionKey) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for Creating item in Bulk execution.
- getCreateItemOperation(T, PartitionKey, CosmosBulkItemRequestOptions) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for Creating item in Bulk execution.
- getCreateItemOperation(T, PartitionKey, CosmosBulkItemRequestOptions, TContext) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for Creating item in Bulk execution.
- getCreateItemOperation(T, PartitionKey, TContext) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for Creating item in Bulk execution.
- getCurrent() - Method in class com.azure.cosmos.models.ChangeFeedProcessorItem
-
Gets the change feed current item.
- getCurrentResourceQuotaUsage() - Method in class com.azure.cosmos.models.CosmosItemResponse
-
Gets the current size of this entity (in megabytes (MB) for server resources and in count for master resources)
- getCurrentResourceQuotaUsage() - Method in class com.azure.cosmos.models.CosmosResponse
-
Gets the current size of this entity (in megabytes (MB) for server resources and in count for master resources)
- getCurrentResourceQuotaUsage() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the current size of this entity from the Azure Cosmos DB service.
- getCurrentState() - Method in interface com.azure.cosmos.ChangeFeedProcessor
-
Returns a read only list of list of objects, each one represents one scoped worker item.
- getCustomItemSerializer() - Method in class com.azure.cosmos.models.CosmosBatchRequestOptions
-
Gets the custom item serializer defined for this instance of request options
- getCustomItemSerializer() - Method in class com.azure.cosmos.models.CosmosBulkExecutionOptions
-
Gets the custom item serializer defined for this instance of request options
- getCustomItemSerializer() - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Gets the custom item serializer defined for this instance of request options
- getCustomItemSerializer() - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Gets the custom item serializer defined for this instance of request options
- getCustomItemSerializer() - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Gets the custom item serializer defined for this instance of request options
- getCustomItemSerializer() - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Gets the custom item serializer defined for this instance of request options
- getDatabase() - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Gets the parent
CosmosAsyncDatabase
for the current container. - getDatabase(String) - Method in class com.azure.cosmos.CosmosAsyncClient
-
Gets a database object without making a service call.
- getDatabase(String) - Method in class com.azure.cosmos.CosmosClient
-
Gets the Cosmos database instance without making a service call.
- getDatabaseName() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The name of the database related to the operation
- getDatabaseQuota() - Method in class com.azure.cosmos.models.CosmosDatabaseResponse
-
Gets the Max Quota.
- getDatabaseQuota() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the maximum quota for database resources within the account from the Azure Cosmos DB service.
- getDatabaseUsage() - Method in class com.azure.cosmos.models.CosmosDatabaseResponse
-
Gets the current Usage.
- getDatabaseUsage() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the current number of database resources within the account from the Azure Cosmos DB service.
- getDataType() - Method in class com.azure.cosmos.models.CosmosVectorEmbedding
-
Gets the data type for the cosmosVectorEmbedding.
- getDedicatedGatewayRequestOptions() - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the dedicated gateway request options.
- getDedicatedGatewayRequestOptions() - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Gets the Dedicated Gateway Request Options
- getDedicatedGatewayRequestOptions() - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Gets the Dedicated Gateway Request Options
- getDedicatedGatewayRequestOptions() - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Gets the Dedicated Gateway Request Options
- getDedicatedGatewayRequestOptions() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the dedicated gateway request options.
- getDefaultConfig() - Static method in class com.azure.cosmos.DirectConnectionConfig
-
Gets the default DIRECT connection configuration.
- getDefaultConfig() - Static method in class com.azure.cosmos.GatewayConnectionConfig
-
Gets the default Gateway connection configuration.
- getDefaultTimeToLiveInSeconds() - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Gets the container's default time-to-live value.
- getDeleteItemOperation(String, PartitionKey) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for deleting item in Bulk execution.
- getDeleteItemOperation(String, PartitionKey, CosmosBulkItemRequestOptions) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for deleting item in Bulk execution.
- getDeleteItemOperation(String, PartitionKey, CosmosBulkItemRequestOptions, TContext) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for deleting item in Bulk execution.
- getDeleteItemOperation(String, PartitionKey, TContext) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for deleting item in Bulk execution.
- getDiagnostics() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The diagnostic records for service interactions within the scope of this SDK operation
- getDiagnostics() - Method in exception com.azure.cosmos.CosmosException
-
Gets the Cosmos Diagnostic Statistics associated with this exception.
- getDiagnostics() - Method in class com.azure.cosmos.models.CosmosBatchResponse
-
Gets the diagnostics information for the current request to Azure Cosmos DB service.
- getDiagnostics() - Method in class com.azure.cosmos.models.CosmosItemResponse
-
Gets the diagnostics information for the current request to Azure Cosmos DB service.
- getDiagnostics() - Method in class com.azure.cosmos.models.CosmosResponse
-
Gets the diagnostics information for the current request to Azure Cosmos DB service.
- getDiagnosticsContext() - Method in class com.azure.cosmos.CosmosDiagnostics
-
Returns the associated CosmosDiagnosticsContext or null if not associated with any context yet.
- getDiagnosticsContext() - Method in class com.azure.cosmos.models.CosmosOperationDetails
-
Gets the diagnostics context associated with an operation.
- getDiagnosticsThresholds() - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the diagnostics thresholds.
- getDiagnosticsThresholds() - Method in class com.azure.cosmos.models.CosmosBatchRequestOptions
-
Gets the diagnostic thresholds used as an override for a specific operation.
- getDiagnosticsThresholds() - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Gets the diagnostic thresholds used as an override for a specific operation.
- getDiagnosticsThresholds() - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Gets the diagnostic thresholds used as an override for a specific operation.
- getDiagnosticsThresholds() - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Gets the diagnostic thresholds used as an override for a specific operation.
- getDiagnosticsThresholds() - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Gets the diagnostic thresholds used as an override for a specific operation.
- getDiagnosticsThresholds() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the diagnostics thresholds.
- getDimensions() - Method in class com.azure.cosmos.models.CosmosVectorEmbedding
-
Gets the dimensions for the cosmosVectorEmbedding.
- getDistanceFunction() - Method in class com.azure.cosmos.models.CosmosVectorEmbedding
-
Gets the distanceFunction for the cosmosVectorEmbedding.
- getDocumentCountUsage() - Method in class com.azure.cosmos.models.FeedResponse
-
Current document count usage.
- getDocumentUsage() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the current size of the documents in a container in kilobytes from the Azure Cosmos DB service.
- getDuration() - Method in class com.azure.cosmos.CosmosDiagnostics
-
Retrieves duration related to the completion of the request.
- getDuration() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The total end-to-end duration of the operation.
- getDuration() - Method in class com.azure.cosmos.CosmosDiagnosticsRequestEvent
-
Gets the duration for the request pipeline event - or null when the pipeline event hasn't finished (yet).
- getDuration() - Method in class com.azure.cosmos.CosmosDiagnosticsRequestInfo
-
Gets the total duration for processing this request.
- getDuration() - Method in class com.azure.cosmos.models.CosmosBatchResponse
-
Gets the end-to-end request latency for the current request to Azure Cosmos DB service.
- getDuration() - Method in class com.azure.cosmos.models.CosmosBulkItemResponse
-
Gets the end-to-end request latency for the current request to Azure Cosmos DB service.
- getDuration() - Method in class com.azure.cosmos.models.CosmosItemResponse
-
Gets the end-to-end request latency for the current request to Azure Cosmos DB service.
- getDuration() - Method in class com.azure.cosmos.models.CosmosResponse
-
Gets the end-to-end request latency for the current request to Azure Cosmos DB service.
- getEffectiveConsistencyLevel() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The effective consistency level of the operation
- getElements() - Method in class com.azure.cosmos.models.FeedResponse
- getEncryptionAlgorithm() - Method in class com.azure.cosmos.models.ClientEncryptionIncludedPath
-
Gets the type of encryption algorithm to be performed.
- getEncryptionAlgorithm() - Method in class com.azure.cosmos.models.CosmosClientEncryptionKeyProperties
-
Gets the encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.
- getEncryptionKeyWrapMetadata() - Method in class com.azure.cosmos.models.CosmosClientEncryptionKeyProperties
-
Gets the metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.
- getEncryptionType() - Method in class com.azure.cosmos.models.ClientEncryptionIncludedPath
-
Gets the type of encryption to be performed.
- getEndToEndOperationTimeout() - Method in class com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig
-
Gets the defined end to end operatoin timeout
- getErrorMessage() - Method in class com.azure.cosmos.models.CosmosBatchResponse
-
Gets the reason for the failure of the batch request, if any, or
null
. - getEstimatedLag() - Method in interface com.azure.cosmos.ChangeFeedProcessor
-
Returns the current owner (host) and an approximation of the difference between the last processed item (defined by the state of the feed container) and the latest change in the container for each partition (lease item).
- getEstimatedLag() - Method in class com.azure.cosmos.models.ChangeFeedProcessorState
-
Gets an approximation of the difference between the last processed item in the feed container and the latest change recorded.
- getETag() - Method in class com.azure.cosmos.models.CosmosBatchOperationResult
-
Gets the entity tag associated with the current item.
- getETag() - Method in class com.azure.cosmos.models.CosmosBulkItemResponse
-
Gets the entity tag associated with the current item.
- getETag() - Method in class com.azure.cosmos.models.CosmosClientEncryptionKeyProperties
-
Get the entity tag associated with the resource.
- getETag() - Method in class com.azure.cosmos.models.CosmosConflictProperties
-
Get the entity tag associated with the resource.
- getETag() - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Get the entity tag associated with the resource.
- getETag() - Method in class com.azure.cosmos.models.CosmosDatabaseProperties
-
Get the entity tag associated with the resource.
- getETag() - Method in class com.azure.cosmos.models.CosmosItemResponse
-
Gets the ETag from the response headers.
- getETag() - Method in class com.azure.cosmos.models.CosmosPermissionProperties
-
Get the entity tag associated with the resource.
- getETag() - Method in class com.azure.cosmos.models.CosmosStoredProcedureProperties
-
Get the entity tag associated with the resource.
- getETag() - Method in class com.azure.cosmos.models.CosmosTriggerProperties
-
Get the entity tag associated with the resource.
- getETag() - Method in class com.azure.cosmos.models.CosmosUserDefinedFunctionProperties
-
Get the entity tag associated with the resource.
- getETag() - Method in class com.azure.cosmos.models.CosmosUserProperties
-
Get the entity tag associated with the resource.
- getETag() - Method in class com.azure.cosmos.models.ThroughputProperties
-
Get the entity tag associated with the resource.
- getEventName() - Method in class com.azure.cosmos.CosmosDiagnosticsRequestEvent
-
Gets the name of the request pipeline event.
- getException() - Method in class com.azure.cosmos.models.CosmosBulkOperationResponse
-
Gets the Exception
- getExcludedPaths() - Method in class com.azure.cosmos.models.IndexingPolicy
-
Gets the paths that are not indexed.
- getExcludedRegions() - Method in class com.azure.cosmos.CosmosExcludedRegions
-
Gets the immutable set of excluded regions.
- getExcludedRegions() - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the excluded regions.
- getExcludedRegions() - Method in class com.azure.cosmos.models.CosmosBatchRequestOptions
-
Gets the list of regions to be excluded for the request/retries.
- getExcludedRegions() - Method in class com.azure.cosmos.models.CosmosBulkExecutionOptions
-
Gets the list of regions to be excluded for the request/retries.
- getExcludedRegions() - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Gets the list of regions to be excluded for the request/retries.
- getExcludedRegions() - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Gets the list of regions to be excluded for the request/retries.
- getExcludedRegions() - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Gets the list of regions to exclude for the request/retries.
- getExcludedRegions() - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Gets the list of regions to exclude for the request/retries.
- getExcludedRegions() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the exclude regions.
- getFeedPollDelay() - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Gets the delay in between polling a partition for new changes on the feed, after all current changes are drained.
- getFeedPollThroughputControlGroupConfig() - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Get the feed pool throughput control config.
- getFeedRange() - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Gets the feed range.
- getFeedRange() - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Gets the
FeedRange
- getFeedRanges() - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Obtains a list of
FeedRange
that can be used to parallelize Feed operations. - getFeedRanges() - Method in class com.azure.cosmos.CosmosContainer
-
Obtains a list of
FeedRange
that can be used to parallelize Feed operations. - getFilterPredicate() - Method in class com.azure.cosmos.models.CosmosBatchPatchItemRequestOptions
-
Gets the FilterPredicate associated with the request in the Azure Cosmos DB service.
- getFilterPredicate() - Method in class com.azure.cosmos.models.CosmosBulkPatchItemRequestOptions
-
Gets the FilterPredicate associated with the request in the Azure Cosmos DB service.
- getFilterPredicate() - Method in class com.azure.cosmos.models.CosmosPatchItemRequestOptions
-
Gets the FilterPredicate associated with the request in the Azure Cosmos DB service.
- getFinalError() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The final error when the operation failed
- getFullFidelityRetentionDuration() - Method in class com.azure.cosmos.models.ChangeFeedPolicy
-
Deprecated.
- getGroupName() - Method in class com.azure.cosmos.ThroughputControlGroupConfig
-
Get the throughput control group name.
- getHostName() - Method in class com.azure.cosmos.models.ChangeFeedProcessorState
-
Gets the name of the host which operates on the lease item.
- getId() - Method in class com.azure.cosmos.CosmosAsyncClientEncryptionKey
-
Get the id of the
CosmosAsyncClientEncryptionKey
- getId() - Method in class com.azure.cosmos.CosmosAsyncConflict
-
Get the id of the
CosmosAsyncConflict
- getId() - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Get the id of the
CosmosAsyncContainer
. - getId() - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Get the id of the CosmosAsyncDatabase.
- getId() - Method in class com.azure.cosmos.CosmosAsyncPermission
-
Get the id of the
CosmosAsyncPermission
- getId() - Method in class com.azure.cosmos.CosmosAsyncStoredProcedure
-
Get the id of the
CosmosAsyncStoredProcedure
- getId() - Method in class com.azure.cosmos.CosmosAsyncTrigger
-
Get the id of the
CosmosAsyncTrigger
- getId() - Method in class com.azure.cosmos.CosmosAsyncUser
-
Get the id of the
CosmosAsyncUser
- getId() - Method in class com.azure.cosmos.CosmosAsyncUserDefinedFunction
-
Get the id of the
CosmosAsyncUserDefinedFunction
- getId() - Method in class com.azure.cosmos.CosmosClientEncryptionKey
-
Get the id of the
CosmosClientEncryptionKey
- getId() - Method in class com.azure.cosmos.CosmosContainer
-
Gets the current container id.
- getId() - Method in class com.azure.cosmos.CosmosDatabase
-
Get the id of the Cosmos database.
- getId() - Method in class com.azure.cosmos.CosmosStoredProcedure
-
Id string.
- getId() - Method in class com.azure.cosmos.CosmosTrigger
-
Gets getId.
- getId() - Method in class com.azure.cosmos.CosmosUser
-
Id string.
- getId() - Method in class com.azure.cosmos.CosmosUserDefinedFunction
-
Id string.
- getId() - Method in class com.azure.cosmos.models.CosmosClientEncryptionKeyProperties
-
Gets the name of the resource.
- getId() - Method in class com.azure.cosmos.models.CosmosConflictProperties
-
Gets the name of the resource.
- getId() - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Gets the name of the resource.
- getId() - Method in class com.azure.cosmos.models.CosmosDatabaseProperties
-
Gets the name of the resource.
- getId() - Method in class com.azure.cosmos.models.CosmosItemIdentity
-
Gets the id value uniquely identifying this item within the scope of a logical partition
- getId() - Method in interface com.azure.cosmos.models.CosmosItemOperation
- getId() - Method in class com.azure.cosmos.models.CosmosPermissionProperties
-
Gets the name of the resource.
- getId() - Method in class com.azure.cosmos.models.CosmosStoredProcedureProperties
-
Gets the name of the resource.
- getId() - Method in class com.azure.cosmos.models.CosmosTriggerProperties
-
Gets the name of the resource.
- getId() - Method in class com.azure.cosmos.models.CosmosUserDefinedFunctionProperties
-
Gets the name of the resource.
- getId() - Method in class com.azure.cosmos.models.CosmosUserProperties
-
Gets the name of the resource.
- getId() - Method in class com.azure.cosmos.models.ThroughputProperties
-
Gets the name of the resource.
- getIdleConnectionTimeout() - Method in class com.azure.cosmos.DirectConnectionConfig
-
Gets the idle connection timeout for direct client Default value is
Duration.ZERO
Direct client doesn't close a single connection to an endpoint by default unless specified. - getIdleConnectionTimeout() - Method in class com.azure.cosmos.GatewayConnectionConfig
-
Gets the value of the timeout for an idle connection, the default is 60 seconds.
- getIdleEndpointTimeout() - Method in class com.azure.cosmos.DirectConnectionConfig
-
Gets the idle endpoint timeout Default value is 1 hour.
- getIfMatchETag() - Method in class com.azure.cosmos.models.CosmosBatchItemRequestOptions
-
Gets the If-Match (ETag) associated with the operation in CosmosBatch.
- getIfMatchETag() - Method in class com.azure.cosmos.models.CosmosBatchPatchItemRequestOptions
-
Gets the If-Match (ETag) associated with the operation in CosmosBatch.
- getIfMatchETag() - Method in class com.azure.cosmos.models.CosmosBulkItemRequestOptions
-
Gets the If-Match (ETag) associated with the operation in
CosmosItemOperation
. - getIfMatchETag() - Method in class com.azure.cosmos.models.CosmosBulkPatchItemRequestOptions
-
Gets the If-Match (ETag) associated with the operation in
CosmosItemOperation
. - getIfMatchETag() - Method in class com.azure.cosmos.models.CosmosConflictRequestOptions
-
Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
- getIfMatchETag() - Method in class com.azure.cosmos.models.CosmosContainerRequestOptions
-
Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
- getIfMatchETag() - Method in class com.azure.cosmos.models.CosmosDatabaseRequestOptions
-
Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
- getIfMatchETag() - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
- getIfMatchETag() - Method in class com.azure.cosmos.models.CosmosPermissionRequestOptions
-
Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
- getIfMatchETag() - Method in class com.azure.cosmos.models.CosmosStoredProcedureRequestOptions
-
Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
- getIfNoneMatchETag() - Method in class com.azure.cosmos.models.CosmosBatchItemRequestOptions
-
Gets the If-None-Match (ETag) associated with the request in operation in CosmosBatch.
- getIfNoneMatchETag() - Method in class com.azure.cosmos.models.CosmosBatchPatchItemRequestOptions
-
Gets the If-None-Match (ETag) associated with the request in operation in CosmosBatch.
- getIfNoneMatchETag() - Method in class com.azure.cosmos.models.CosmosBulkItemRequestOptions
-
Gets the If-None-Match (ETag) associated with the request in operation in
CosmosItemOperation
. - getIfNoneMatchETag() - Method in class com.azure.cosmos.models.CosmosBulkPatchItemRequestOptions
-
Gets the If-None-Match (ETag) associated with the request in operation in
CosmosItemOperation
. - getIfNoneMatchETag() - Method in class com.azure.cosmos.models.CosmosConflictRequestOptions
-
Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
- getIfNoneMatchETag() - Method in class com.azure.cosmos.models.CosmosContainerRequestOptions
-
Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
- getIfNoneMatchETag() - Method in class com.azure.cosmos.models.CosmosDatabaseRequestOptions
-
Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
- getIfNoneMatchETag() - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
- getIfNoneMatchETag() - Method in class com.azure.cosmos.models.CosmosPermissionRequestOptions
-
Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
- getIfNoneMatchETag() - Method in class com.azure.cosmos.models.CosmosStoredProcedureRequestOptions
-
Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
- getIncludedPaths() - Method in class com.azure.cosmos.models.ClientEncryptionPolicy
-
Gets the list of paths of the item that need encryption along with path-specific settings.
- getIncludedPaths() - Method in class com.azure.cosmos.models.IndexingPolicy
-
Gets the paths that are chosen to be indexed by the user.
- getIndexingDirective() - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Gets the indexing directive (index, do not index etc).
- getIndexingMode() - Method in class com.azure.cosmos.models.IndexingPolicy
-
Gets the indexing mode (consistent or lazy).
- getIndexingPolicy() - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Gets the container's indexing policy.
- getIndexTransformationProgress() - Method in class com.azure.cosmos.models.CosmosContainerResponse
-
Gets the progress of an index transformation, if one is underway.
- getInitialMicroBatchSize() - Method in class com.azure.cosmos.models.CosmosBulkExecutionOptions
-
Gets the initial size of micro batches that will be sent to the backend.
- getItem() - Method in interface com.azure.cosmos.models.CosmosItemOperation
- getItem() - Method in class com.azure.cosmos.models.CosmosItemResponse
-
Gets the resource.
- getItem(Class<T>) - Method in class com.azure.cosmos.models.CosmosBatchOperationResult
-
Gets the item associated with the current result.
- getItem(Class<T>) - Method in class com.azure.cosmos.models.CosmosBulkItemResponse
-
Gets the item associated with the current result.
- getItem(Class<T>) - Method in class com.azure.cosmos.models.CosmosConflictProperties
-
Gets the conflicting resource in the Azure Cosmos DB service.
- getKeywordIdentifiers() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
Gets the custom ids.
- getKeywordIdentifiers() - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the keyword identifiers.
- getKeywordIdentifiers() - Method in class com.azure.cosmos.models.CosmosBatchRequestOptions
-
Gets the custom ids.
- getKeywordIdentifiers() - Method in class com.azure.cosmos.models.CosmosBulkExecutionOptions
-
Gets the custom ids.
- getKeywordIdentifiers() - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Gets the custom ids.
- getKeywordIdentifiers() - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Gets the custom ids.
- getKeywordIdentifiers() - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Gets the custom ids.
- getKeywordIdentifiers() - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Gets the custom ids.
- getKeywordIdentifiers() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the keywordIdentifiers.
- getKind() - Method in class com.azure.cosmos.models.PartitionKeyDefinition
-
Sets the partition algorithm used to calculate the partition id given a partition key.
- getLeaseAcquireInterval() - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Gets the interval to kick off a task to compute if partitions are distributed evenly among known host instances.
- getLeaseExpirationInterval() - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Gets the interval for which the lease is taken on a lease representing a partition.
- getLeasePrefix() - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Gets a prefix to be used as part of the lease ID.
- getLeaseRenewInterval() - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Gets the renew interval for all leases for partitions currently held by
ChangeFeedProcessor
instance. - getLeaseToken() - Method in interface com.azure.cosmos.ChangeFeedProcessorContext
-
Gets the lease token corresponding to the source of a batch of change feed documents.
- getLeaseToken() - Method in class com.azure.cosmos.models.ChangeFeedProcessorState
-
Gets the token of the lease item representing the persistent state of a change feed processor worker.
- getLogSequenceNumber() - Method in class com.azure.cosmos.models.ChangeFeedMetaData
-
Gets the current logical sequence number
- getManualThroughput() - Method in class com.azure.cosmos.models.ThroughputProperties
-
Gets offer throughput.
- getMaxBufferedItemCount() - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the max buffered item count.
- getMaxBufferedItemCount() - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Gets the maximum number of items that can be buffered client side during parallel query execution.
- getMaxBufferedItemCount() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the max buffered item count.
- getMaxConnectionPoolSize() - Method in class com.azure.cosmos.GatewayConnectionConfig
-
Gets the value of the connection pool size the client is using.
- getMaxConnectionsPerEndpoint() - Method in class com.azure.cosmos.DirectConnectionConfig
-
Gets the max connections per endpoint This represents the size of connection pool for a specific endpoint Default value is 130
- getMaxDegreeOfParallelism() - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the max degree of parallelism.
- getMaxDegreeOfParallelism() - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Gets the number of concurrent operations run client side during parallel query execution.
- getMaxDegreeOfParallelism() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the max degree of parallelism.
- getMaxIntegratedCacheStaleness() - Method in class com.azure.cosmos.models.DedicatedGatewayRequestOptions
-
Gets the staleness value associated with the request in the Azure CosmosDB service.
- getMaxItemCount() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The max.
- getMaxItemCount() - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the max item count.
- getMaxItemCount() - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Gets the maximum number of items to be returned in the enumeration operation in the Azure Cosmos DB service.
- getMaxItemCount() - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Gets the maximum number of items to be returned in the enumeration operation.
- getMaxItemCount() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the max item count.
- getMaxMicroBatchConcurrency() - Method in class com.azure.cosmos.models.CosmosBulkExecutionOptions
-
The maximum concurrency for executing requests for a partition key range.
- getMaxMicroBatchSize() - Method in class com.azure.cosmos.models.CosmosBulkExecutionOptions
-
The maximum batch size for bulk operations.
- getMaxPrefetchPageCount() - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the query name.
- getMaxPrefetchPageCount() - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Gets the maximum number of pages that will be prefetched from the backend asynchronously in the background.
- getMaxPrefetchPageCount() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the max prefetch page count.
- getMaxRequestPayloadSizeInBytes() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The max.
- getMaxRequestsPerConnection() - Method in class com.azure.cosmos.DirectConnectionConfig
-
Gets the max requests per connection This represents the number of requests that will be queued on a single connection for a specific endpoint Default value is 30
- getMaxResourceQuota() - Method in class com.azure.cosmos.models.CosmosItemResponse
-
Gets the maximum size limit for this entity (in megabytes (MB) for server resources and in count for master resources).
- getMaxResourceQuota() - Method in class com.azure.cosmos.models.CosmosResponse
-
Gets the maximum size limit for this entity (in megabytes (MB) for server resources and in count for master resources).
- getMaxResourceQuota() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the maximum size limit for this entity from the Azure Cosmos DB service.
- getMaxResponsePayloadSizeInBytes() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The max.
- getMaxRetryAttemptsOnThrottledRequests() - Method in class com.azure.cosmos.ThrottlingRetryOptions
-
Gets the maximum number of retries in the case where the request fails because the service has applied rate limiting on the client.
- getMaxRetryWaitTime() - Method in class com.azure.cosmos.ThrottlingRetryOptions
-
Gets the maximum retry duration.
- getMaxScaleCount() - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Gets the maximum number of partitions (parallel workers) the host can run.
- getMessage() - Method in exception com.azure.cosmos.CosmosException
- getMinScaleCount() - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Gets the minimum partition count (parallel workers) for the current host.
- getMinThroughput() - Method in class com.azure.cosmos.models.ThroughputResponse
-
Gets minimum throughput in measurement of request units per second in the Azure Cosmos service.
- getMode() - Method in class com.azure.cosmos.models.ConflictResolutionPolicy
-
Gets the
ConflictResolutionMode
in the Azure Cosmos DB service. - getName() - Method in class com.azure.cosmos.models.ComputedProperty
-
Gets the name of the computed property.
- getName() - Method in class com.azure.cosmos.models.EncryptionKeyWrapMetadata
-
Serialized form of metadata.
- getName() - Method in class com.azure.cosmos.models.SqlParameter
-
Gets the name of the parameter.
- getNetworkRequestTimeout() - Method in class com.azure.cosmos.DirectConnectionConfig
-
Gets the network request timeout interval (time to wait for response from network peer).
- getNonIdempotentWriteRetriesEnabled() - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the non idempotent write retries enabled.
- getNonIdempotentWriteRetriesEnabled() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the non idempotent write retries enabled.
- getOperation() - Method in class com.azure.cosmos.models.CosmosBatchOperationResult
-
Gets the original operation for this result.
- getOperation() - Method in class com.azure.cosmos.models.CosmosBulkOperationResponse
-
Gets the
CosmosItemOperation
- getOperationId() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The operation identifier of the operation - this can be used to add a dimension for feed operations - like queries - so, metrics and diagnostics can be separated for different query types etc.
- getOperationKind() - Method in class com.azure.cosmos.models.CosmosConflictProperties
-
Gets the operation kind.
- getOperations() - Method in class com.azure.cosmos.models.CosmosBatch
-
Return the list of operation in an unmodifiable instance so no one can change it in the down path.
- getOperationType() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The operation type of the operation
- getOperationType() - Method in class com.azure.cosmos.models.ChangeFeedMetaData
-
Gets the Change Feed operation type
- getOperationType() - Method in interface com.azure.cosmos.models.CosmosItemOperation
- getOrder() - Method in class com.azure.cosmos.models.CompositePath
-
Gets the sort order for the composite path.
- getParameters() - Method in class com.azure.cosmos.models.SqlQuerySpec
-
Gets the container of query parameters.
- getPartitionId() - Method in class com.azure.cosmos.CosmosDiagnosticsRequestInfo
-
Gets the identifier for the physical partition/shard this request was processed in or null when the request was not targeting a replica/partition directly.
- getPartitionKey() - Method in class com.azure.cosmos.models.CosmosConflictRequestOptions
-
Gets the partition key associated with the request in the Azure Cosmos DB service.
- getPartitionKey() - Method in class com.azure.cosmos.models.CosmosItemIdentity
-
Gets the partition key
- getPartitionKey() - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Gets the partition key used to identify the current request's target partition.
- getPartitionKey() - Method in class com.azure.cosmos.models.CosmosStoredProcedureRequestOptions
-
Gets the partition key used to identify the current request's target partition.
- getPartitionKeyDefinition() - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Gets the containers's partition key definition.
- getPartitionKeyRangeId() - Method in class com.azure.cosmos.CosmosDiagnosticsRequestInfo
-
Gets the PartitionKeyRangeId for the physical partition/shard this request was processed in or null when the request was not targeting a replica/partition directly.
- getPartitionKeyValue() - Method in class com.azure.cosmos.models.CosmosBatch
-
Return the partition key for this batch.
- getPartitionKeyValue() - Method in interface com.azure.cosmos.models.CosmosItemOperation
- getPatchItemOperation(String, PartitionKey, CosmosPatchOperations) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for a patch in Bulk execution.
- getPatchItemOperation(String, PartitionKey, CosmosPatchOperations, CosmosBulkPatchItemRequestOptions) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for a patch in Bulk execution.
- getPatchItemOperation(String, PartitionKey, CosmosPatchOperations, CosmosBulkPatchItemRequestOptions, TContext) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for a patch in Bulk execution.
- getPatchItemOperation(String, PartitionKey, CosmosPatchOperations, TContext) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for a patch in Bulk execution.
- getPath() - Method in class com.azure.cosmos.models.ClientEncryptionIncludedPath
-
Gets the path to be encrypted.
- getPath() - Method in class com.azure.cosmos.models.CompositePath
-
Gets path.
- getPath() - Method in class com.azure.cosmos.models.CosmosVectorEmbedding
-
Gets the path for the cosmosVectorEmbedding.
- getPath() - Method in class com.azure.cosmos.models.CosmosVectorIndexSpec
-
Gets path.
- getPath() - Method in class com.azure.cosmos.models.ExcludedPath
-
Gets path.
- getPath() - Method in class com.azure.cosmos.models.IncludedPath
-
Gets path.
- getPath() - Method in class com.azure.cosmos.models.SpatialSpec
-
Gets path.
- getPaths() - Method in class com.azure.cosmos.models.PartitionKeyDefinition
-
Gets the item property paths for the partition key.
- getPaths() - Method in class com.azure.cosmos.models.UniqueKey
-
Gets the paths, a set of which must be unique for each item in the Azure Cosmos DB service.
- getPermission(String) - Method in class com.azure.cosmos.CosmosAsyncUser
-
Get cosmos permission without making a call to backend
- getPermissionMode() - Method in class com.azure.cosmos.models.CosmosPermissionProperties
-
Gets the permission mode.
- getPermissionQuota() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the maximum quota for permission resources within an account from the Azure Cosmos DB service.
- getPermissionUsage() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the current number of permission resources within the account from the Azure Cosmos DB service.
- getPolicyFormatVersion() - Method in class com.azure.cosmos.models.ClientEncryptionPolicy
-
Version of the client encryption policy definition.
- getPostTriggerInclude() - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Gets the triggers to be invoked after the operation.
- getPreTriggerInclude() - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Gets the triggers to be invoked before the operation.
- getPrevious() - Method in class com.azure.cosmos.models.ChangeFeedProcessorItem
-
Gets the change feed previous item.
- getPreviousLogSequenceNumber() - Method in class com.azure.cosmos.models.ChangeFeedMetaData
-
Gets the previous logical sequence number
- getPriorityLevel() - Method in class com.azure.cosmos.ThroughputControlGroupConfig
-
Get the throughput control group priority level.
- getProactiveConnectionRegionsCount() - Method in class com.azure.cosmos.CosmosContainerProactiveInitConfig
-
Gets the no.
- getProperties() - Method in class com.azure.cosmos.models.CosmosClientEncryptionKeyResponse
-
Gets the cosmos client encryption key properties
- getProperties() - Method in class com.azure.cosmos.models.CosmosConflictResponse
-
Get conflict properties object representing the resource on the server
- getProperties() - Method in class com.azure.cosmos.models.CosmosContainerResponse
-
Gets the container properties
- getProperties() - Method in class com.azure.cosmos.models.CosmosDatabaseResponse
-
Gets the cosmos database properties
- getProperties() - Method in class com.azure.cosmos.models.CosmosPermissionResponse
-
Get the permission properties
- getProperties() - Method in class com.azure.cosmos.models.CosmosResponse
-
Gets properties.
- getProperties() - Method in class com.azure.cosmos.models.CosmosStoredProcedureResponse
-
Gets the stored procedure properties
- getProperties() - Method in class com.azure.cosmos.models.CosmosTriggerResponse
-
Gets the cosmos trigger properties or null
- getProperties() - Method in class com.azure.cosmos.models.CosmosUserDefinedFunctionResponse
-
Gets the cosmos getUser defined function getProperties
- getProperties() - Method in class com.azure.cosmos.models.CosmosUserResponse
-
Gets the cosmos user properties
- getProperties() - Method in class com.azure.cosmos.models.ThroughputResponse
- getProxy() - Method in class com.azure.cosmos.GatewayConnectionConfig
-
Gets the proxy options which contain the InetSocketAddress of proxy server.
- getQuery() - Method in class com.azure.cosmos.models.ComputedProperty
-
Gets the query used to evaluate the value for the computed property.
- getQueryName() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the query name.
- getQueryNameOrDefault(String) - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the query name.
- getQueryStatement() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The query statement send by client
- getQueryText() - Method in class com.azure.cosmos.models.SqlQuerySpec
-
Gets the text of the query.
- getReadItemOperation(String, PartitionKey) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for read item in Bulk execution.
- getReadItemOperation(String, PartitionKey, CosmosBulkItemRequestOptions) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for read item in Bulk execution.
- getReadItemOperation(String, PartitionKey, CosmosBulkItemRequestOptions, TContext) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for read item in Bulk execution.
- getReadItemOperation(String, PartitionKey, TContext) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for read item in Bulk execution.
- getRegionsContacted() - Method in class com.azure.cosmos.CosmosDiagnostics
-
Deprecated.
- getReplaceItemOperation(String, T, PartitionKey) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for replace item in Bulk execution.
- getReplaceItemOperation(String, T, PartitionKey, CosmosBulkItemRequestOptions) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for replace item in Bulk execution.
- getReplaceItemOperation(String, T, PartitionKey, CosmosBulkItemRequestOptions, TContext) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for replace item in Bulk execution.
- getReplaceItemOperation(String, T, PartitionKey, TContext) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for replace item in Bulk execution.
- getRequestCharge() - Method in exception com.azure.cosmos.CosmosException
-
Gets the request charge as request units (RU) consumed by the operation.
- getRequestCharge() - Method in class com.azure.cosmos.models.CosmosBatchOperationResult
-
Gets the request charge as request units (RU) consumed by the current operation.
- getRequestCharge() - Method in class com.azure.cosmos.models.CosmosBatchResponse
-
Gets the request charge as request units (RU) consumed by the batch operation.
- getRequestCharge() - Method in class com.azure.cosmos.models.CosmosBulkItemResponse
-
Gets the request charge as request units (RU) consumed by the current operation.
- getRequestCharge() - Method in class com.azure.cosmos.models.CosmosItemResponse
-
Gets the request charge as request units (RU) consumed by the operation.
- getRequestCharge() - Method in class com.azure.cosmos.models.CosmosResponse
-
Gets the request charge as request units (RU) consumed by the operation.
- getRequestCharge() - Method in class com.azure.cosmos.models.CosmosStoredProcedureResponse
-
Gets the number of normalized requests charged.
- getRequestCharge() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the request charge as request units (RU) consumed by the operation.
- getRequestContext() - Method in class com.azure.cosmos.models.CosmosOperationDetails
-
Gets the request context associated with an operation.
- getRequestInfo() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
Gets a collection of
CosmosDiagnosticsRequestInfo
records providing more information about individual requests issued in the transport layer to process this operation. - getRequestPipelineEvents() - Method in class com.azure.cosmos.CosmosDiagnosticsRequestInfo
-
Gets more granular information about different stages of the request pipeline.
- getRequestType() - Method in class com.azure.cosmos.CosmosDiagnosticsRequestInfo
-
Gets the type of request
- getResourceId() - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Gets the ID associated with the resource.
- getResourceId() - Method in class com.azure.cosmos.models.CosmosDatabaseProperties
-
Gets the ID associated with the resource.
- getResourceKind() - Method in class com.azure.cosmos.models.CosmosPermissionProperties
-
Gets the kind of resource that has a Cosmos container as the parent resource which is associated with this permission object.
- getResourceName() - Method in class com.azure.cosmos.models.CosmosPermissionProperties
-
Gets the name of resource that has a Cosmos container as the parent resource which is associated with this permission object.
- getResourcePartitionKey() - Method in class com.azure.cosmos.models.CosmosPermissionProperties
-
Gets the resource partition key associated with this permission object.
- getResourceType() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The resource type of the operation
- getResponse() - Method in class com.azure.cosmos.models.CosmosBulkOperationResponse
-
Gets the
CosmosBulkItemResponse
- getResponseAsString() - Method in class com.azure.cosmos.models.CosmosStoredProcedureResponse
-
Gets the response of the stored procedure as a string.
- getResponseContinuationTokenLimitInKb() - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the response continuation token limit in KB.
- getResponseContinuationTokenLimitInKb() - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Gets the ResponseContinuationTokenLimitInKb request option for item query requests in the Azure Cosmos DB service.
- getResponseContinuationTokenLimitInKb() - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Gets the ResponseContinuationTokenLimitInKb request option for item query requests in the Azure Cosmos DB service.
- getResponseContinuationTokenLimitInKb() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the response continuation token limit in KB.
- getResponseHeaders() - Method in exception com.azure.cosmos.CosmosException
-
Gets the response headers as key-value pairs
- getResponseHeaders() - Method in class com.azure.cosmos.models.CosmosBatchResponse
-
Gets the headers associated with the response.
- getResponseHeaders() - Method in class com.azure.cosmos.models.CosmosBulkItemResponse
-
Gets the headers associated with the response.
- getResponseHeaders() - Method in class com.azure.cosmos.models.CosmosItemResponse
-
Gets the headers associated with the response.
- getResponseHeaders() - Method in class com.azure.cosmos.models.CosmosResponse
-
Gets the headers associated with the response.
- getResponseHeaders() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the response headers.
- getResponseLength() - Method in class com.azure.cosmos.models.CosmosBatchResponse
-
Get the length of the response of a batch operation change it in the down path.
- getResults() - Method in class com.azure.cosmos.models.CosmosBatchResponse
-
Get all the results of the operations in a batch in an unmodifiable instance so no one can change it in the down path.
- getResults() - Method in class com.azure.cosmos.models.FeedResponse
-
Results.
- getRetentionDurationForAllVersionsAndDeletesPolicy() - Method in class com.azure.cosmos.models.ChangeFeedPolicy
-
Gets the retention duration in which it will be possible to process change feed events with AllVersionsAndDeletes mode (meaning intermediary changes and deletes will be exposed in change feed).
- getRetryAfterDuration() - Method in exception com.azure.cosmos.CosmosException
-
Gets the recommended time duration after which the client can retry failed requests
- getRetryAfterDuration() - Method in class com.azure.cosmos.models.CosmosBatchOperationResult
-
Gets retry after.
- getRetryAfterDuration() - Method in class com.azure.cosmos.models.CosmosBatchResponse
-
Gets the amount of time to wait before retrying this or any other request due to throttling.
- getRetryAfterDuration() - Method in class com.azure.cosmos.models.CosmosBulkItemResponse
-
Gets retry after.
- getRetryCount() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
Returns the number of retries and/or attempts for speculative processing.
- getScheduler() - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Gets the internal
Scheduler
that hosts a pool of ExecutorService-based workers for any change feed processor related tasks. - getScriptLog() - Method in class com.azure.cosmos.models.CosmosStoredProcedureResponse
-
Gets the output from stored procedure console.log() statements.
- getScripts() - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Gets a
CosmosAsyncScripts
using the current container as context. - getScripts() - Method in class com.azure.cosmos.CosmosContainer
-
Gets the Cosmos scripts using the current container as context.
- getSessionToken() - Method in class com.azure.cosmos.models.CosmosBatchRequestOptions
-
Gets the token for use with session consistency.
- getSessionToken() - Method in class com.azure.cosmos.models.CosmosBatchResponse
-
Gets the token used for managing client's consistency requirements.
- getSessionToken() - Method in class com.azure.cosmos.models.CosmosBulkItemResponse
-
Gets the token used for managing client's consistency requirements.
- getSessionToken() - Method in class com.azure.cosmos.models.CosmosContainerRequestOptions
-
Gets the token for use with session consistency.
- getSessionToken() - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Gets the token for use with session consistency.
- getSessionToken() - Method in class com.azure.cosmos.models.CosmosItemResponse
-
Gets the token used for managing client's consistency requirements.
- getSessionToken() - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Gets the session token for use with session consistency.
- getSessionToken() - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Gets the session token for use with session consistency.
- getSessionToken() - Method in class com.azure.cosmos.models.CosmosResponse
-
Gets the token used for managing client's consistency requirements.
- getSessionToken() - Method in class com.azure.cosmos.models.CosmosStoredProcedureRequestOptions
-
Gets the token for use with session consistency.
- getSessionToken() - Method in class com.azure.cosmos.models.CosmosStoredProcedureResponse
-
Gets the token used for managing client's consistency requirements.
- getSessionToken() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the session token for use in session consistency.
- getShortMessage() - Method in exception com.azure.cosmos.CosmosException
-
Returns the error message without any diagnostics - using this method is only useful when also logging the
CosmosException.getDiagnostics()
separately. - getSpatialIndexes() - Method in class com.azure.cosmos.models.IndexingPolicy
-
Gets the spatial indexes for additional indexes.
- getSpatialTypes() - Method in class com.azure.cosmos.models.SpatialSpec
-
Gets the container of spatial types.
- getStartContinuation() - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Gets the start request continuation token to start looking for changes after.
- getStartTime() - Method in class com.azure.cosmos.CosmosDiagnosticsRequestEvent
-
Gets the start time of the request pipeline event
- getStartTime() - Method in class com.azure.cosmos.CosmosDiagnosticsRequestInfo
-
Gets the start time of the request.
- getStartTime() - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Gets the time (exclusive) to start looking for changes after.
- getStatusCode() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The final status code of the operation (possibly after retries)
- getStatusCode() - Method in exception com.azure.cosmos.CosmosException
-
Gets the http status code.
- getStatusCode() - Method in class com.azure.cosmos.models.CosmosBatchOperationResult
-
Gets the HTTP status code associated with the current result.
- getStatusCode() - Method in class com.azure.cosmos.models.CosmosBatchResponse
-
Gets the HTTP status code associated with the response.
- getStatusCode() - Method in class com.azure.cosmos.models.CosmosBulkItemResponse
-
Gets the HTTP status code associated with the current result.
- getStatusCode() - Method in class com.azure.cosmos.models.CosmosItemResponse
-
Gets the HTTP status code associated with the response.
- getStatusCode() - Method in class com.azure.cosmos.models.CosmosResponse
-
Gets the HTTP status code associated with the response.
- getStatusCode() - Method in class com.azure.cosmos.models.CosmosStoredProcedureResponse
-
Gets the HTTP status code associated with the response.
- getStoredProcedure(String) - Method in class com.azure.cosmos.CosmosAsyncScripts
-
Gets a CosmosAsyncStoredProcedure object without making a service call
- getStoredProcedure(String) - Method in class com.azure.cosmos.CosmosScripts
-
Gets stored procedure.
- getStoredProceduresQuota() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the maximum quota of stored procedures for a container from the Azure Cosmos DB service.
- getStoredProceduresUsage() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the current number of stored procedures for a container from the Azure Cosmos DB service.
- getSubStatusCode() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The final sub-status code of the operation (possibly after retries)
- getSubStatusCode() - Method in exception com.azure.cosmos.CosmosException
-
Gets the sub status code.
- getSubStatusCode() - Method in class com.azure.cosmos.models.CosmosBatchOperationResult
-
Gets sub status code associated with the current result.
- getSubStatusCode() - Method in class com.azure.cosmos.models.CosmosBatchResponse
-
Gets the HTTP sub status code associated with the response.
- getSubStatusCode() - Method in class com.azure.cosmos.models.CosmosBulkItemResponse
-
Gets sub status code associated with the current result.
- getSystemUsage() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
Returns the system usage NOTE: this information is not included in the json representation returned from
CosmosDiagnosticsContext.toJson()
because it is usually only relevant when thresholds are violated, in which case the entire diagnostics json-string is included. - getTargetThroughput() - Method in class com.azure.cosmos.ThroughputControlGroupConfig
-
Get throughput control group target throughput.
- getTargetThroughputThreshold() - Method in class com.azure.cosmos.ThroughputControlGroupConfig
-
Get the throughput control group target throughput threshold.
- getThreshold() - Method in class com.azure.cosmos.ThresholdBasedAvailabilityStrategy
-
Gets threshold.
- getThresholdForDiagnosticsOnTracer() - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Gets the thresholdForDiagnosticsOnTracer, if latency on CRUD operation is greater than this diagnostics will be sent to open telemetry exporter as events in tracer span of end to end CRUD api.
- getThresholdForDiagnosticsOnTracer() - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Gets the thresholdForDiagnosticsOnTracer, if latency on query operation is greater than this diagnostics will be send to open telemetry exporter as events in tracer span of end to end CRUD api.
- getThresholdForDiagnosticsOnTracer() - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Gets the thresholdForDiagnosticsOnTracer, if latency on query operation is greater than this diagnostics will be send to open telemetry exporter as events in tracer span of end to end CRUD api.
- getThresholdsState() - Method in class com.azure.cosmos.models.CosmosBulkExecutionOptions
-
Returns threshold state that can be passed to other CosmosBulkExecutionOptions in the future
- getThresholdStep() - Method in class com.azure.cosmos.ThresholdBasedAvailabilityStrategy
-
Gets threshold step.
- getThroughputControlGroupName() - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the resource token.
- getThroughputControlGroupName() - Method in class com.azure.cosmos.models.CosmosBulkExecutionOptions
-
Gets the throughput control group name.
- getThroughputControlGroupName() - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Get the throughput control group name.
- getThroughputControlGroupName() - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Gets the throughput control group name.
- getThroughputControlGroupName() - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Get throughput control group name.
- getThroughputControlGroupName() - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Get throughput control group name.
- getThroughputControlGroupName() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the throughput control group name.
- getTimestamp() - Method in class com.azure.cosmos.models.CosmosClientEncryptionKeyProperties
-
Get the last modified timestamp associated with the resource.
- getTimestamp() - Method in class com.azure.cosmos.models.CosmosConflictProperties
-
Get the last modified timestamp associated with the resource.
- getTimestamp() - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Get the last modified timestamp associated with the resource.
- getTimestamp() - Method in class com.azure.cosmos.models.CosmosDatabaseProperties
-
Get the last modified timestamp associated with the resource.
- getTimestamp() - Method in class com.azure.cosmos.models.CosmosPermissionProperties
-
Get the last modified timestamp associated with the resource.
- getTimestamp() - Method in class com.azure.cosmos.models.CosmosStoredProcedureProperties
-
Get the last modified timestamp associated with the resource.
- getTimestamp() - Method in class com.azure.cosmos.models.CosmosTriggerProperties
-
Get the last modified timestamp associated with the resource.
- getTimestamp() - Method in class com.azure.cosmos.models.CosmosUserDefinedFunctionProperties
-
Get the last modified timestamp associated with the resource.
- getTimestamp() - Method in class com.azure.cosmos.models.CosmosUserProperties
-
Get the last modified timestamp associated with the resource.
- getTimestamp() - Method in class com.azure.cosmos.models.ThroughputProperties
-
Get the last modified timestamp associated with the resource.
- getToken() - Method in class com.azure.cosmos.models.CosmosPermissionProperties
-
Gets the access token granting the defined permission.
- getTotalRequestCharge() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The total request charge across all retries.
- getTrackingId() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
The trackingId of a write operation.
- getTrigger(String) - Method in class com.azure.cosmos.CosmosAsyncScripts
-
Gets a CosmosAsyncTrigger object without making a service call
- getTrigger(String) - Method in class com.azure.cosmos.CosmosScripts
-
Gets trigger.
- getTriggerOperation() - Method in class com.azure.cosmos.models.CosmosTriggerProperties
-
Get the operation type of the trigger.
- getTriggersQuota() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the maximum quota of triggers for a container from the Azure Cosmos DB service.
- getTriggersUsage() - Method in class com.azure.cosmos.models.FeedResponse
-
Get the current number of triggers for a container from the Azure Cosmos DB service.
- getTriggerType() - Method in class com.azure.cosmos.models.CosmosTriggerProperties
-
Get the type of the trigger.
- getType() - Method in class com.azure.cosmos.models.CosmosVectorIndexSpec
-
Gets the vector index type for the vector index
- getType() - Method in class com.azure.cosmos.models.EncryptionKeyWrapMetadata
-
Serialized form of metadata.
- getUniqueKeyPolicy() - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Gets the containers unique key policy
- getUniqueKeys() - Method in class com.azure.cosmos.models.UniqueKeyPolicy
-
Gets or sets container of
UniqueKey
that guarantee uniqueness of items in container in the Azure Cosmos DB service. - getUpsertItemOperation(T, PartitionKey) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for upsert item in Bulk execution.
- getUpsertItemOperation(T, PartitionKey, CosmosBulkItemRequestOptions) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for upsert item in Bulk execution.
- getUpsertItemOperation(T, PartitionKey, CosmosBulkItemRequestOptions, TContext) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for upsert item in Bulk execution.
- getUpsertItemOperation(T, PartitionKey, TContext) - Static method in class com.azure.cosmos.models.CosmosBulkOperations
-
Instantiate an operation for upsert item in Bulk execution.
- getUser(String) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Gets user.
- getUser(String) - Method in class com.azure.cosmos.CosmosDatabase
-
Gets a Cosmos user instance without making a service call.
- getUserAgent() - Method in class com.azure.cosmos.CosmosDiagnostics
-
Gets the UserAgent header value used by the client issueing this operation
- getUserAgent() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
Gets the UserAgent header value used by the client issuing this operation NOTE: this information is not included in the json representation returned from
CosmosDiagnosticsContext.toJson()
because it is usually only relevant when thresholds are violated, in which case the entire diagnostics json-string is included. - getUserDefinedFunction(String) - Method in class com.azure.cosmos.CosmosAsyncScripts
-
Gets a CosmosAsyncUserDefinedFunction object without making a service call
- getUserDefinedFunction(String) - Method in class com.azure.cosmos.CosmosScripts
-
Gets user defined function.
- getUserDefinedFunctionsQuota() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the maximum quota of user defined functions for a container from the Azure Cosmos DB service.
- getUserDefinedFunctionsUsage() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the current number of user defined functions for a container from the Azure Cosmos DB service.
- getUserQuota() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the maximum quota for user resources within an account from the Azure Cosmos DB service.
- getUserUsage() - Method in class com.azure.cosmos.models.FeedResponse
-
Gets the current number of user resources within the account from the Azure Cosmos DB service.
- getValue() - Method in class com.azure.cosmos.models.EncryptionKeyWrapMetadata
-
Serialized form of metadata.
- getValue() - Method in enum com.azure.cosmos.models.PermissionMode
-
Gets the numerical value of the permission mode.
- getValue() - Method in enum com.azure.cosmos.models.TriggerOperation
-
Gets the numerical value of the trigger operation.
- getValue() - Method in enum com.azure.cosmos.models.TriggerType
-
Gets the numerical value of the trigger type.
- getValue(Class<T>) - Method in class com.azure.cosmos.models.SqlParameter
-
Gets the value of the parameter.
- getVectorEmbeddingPolicy() - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Gets the Vector Embedding Policy containing paths for embeddings along with path-specific settings for the item used in performing vector search on the items in a collection in the Azure CosmosDB database service.
- getVectorEmbeddings() - Method in class com.azure.cosmos.models.CosmosVectorEmbeddingPolicy
-
Gets the paths for embeddings along with path-specific settings for the item.
- getVectorIndexes() - Method in class com.azure.cosmos.models.IndexingPolicy
-
Gets the vector indexes.
- getVersion() - Method in class com.azure.cosmos.models.PartitionKeyDefinition
-
Gets version.
- getWrappedDataEncryptionKey() - Method in class com.azure.cosmos.models.CosmosClientEncryptionKeyProperties
-
Gets the wrapped form of the client encryption key.
- GlobalThroughputControlConfig - Class in com.azure.cosmos
-
This configuration is used for throughput global control mode.
- GlobalThroughputControlConfigBuilder - Class in com.azure.cosmos
-
Throughput global control config builder.
- groupName(String) - Method in class com.azure.cosmos.ThroughputControlGroupConfigBuilder
-
Set the throughput control group name.
H
- handle(Consumer<FeedResponse<T>>) - Method in class com.azure.cosmos.util.CosmosPagedFlux
-
Handle for invoking "side-effects" on each FeedResponse returned by CosmosPagedFlux
- handle(Consumer<FeedResponse<T>>) - Method in class com.azure.cosmos.util.CosmosPagedIterable
-
Handle for invoking "side-effects" on each FeedResponse returned by CosmosPagedIterable
- handleAllVersionsAndDeletesChanges(BiConsumer<List<ChangeFeedProcessorItem>, ChangeFeedProcessorContext>) - Method in class com.azure.cosmos.ChangeFeedProcessorBuilder
-
Sets a
BiConsumer
function which will be called to process changes for AllVersionsAndDeletes change feed mode. - handleAllVersionsAndDeletesChanges(Consumer<List<ChangeFeedProcessorItem>>) - Method in class com.azure.cosmos.ChangeFeedProcessorBuilder
-
Sets a consumer function which will be called to process changes for AllVersionsAndDeletes change feed mode.
- handleChanges(Consumer<List<JsonNode>>) - Method in class com.azure.cosmos.ChangeFeedProcessorBuilder
-
Sets a consumer function which will be called to process changes for LatestVersion change feed mode.
- handleDiagnostics(CosmosDiagnosticsContext, Context) - Method in interface com.azure.cosmos.CosmosDiagnosticsHandler
-
This method will be invoked when an operation completed (successfully or failed) to allow diagnostic handlers to emit the diagnostics NOTE: Any code in handleDiagnostics should not execute any I/O operations, do thread switches or execute CPU intense work - if needed a diagnostics handler should queue this work asynchronously.
- handleLatestVersionChanges(Consumer<List<ChangeFeedProcessorItem>>) - Method in class com.azure.cosmos.ChangeFeedProcessorBuilder
-
Sets a consumer function which will be called to process changes for LatestVersion change feed mode.
- HASH - Enum constant in enum com.azure.cosmos.models.PartitionKind
-
The Partition of an item is calculated based on the hash value of the PartitionKey.
- hashCode() - Method in class com.azure.cosmos.models.CompositePath
- hashCode() - Method in class com.azure.cosmos.models.CosmosContainerIdentity
- hashCode() - Method in class com.azure.cosmos.models.CosmosItemIdentity
- hashCode() - Method in class com.azure.cosmos.models.CosmosMetricCategory
- hashCode() - Method in class com.azure.cosmos.models.CosmosMetricName
- hashCode() - Method in class com.azure.cosmos.models.CosmosMetricTagName
- hashCode() - Method in class com.azure.cosmos.models.EncryptionKeyWrapMetadata
- hashCode() - Method in class com.azure.cosmos.models.ExcludedPath
- hashCode() - Method in class com.azure.cosmos.models.IncludedPath
- hashCode() - Method in class com.azure.cosmos.models.PartitionKey
- hashCode() - Method in class com.azure.cosmos.models.PriorityLevel
- hashCode() - Method in class com.azure.cosmos.models.SqlParameter
- HIGH - Static variable in class com.azure.cosmos.models.PriorityLevel
-
High Priority level
- hostName(String) - Method in class com.azure.cosmos.ChangeFeedProcessorBuilder
-
Sets the host name.
I
- INCLUDE - Enum constant in enum com.azure.cosmos.models.IndexingDirective
-
Index the resource.
- IncludedPath - Class in com.azure.cosmos.models
-
Represents an included path of the IndexingPolicy in the Azure Cosmos DB database service.
- IncludedPath(String) - Constructor for class com.azure.cosmos.models.IncludedPath
-
Constructor.
- increment(String, double) - Method in class com.azure.cosmos.models.CosmosPatchOperations
-
This increment the value at the target location.
- increment(String, long) - Method in class com.azure.cosmos.models.CosmosPatchOperations
-
This increment the value at the target location.
- IndexingDirective - Enum in com.azure.cosmos.models
-
Specifies whether or not the resource is to be indexed in the Azure Cosmos DB database service.
- IndexingMode - Enum in com.azure.cosmos.models
-
Specifies the supported indexing modes in the Azure Cosmos DB database service.
- IndexingPolicy - Class in com.azure.cosmos.models
-
Represents the indexing policy configuration for a container in the Azure Cosmos DB database service.
- IndexingPolicy() - Constructor for class com.azure.cosmos.models.IndexingPolicy
-
Constructor.
- INT8 - Enum constant in enum com.azure.cosmos.models.CosmosVectorDataType
-
Represents a int8 data type.
- INVALID - Enum constant in enum com.azure.cosmos.models.ConflictResolutionMode
-
INVALID or unknown mode.
- isAutomatic() - Method in class com.azure.cosmos.models.IndexingPolicy
-
Gets whether automatic indexing is enabled for a container.
- isCompleted() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
Returns a flag indicating whether the operation has been completed yet.
- isConnectionEndpointRediscoveryEnabled() - Method in class com.azure.cosmos.DirectConnectionConfig
-
Gets a value indicating whether Direct TCP connection endpoint rediscovery is enabled.
- isContentResponseOnWriteEnabled() - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the content response on write enabled.
- isContentResponseOnWriteEnabled() - Method in class com.azure.cosmos.models.CosmosBulkItemRequestOptions
-
Gets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations in
CosmosItemOperation
. - isContentResponseOnWriteEnabled() - Method in class com.azure.cosmos.models.CosmosBulkPatchItemRequestOptions
-
Gets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations in
CosmosItemOperation
. - isContentResponseOnWriteEnabled() - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Gets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations on CosmosItem.
- isContentResponseOnWriteEnabled() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the content response on write enabled.
- isDefault() - Method in class com.azure.cosmos.ThroughputControlGroupConfig
-
Get whether this throughput control group will be used by default.
- isEnabled() - Method in class com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig
-
Returns if the policy is enabled or not
- isEnabled() - Method in class com.azure.cosmos.NonIdempotentWriteRetryOptions
-
Returns a flag indicating whether automatic retries for write operations even when they are not guaranteed to be idempotent are enabled or not.
- isFailure() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
A flag indicating whether the operation should be considered failed or not based on the status code handling rules in
CosmosDiagnosticsThresholds.setFailureHandler(java.util.function.BiPredicate)
- isIndexMetricsEnabled() - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the index metrics enabled.
- isIndexMetricsEnabled() - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Gets indexMetricsEnabled, which is used to obtain the index metrics to understand how the query engine used existing indexes and could use potential new indexes.
- isIndexMetricsEnabled() - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Gets indexMetricsEnabled, which is used to obtain the index metrics to understand how the query engine used existing indexes and could use potential new indexes.
- isIndexMetricsEnabled() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the index metrics enabled.
- isIntegratedCacheBypassed() - Method in class com.azure.cosmos.models.DedicatedGatewayRequestOptions
-
Gets if the integrated cache is enabled or bypassed with the request in Azure CosmosDB service.
- isPointOperation() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
A flag indicating whether the operation is a point operation or not.
- isQueryMetricsEnabled() - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the query metrics enabled.
- isQueryMetricsEnabled() - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Gets the option to enable populate query metrics.
- isQueryMetricsEnabled() - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Gets the option to enable populate query metrics.
- isQueryMetricsEnabled() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the query metrics enabled.
- isQuotaInfoEnabled() - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Gets the quotaInfoEnabled setting for change feed request in the Azure Cosmos DB database service.
- isQuotaInfoEnabled() - Method in class com.azure.cosmos.models.CosmosContainerRequestOptions
-
Gets the quotaInfoEnabled setting for cosmos container read requests in the Azure Cosmos DB database service.
- isReplacePending() - Method in class com.azure.cosmos.models.ThroughputResponse
-
Gets the status whether offer replace is successful or pending.
- isScanInQueryEnabled() - Method in class com.azure.cosmos.CosmosRequestContext
-
Gets the scan in query enabled.
- isScanInQueryEnabled() - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Gets the option to allow scan on the queries which couldn't be served as indexing was opted out on the requested paths.
- isScanInQueryEnabled() - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Gets the scan in query enabled.
- isScriptLoggingEnabled() - Method in class com.azure.cosmos.models.CosmosStoredProcedureRequestOptions
-
Gets whether Javascript stored procedure logging is enabled for the current request in the Azure Cosmos DB database service or not.
- isStarted() - Method in interface com.azure.cosmos.ChangeFeedProcessor
-
Returns the state of the change feed processor.
- isStartFromBeginning() - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Gets a value indicating whether change feed in the Azure Cosmos DB service should start from beginning (true) or from current (false).
- isSuccessStatusCode() - Method in class com.azure.cosmos.models.CosmosBatchOperationResult
-
Gets a value indicating whether the current operation completed successfully.
- isSuccessStatusCode() - Method in class com.azure.cosmos.models.CosmosBatchResponse
-
Returns a value indicating whether the batch was successfully processed.
- isSuccessStatusCode() - Method in class com.azure.cosmos.models.CosmosBulkItemResponse
-
Gets a value indicating whether the current operation completed successfully.
- isThresholdViolated() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
Indicates whether the latency, request charge or payload size of the operation exceeded the given threshold
- isTimeToLiveExpired() - Method in class com.azure.cosmos.models.ChangeFeedMetaData
-
Used to distinguish explicit deletes (e.g.
- isTrackingIdUsed() - Method in class com.azure.cosmos.NonIdempotentWriteRetryOptions
-
Returns a flag indicating whether write operations can use the trackingId system property '/_trackingId' to allow identification of conflicts and pre-condition failures due to retries.
- ITEM - Enum constant in enum com.azure.cosmos.models.ContainerChildResourceType
-
Represents an item resource that is created in a Cosmos container.
K
- key(String) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets either a master or readonly key used to perform authentication for accessing resource.
L
- LAST_WRITER_WINS - Enum constant in enum com.azure.cosmos.models.ConflictResolutionMode
-
Last writer wins conflict resolution mode Setting the ConflictResolutionMode to "LAST_WRITER_WINS" indicates that conflict resolution should be done by inspecting a field in the conflicting items and picking the item which has the higher value in that path.
- LAZY - Enum constant in enum com.azure.cosmos.models.IndexingMode
-
Index is updated asynchronously with respect to a create or update operation.
- leaseContainer(CosmosAsyncContainer) - Method in class com.azure.cosmos.ChangeFeedProcessorBuilder
-
Sets an existing
CosmosAsyncContainer
to be used to read from the leases container. - LEGACY - Static variable in class com.azure.cosmos.models.CosmosMetricCategory
-
The metrics in the Legacy category emit metrics that should not be used anymore and exist only for backwards compatibility reasons.
- LEGACY_DIRECT_ENDPOINT_STATISTICS_ACQUIRED - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Distribution summary over snapshot of acquired channels for the endpoint at time of a request (DistributionSummary)
- LEGACY_DIRECT_ENDPOINT_STATISTICS_AVAILABLE - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Distribution summary over snapshot of available channels for the endpoint at time of a request (DistributionSummary)
- LEGACY_DIRECT_ENDPOINT_STATISTICS_INFLIGHT - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Distribution summary over snapshot of inflight channels for the endpoint at time of a request (DistributionSummary)
- LINE_STRING - Enum constant in enum com.azure.cosmos.models.SpatialType
-
Represent a line string data type.
- LOCAL_REGION_PREFERRED - Static variable in class com.azure.cosmos.CosmosRegionSwitchHint
-
CosmosRegionSwitchHint.LOCAL_REGION_PREFERRED
corresponds to a hint which will result in internal retry policies biasing the local region of a request more than remote regions. - LOW - Static variable in class com.azure.cosmos.models.PriorityLevel
-
Low Priority level
M
- maxRetriesPerRegion(int) - Method in class com.azure.cosmos.SessionRetryOptionsBuilder
-
Sets the maximum number of retries within each region for read and write operations.
- meterRegistry(MeterRegistry) - Method in class com.azure.cosmos.models.CosmosMicrometerMetricsOptions
-
Sets MetricRegistry to be used to emit client metrics
- metricsOptions(MetricsOptions) - Method in class com.azure.cosmos.models.CosmosClientTelemetryConfig
-
Sets MetricsOptions to be used to emit client metrics
- metricTagNames(String...) - Method in class com.azure.cosmos.models.CosmosClientTelemetryConfig
- MINIMUM - Static variable in class com.azure.cosmos.models.CosmosMetricCategory
-
Minimum set of metrics (categories OperationSummary and System) enabled.
- MINIMUM - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
Minimum tags that are required and cannot be disabled
- minTimeoutPerRegion(Duration) - Method in class com.azure.cosmos.SessionRetryOptionsBuilder
-
Sets the minimum retry time for 404/1002 retries within each region for read and write operations.
- move(String, String) - Method in class com.azure.cosmos.models.CosmosPatchOperations
-
This moves the value of an object from the source to a destination.
- MULTI_HASH - Enum constant in enum com.azure.cosmos.models.PartitionKind
-
The Partition of an item is calculated based on the hash value of multiple PartitionKeys.
- MULTI_POLYGON - Enum constant in enum com.azure.cosmos.models.SpatialType
-
Represent a multi-polygon data type.
- multipleWriteRegionsEnabled(boolean) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the flag to enable writes on any regions for geo-replicated database accounts in the Azure Cosmos DB service.
N
- NONE - Enum constant in enum com.azure.cosmos.models.IndexingMode
-
No index is provided.
- NONE - Enum constant in enum com.azure.cosmos.models.ShowQueryMode
-
Do not show query.
- NONE - Static variable in class com.azure.cosmos.models.PartitionKey
-
Partition key that represents no partition key.
- nonIdempotentWriteRetryOptions(NonIdempotentWriteRetryOptions) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Enables automatic retries for write operations even when the SDK can't guarantee that they are idempotent.
- NonIdempotentWriteRetryOptions - Class in com.azure.cosmos
-
Class to define the options for non-idempotent write operations
- NonIdempotentWriteRetryOptions() - Constructor for class com.azure.cosmos.NonIdempotentWriteRetryOptions
-
Creates an instance of the NonIdempotentWriteRetryOptions class.
O
- openConnectionsAndInitCaches() - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Deprecated.
- openConnectionsAndInitCaches() - Method in class com.azure.cosmos.CosmosContainer
-
Deprecated.
- openConnectionsAndInitCaches(int) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Deprecated.
- openConnectionsAndInitCaches(int) - Method in class com.azure.cosmos.CosmosContainer
-
Deprecated.
- openConnectionsAndInitCaches(CosmosContainerProactiveInitConfig) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the
CosmosContainerProactiveInitConfig
which enable warming up of caches and connections associated with containers obtained fromCosmosContainerProactiveInitConfig.getCosmosContainerIdentities()
to replicas obtained from the first k preferred regions where k evaluates toCosmosContainerProactiveInitConfig.getProactiveConnectionRegionsCount()
. - OPERATION - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
Operation type Applicable to operations
- OPERATION_DETAILS - Static variable in class com.azure.cosmos.models.CosmosMetricCategory
-
The metrics in the OperationDetails category emit additional end-to-end metrics (like item count) for SDK operations.
- OPERATION_DETAILS_ACTUAL_ITEM_COUNT - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Actual item count - relevant for non-point-operations - indicating the actual number of docs returned in the response (DistributionSummary) NOTE: No percentiles or histogram supported
- OPERATION_DETAILS_MAX_ITEM_COUNT - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Max.
- OPERATION_DETAILS_REGIONS_CONTACTED - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Number of regions contacted for processing the operation (DistributionSummary)
- OPERATION_STATUS_CODE - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
Operation status code.
- OPERATION_SUB_STATUS_CODE - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
Operation sub-status code.
- OPERATION_SUMMARY - Static variable in class com.azure.cosmos.models.CosmosMetricCategory
-
The metrics in the OperationSummary category emit most important end-to-end metrics (like latency, request rate, request charge, request- and response-payload size etc.) for SDK operations These metrics are intended to visualize health state and impact - but alone not sufficient for triaging issues.
- OPERATION_SUMMARY_CALLS - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Number of operation calls (Counter)
- OPERATION_SUMMARY_LATENCY - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Total latency (across requests including retries) of the operation (Timer)
- OPERATION_SUMMARY_REQUEST_CHARGE - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Request charge for the operation (DistributionSummary)
- options(ChangeFeedProcessorOptions) - Method in class com.azure.cosmos.ChangeFeedProcessorBuilder
-
Sets the
ChangeFeedProcessorOptions
to be used.
P
- PARAMETERIZED_ONLY - Enum constant in enum com.azure.cosmos.models.ShowQueryMode
-
Print parameterized query only.
- PARTITION_ID - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
The PartitionId (Guid) Applicable to requests
- PARTITION_KEY_RANGE_ID - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
A numeric identifier for a physical partition Applicable to operations and requests
- PartitionKey - Class in com.azure.cosmos.models
-
Represents a partition key value in the Azure Cosmos DB database service.
- PartitionKey(Object) - Constructor for class com.azure.cosmos.models.PartitionKey
-
Constructor.
- PartitionKeyBuilder - Class in com.azure.cosmos.models
-
Builder for partition keys.
- PartitionKeyBuilder() - Constructor for class com.azure.cosmos.models.PartitionKeyBuilder
-
Constructor.
- PartitionKeyDefinition - Class in com.azure.cosmos.models
-
Represents a partition key definition in the Azure Cosmos DB database service.
- PartitionKeyDefinition() - Constructor for class com.azure.cosmos.models.PartitionKeyDefinition
-
Constructor.
- PartitionKeyDefinitionVersion - Enum in com.azure.cosmos.models
-
Partitioning version.
- PartitionKind - Enum in com.azure.cosmos.models
-
Specifies the partition scheme for a multiple-partitioned container in the Azure Cosmos DB database service.
- PATCH - Enum constant in enum com.azure.cosmos.models.CosmosItemOperationType
-
Patch operation type.
- patchItem(String, PartitionKey, CosmosPatchOperations, CosmosPatchItemRequestOptions, Class<T>) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Run partial update that modifies specific properties or fields of the item without replacing the entire item.
- patchItem(String, PartitionKey, CosmosPatchOperations, CosmosPatchItemRequestOptions, Class<T>) - Method in class com.azure.cosmos.CosmosContainer
-
Run partial update that modifies specific properties or fields of the item without replacing the entire item.
- patchItem(String, PartitionKey, CosmosPatchOperations, Class<T>) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Run partial update that modifies specific properties or fields of the item without replacing the entire item.
- patchItem(String, PartitionKey, CosmosPatchOperations, Class<T>) - Method in class com.azure.cosmos.CosmosContainer
-
Run partial update that modifies specific properties or fields of the item without replacing the entire item.
- patchItemOperation(String, CosmosPatchOperations) - Method in class com.azure.cosmos.models.CosmosBatch
-
Adds a patch operations for an item into the batch.
- patchItemOperation(String, CosmosPatchOperations, CosmosBatchPatchItemRequestOptions) - Method in class com.azure.cosmos.models.CosmosBatch
-
Adds a patch operations for an item into the batch.
- PermissionMode - Enum in com.azure.cosmos.models
-
Enumeration specifying applicability of permission in the Azure Cosmos DB database service.
- permissions(List<CosmosPermissionProperties>) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the permission list, which contains the resource tokens needed to access resources.
- POINT - Enum constant in enum com.azure.cosmos.models.SpatialType
-
Represent a point data type.
- POLYGON - Enum constant in enum com.azure.cosmos.models.SpatialType
-
Represent a polygon data type.
- POST - Enum constant in enum com.azure.cosmos.models.TriggerType
-
Trigger should be executed after the associated operation(s).
- PRE - Enum constant in enum com.azure.cosmos.models.TriggerType
-
Trigger should be executed before the associated operation(s).
- preferredRegions(List<String>) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the preferred regions for geo-replicated database accounts.
- PREVIEW_SUBJECT_TO_CHANGE_WARNING - Static variable in annotation type com.azure.cosmos.util.Beta
-
Default warning text.
- priorityLevel(PriorityLevel) - Method in class com.azure.cosmos.ThroughputControlGroupConfigBuilder
-
Set the throughput control group priority level.
- PriorityLevel - Class in com.azure.cosmos.models
-
Enumeration specifying Priority Level of requests
- process(CosmosOperationDetails) - Method in interface com.azure.cosmos.CosmosOperationPolicy
-
Processes the request details and calls the next policy in the chain.
Q
- QUANTIZED_FLAT - Enum constant in enum com.azure.cosmos.models.CosmosVectorIndexType
-
Represents a quantized flat vector index type.
- queryChangeFeed(CosmosChangeFeedRequestOptions, Class<T>) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Query for items in the change feed of the current container using the
CosmosChangeFeedRequestOptions
. - queryChangeFeed(CosmosChangeFeedRequestOptions, Class<T>) - Method in class com.azure.cosmos.CosmosContainer
-
Query for items in the change feed of the current container using the
CosmosChangeFeedRequestOptions
. - queryClientEncryptionKeys(SqlQuerySpec) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Query for cosmos client encryption keys in a database.
- queryClientEncryptionKeys(SqlQuerySpec, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Query for cosmos client encryption keys in a database.
- queryClientEncryptionKeys(String) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Query for cosmos client encryption keys in a database.
- queryClientEncryptionKeys(String, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Query for cosmos client encryption keys in a database.
- queryConflicts(String) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Queries all the conflicts in the current container.
- queryConflicts(String, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Queries all the conflicts in the current container.
- queryContainers(SqlQuerySpec) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Query for cosmos containers in a cosmos database.
- queryContainers(SqlQuerySpec) - Method in class com.azure.cosmos.CosmosDatabase
-
Query containers in the current database.
- queryContainers(SqlQuerySpec, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Query for cosmos containers in a cosmos database.
- queryContainers(SqlQuerySpec, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosDatabase
-
Query containers in the current database.
- queryContainers(String) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Query for cosmos containers in a cosmos database.
- queryContainers(String) - Method in class com.azure.cosmos.CosmosDatabase
-
Query containers in the current database.
- queryContainers(String, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Query for cosmos containers in a cosmos database.
- queryContainers(String, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosDatabase
-
Query containers iterator.
- queryDatabases(SqlQuerySpec, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncClient
-
Query for databases.
- queryDatabases(SqlQuerySpec, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosClient
-
Query a Cosmos database.
- queryDatabases(String, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncClient
-
Query for databases.
- queryDatabases(String, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosClient
-
Query a Cosmos database.
- queryItems(SqlQuerySpec, CosmosQueryRequestOptions, Class<T>) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Query for items in the current container using a
SqlQuerySpec
andCosmosQueryRequestOptions
. - queryItems(SqlQuerySpec, CosmosQueryRequestOptions, Class<T>) - Method in class com.azure.cosmos.CosmosContainer
-
Query items in the current container returning the results as
CosmosPagedIterable
. - queryItems(SqlQuerySpec, Class<T>) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Query for items in the current container using a
SqlQuerySpec
. - queryItems(String, CosmosQueryRequestOptions, Class<T>) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Query for items in the current container using a string.
- queryItems(String, CosmosQueryRequestOptions, Class<T>) - Method in class com.azure.cosmos.CosmosContainer
-
Query items in the current container returning the results as
CosmosPagedIterable
. - queryItems(String, Class<T>) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Query for items in the current container.
- queryPermissions(String) - Method in class com.azure.cosmos.CosmosAsyncUser
-
Query for permissions.
- queryPermissions(String, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncUser
-
Query for permissions.
- queryStoredProcedures(SqlQuerySpec, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncScripts
-
Query for stored procedures in a container.
- queryStoredProcedures(SqlQuerySpec, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosScripts
-
Query stored procedures
CosmosPagedIterable
. - queryStoredProcedures(String, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncScripts
-
Query for stored procedures in a container.
- queryStoredProcedures(String, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosScripts
-
Query stored procedures
CosmosPagedIterable
. - queryTriggers(SqlQuerySpec, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncScripts
-
Query for triggers in the container
- queryTriggers(SqlQuerySpec, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosScripts
-
Query triggers
CosmosPagedIterable
. - queryTriggers(String, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncScripts
-
Query for triggers in the container
- queryTriggers(String, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosScripts
-
Query triggers
CosmosPagedIterable
. - queryUserDefinedFunctions(SqlQuerySpec, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncScripts
-
Query for user defined functions in the container.
- queryUserDefinedFunctions(SqlQuerySpec, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosScripts
-
Query user defined functions
CosmosPagedIterable
. - queryUserDefinedFunctions(String, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncScripts
-
Query for user defined functions in the container.
- queryUserDefinedFunctions(String, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosScripts
-
Query user defined functions
CosmosPagedIterable
. - queryUsers(SqlQuerySpec) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Query for cosmos users in a database.
- queryUsers(SqlQuerySpec) - Method in class com.azure.cosmos.CosmosDatabase
-
Query all Cosmos users for the current database.
- queryUsers(SqlQuerySpec, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Query for cosmos users in a database.
- queryUsers(SqlQuerySpec, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosDatabase
-
Query all Cosmos users for the current database.
- queryUsers(String) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Query for cosmos users in a database.
- queryUsers(String) - Method in class com.azure.cosmos.CosmosDatabase
-
Query all Cosmos users for the current database.
- queryUsers(String, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Query for cosmos users in a database.
- queryUsers(String, CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosDatabase
-
Query all Cosmos users for the current database.
R
- RANGE - Enum constant in enum com.azure.cosmos.models.PartitionKind
-
The Partition of an item is calculated based on a range.
- read() - Method in class com.azure.cosmos.CosmosAsyncClientEncryptionKey
-
Reads a cosmos client encryption key
- read() - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Reads the current container.
- read() - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Reads a database.
- read() - Method in class com.azure.cosmos.CosmosAsyncStoredProcedure
-
Read a stored procedure
- read() - Method in class com.azure.cosmos.CosmosAsyncTrigger
-
Reads a cosmos trigger
- read() - Method in class com.azure.cosmos.CosmosAsyncUser
-
Reads a cosmos user
- read() - Method in class com.azure.cosmos.CosmosAsyncUserDefinedFunction
-
Read a user defined function.
- read() - Method in class com.azure.cosmos.CosmosClientEncryptionKey
-
Reads a cosmos client encryption key
- read() - Method in class com.azure.cosmos.CosmosContainer
-
Reads the current container.
- read() - Method in class com.azure.cosmos.CosmosDatabase
-
Reads the current Cosmos database.
- read() - Method in class com.azure.cosmos.CosmosStoredProcedure
-
Read cosmos sync stored procedure.
- read() - Method in class com.azure.cosmos.CosmosTrigger
-
Read cosmos trigger.
- read() - Method in class com.azure.cosmos.CosmosUser
-
Read cosmos user
- read() - Method in class com.azure.cosmos.CosmosUserDefinedFunction
-
Read cosmos user defined function.
- read(CosmosConflictRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncConflict
-
Reads a conflict.
- read(CosmosContainerRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Reads the current container while specifying additional options such as If-Match.
- read(CosmosContainerRequestOptions) - Method in class com.azure.cosmos.CosmosContainer
-
Reads the current container while specifying additional options such as If-Match.
- read(CosmosDatabaseRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Reads a database.
- read(CosmosDatabaseRequestOptions) - Method in class com.azure.cosmos.CosmosDatabase
-
Reads the current Cosmos database while specifying additional request options.
- read(CosmosPermissionRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncPermission
-
Reads a permission.
- read(CosmosStoredProcedureRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncStoredProcedure
-
Read a stored procedure
- read(CosmosStoredProcedureRequestOptions) - Method in class com.azure.cosmos.CosmosStoredProcedure
-
Read cosmos sync stored procedure.
- READ - Enum constant in enum com.azure.cosmos.models.CosmosItemOperationType
-
Read operation type.
- READ - Enum constant in enum com.azure.cosmos.models.PermissionMode
-
Permission applicable for read operations only.
- readAllClientEncryptionKeys() - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Reads all cosmos client encryption keys in a database.
- readAllClientEncryptionKeys() - Method in class com.azure.cosmos.CosmosDatabase
-
Reads all cosmos client encryption keys in a database.
- readAllClientEncryptionKeys(CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Reads all cosmos client encryption keys in a database.
- readAllConflicts(CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Lists all the conflicts in the current container.
- readAllContainers() - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Reads all cosmos containers.
- readAllContainers() - Method in class com.azure.cosmos.CosmosDatabase
-
Read all containers in the current database.
- readAllContainers(CosmosQueryRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Reads all cosmos containers.
- readAllDatabases() - Method in class com.azure.cosmos.CosmosAsyncClient
-
Reads all databases.
- readAllDatabases() - Method in class com.azure.cosmos.CosmosClient
-
Reads all Cosmos databases.
- readAllItems(PartitionKey, CosmosQueryRequestOptions, Class<T>) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Reads all the items of a logical partition
- readAllItems(PartitionKey, CosmosQueryRequestOptions, Class<T>) - Method in class com.azure.cosmos.CosmosContainer
-
Reads all the items of a logical partition returning the results as
CosmosPagedIterable
. - readAllItems(PartitionKey, Class<T>) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Reads all the items of a logical partition
- readAllItems(PartitionKey, Class<T>) - Method in class com.azure.cosmos.CosmosContainer
-
Reads all the items of a logical partition returning the results as
CosmosPagedIterable
. - readAllPermissions() - Method in class com.azure.cosmos.CosmosAsyncUser
-
Reads all permissions.
- readAllStoredProcedures() - Method in class com.azure.cosmos.CosmosAsyncScripts
-
Reads all cosmos stored procedures in a container.
- readAllStoredProcedures() - Method in class com.azure.cosmos.CosmosScripts
-
Read all stored procedures
CosmosPagedIterable
. - readAllTriggers() - Method in class com.azure.cosmos.CosmosAsyncScripts
-
Reads all triggers in a container
- readAllTriggers() - Method in class com.azure.cosmos.CosmosScripts
-
Read all triggers
CosmosPagedIterable
. - readAllUserDefinedFunctions() - Method in class com.azure.cosmos.CosmosAsyncScripts
-
Reads all cosmos user defined functions in the container
- readAllUserDefinedFunctions() - Method in class com.azure.cosmos.CosmosScripts
-
Read all user defined functions
CosmosPagedIterable
. - readAllUsers() - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Reads all cosmos users in a database.
- readAllUsers() - Method in class com.azure.cosmos.CosmosDatabase
-
Read all Cosmos users for the current database.
- readItem(String, PartitionKey, CosmosItemRequestOptions, Class<T>) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Reads an item by itemId using a configured
CosmosItemRequestOptions
. - readItem(String, PartitionKey, CosmosItemRequestOptions, Class<T>) - Method in class com.azure.cosmos.CosmosContainer
-
Reads an item in the current container while specifying additional options.
- readItem(String, PartitionKey, Class<T>) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Reads an item by itemId.
- readItem(String, PartitionKey, Class<T>) - Method in class com.azure.cosmos.CosmosContainer
-
Reads an item in the current container.
- readItemOperation(String) - Method in class com.azure.cosmos.models.CosmosBatch
-
Adds an operation to read an item into the batch.
- readItemOperation(String, CosmosBatchItemRequestOptions) - Method in class com.azure.cosmos.models.CosmosBatch
-
Adds an operation to read an item into the batch.
- readMany(List<CosmosItemIdentity>, CosmosReadManyRequestOptions, Class<T>) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Reads many documents.
- readMany(List<CosmosItemIdentity>, CosmosReadManyRequestOptions, Class<T>) - Method in class com.azure.cosmos.CosmosContainer
-
Reads many documents.
- readMany(List<CosmosItemIdentity>, Class<T>) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Reads many documents.
- readMany(List<CosmosItemIdentity>, Class<T>) - Method in class com.azure.cosmos.CosmosContainer
-
Reads many documents.
- readMany(List<CosmosItemIdentity>, String, Class<T>) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Reads many documents.
- readMany(List<CosmosItemIdentity>, String, Class<T>) - Method in class com.azure.cosmos.CosmosContainer
-
Reads many documents.
- readRequestsFallbackEnabled(boolean) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets whether to allow for reads to go to multiple regions configured on an account of Azure Cosmos DB service.
- readThroughput() - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Read the throughput provisioned for the current container.
- readThroughput() - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Gets the throughput of the database.
- readThroughput() - Method in class com.azure.cosmos.CosmosContainer
-
Gets the throughput for the current container.
- readThroughput() - Method in class com.azure.cosmos.CosmosDatabase
-
Gets the throughput of the current database.
- REGION_NAME - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
The region names of the regions handling the operation/request Applicable to requests and operations
- regionSwitchHint(CosmosRegionSwitchHint) - Method in class com.azure.cosmos.SessionRetryOptionsBuilder
-
Sets the
CosmosRegionSwitchHint
which specifies for a request whether internal retry policies should prioritize a local region or a remote region. - REMOTE_REGION_PREFERRED - Static variable in class com.azure.cosmos.CosmosRegionSwitchHint
-
CosmosRegionSwitchHint.REMOTE_REGION_PREFERRED
corresponds to a hint which will result in internal retry policies biasing remote regions more than the local region. - remove(String) - Method in class com.azure.cosmos.models.CosmosPatchOperations
-
This removes the value at the target location.
- removeMetricCategories(CosmosMetricCategory...) - Method in class com.azure.cosmos.models.CosmosMicrometerMetricsOptions
-
Removes categories of metrics that should be emitted.
- replace(CosmosClientEncryptionKeyProperties) - Method in class com.azure.cosmos.CosmosAsyncClientEncryptionKey
-
Replace a cosmos client encryption key.
- replace(CosmosContainerProperties) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Replaces the current container's properties.
- replace(CosmosContainerProperties) - Method in class com.azure.cosmos.CosmosContainer
-
Replaces the current container properties.
- replace(CosmosContainerProperties, CosmosContainerRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Replaces the current container properties while using non-default request options.
- replace(CosmosContainerProperties, CosmosContainerRequestOptions) - Method in class com.azure.cosmos.CosmosContainer
-
Replaces the current container properties while specifying additional options such as If-Match.
- replace(CosmosPermissionProperties, CosmosPermissionRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncPermission
-
Replaces a permission.
- replace(CosmosStoredProcedureProperties) - Method in class com.azure.cosmos.CosmosAsyncStoredProcedure
-
Replaces a stored procedure.
- replace(CosmosStoredProcedureProperties) - Method in class com.azure.cosmos.CosmosStoredProcedure
-
Replace cosmos sync stored procedure.
- replace(CosmosStoredProcedureProperties, CosmosStoredProcedureRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncStoredProcedure
-
Replaces a stored procedure.
- replace(CosmosStoredProcedureProperties, CosmosStoredProcedureRequestOptions) - Method in class com.azure.cosmos.CosmosStoredProcedure
-
Replace cosmos sync stored procedure.
- replace(CosmosTriggerProperties) - Method in class com.azure.cosmos.CosmosAsyncTrigger
-
Replaces a cosmos trigger.
- replace(CosmosTriggerProperties) - Method in class com.azure.cosmos.CosmosTrigger
-
Replace cosmos trigger.
- replace(CosmosUserDefinedFunctionProperties) - Method in class com.azure.cosmos.CosmosAsyncUserDefinedFunction
-
Replaces a cosmos user defined function.
- replace(CosmosUserDefinedFunctionProperties) - Method in class com.azure.cosmos.CosmosUserDefinedFunction
-
Replace cosmos user defined function.
- replace(CosmosUserProperties) - Method in class com.azure.cosmos.CosmosAsyncUser
-
Replace a cosmos user
- replace(CosmosUserProperties) - Method in class com.azure.cosmos.CosmosUser
-
Replace cosmos user.
- replace(String, T) - Method in class com.azure.cosmos.models.CosmosPatchOperations
-
This replaces the value at the target location with a new value.
- REPLACE - Enum constant in enum com.azure.cosmos.models.ChangeFeedOperationType
-
Represents Replace operation
- REPLACE - Enum constant in enum com.azure.cosmos.models.CosmosItemOperationType
-
Replace operation type.
- REPLACE - Enum constant in enum com.azure.cosmos.models.TriggerOperation
-
REPLACE operations only.
- replaceItem(T, String, PartitionKey) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Replaces an existing item in a container with a new item.
- replaceItem(T, String, PartitionKey, CosmosItemRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Replaces an existing item in a container with a new item.
- replaceItem(T, String, PartitionKey, CosmosItemRequestOptions) - Method in class com.azure.cosmos.CosmosContainer
-
Replaces an existing item in a container with a new item.
- replaceItemOperation(String, T) - Method in class com.azure.cosmos.models.CosmosBatch
-
Adds an operation to replace an item into the batch.
- replaceItemOperation(String, T, CosmosBatchItemRequestOptions) - Method in class com.azure.cosmos.models.CosmosBatch
-
Adds an operation to replace an item into the batch.
- replaceThroughput(ThroughputProperties) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Replace the throughput.
- replaceThroughput(ThroughputProperties) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Sets throughput provisioned for a container in measurement of Requests-per-Unit in the Azure Cosmos service.
- replaceThroughput(ThroughputProperties) - Method in class com.azure.cosmos.CosmosContainer
-
Sets the throughput for the current container.
- replaceThroughput(ThroughputProperties) - Method in class com.azure.cosmos.CosmosDatabase
-
Sets the throughput of the current database.
- REPLICA_ID - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
The ReplicaId (int identifier plus suffix "s" (secondary - read-only - replica) or "p" (primary- write - replica) Applicable to requests
- REQUEST_DETAILS - Static variable in class com.azure.cosmos.models.CosmosMetricCategory
-
The metrics in the RequestDetails category emit additional end-to-end metrics (like timeline metrics showing where in the request pipeline latency was spent etc.) for physical network requests - they have tags allowing to distinguish by service endpoint in the backend as well as the client-machine.
- REQUEST_DETAILS_DIRECT_TIMELINE - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Latency in different steps of the request pipeline (Timer)
- REQUEST_DETAILS_GATEWAY_TIMELINE - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Latency in different steps of the request pipeline (Timer)
- REQUEST_OPERATION_TYPE - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
Request operation type Applicable to requests
- REQUEST_STATUS_CODE - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
Request status code Applicable to requests
- REQUEST_SUMMARY - Static variable in class com.azure.cosmos.models.CosmosMetricCategory
-
The metrics in the RequestSummary category emit most important end-to-end metrics (like latency, request rate, request charge, request- and response-payload size etc.) for physical network requests - they have tags allowing to distinguish by service endpoint in the backend as well as the client-machine.
- REQUEST_SUMMARY_DIRECT_ACTUAL_ITEM_COUNT - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Actual item count - relevant for non-point-operations - indicating the actual number of docs returned in the response (DistributionSummary) NOTE: No percentiles or histogram supported
- REQUEST_SUMMARY_DIRECT_BACKEND_LATENCY - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Backend-latency of the request (DistributionSummary)
- REQUEST_SUMMARY_DIRECT_LATENCY - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Latency of the request (Timer)
- REQUEST_SUMMARY_DIRECT_REQUEST_CHARGE - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Request charge for a request (DistributionSummary)
- REQUEST_SUMMARY_DIRECT_REQUESTS - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Number of requests (Counter) NOTE: No percentiles or histogram supported
- REQUEST_SUMMARY_GATEWAY_ACTUAL_ITEM_COUNT - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Actual item count - relevant for non-point-operations - indicating the actual number of docs returned in the response (DistributionSummary) NOTE: No percentiles or histogram supported
- REQUEST_SUMMARY_GATEWAY_LATENCY - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Latency of the request (Timer)
- REQUEST_SUMMARY_GATEWAY_REQUEST_CHARGE - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Request charge for a request (DistributionSummary)
- REQUEST_SUMMARY_GATEWAY_REQUESTS - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Number of requests (Counter) NOTE: No percentiles or histogram supported
- REQUEST_SUMMARY_SIZE_REQUEST - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Size of the request payload (DistributionSummary) NOTE: No percentiles or histogram supported
- REQUEST_SUMMARY_SIZE_RESPONSE - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Size of the response payload (DistributionSummary) NOTE: No percentiles or histogram supported
- resourceToken(String) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets a resource token used to perform authentication for accessing resource.
S
- sampleDiagnostics(double) - Method in class com.azure.cosmos.models.CosmosClientTelemetryConfig
-
Can be used to enable sampling for capturing all diagnostics to reduce/disable any client resource overhead (CPU and/or memory).
- sendClientTelemetryToService(boolean) - Method in class com.azure.cosmos.models.CosmosClientTelemetryConfig
-
Enables or disables sending Cosmos DB client telemetry to the Azure Cosmos DB Service
- serialize(T) - Method in class com.azure.cosmos.CosmosItemSerializer
-
Used to serialize a POJO into a json tree
- SERVICE_ADDRESS - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
The service endpoint (hostname + port, partitionId, replicaId) Applicable to requests
- SERVICE_ENDPOINT - Static variable in class com.azure.cosmos.models.CosmosMetricTagName
-
The service endpoint (hostname + port) Applicable to requests, direct channel, direct endpoint and direct requests
- SESSION - Enum constant in enum com.azure.cosmos.ConsistencyLevel
-
SESSION Consistency guarantees monotonic reads (you never read old data, then new, then old again), monotonic writes (writes are ordered) and read your writes (your writes are immediately visible to your reads) within any single session.
- sessionCapturingOverrideEnabled(boolean) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Session capturing is enabled by default for
ConsistencyLevel.SESSION
. - sessionRetryOptions(SessionRetryOptions) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the
SessionRetryOptions
instance on the client. - SessionRetryOptions - Class in com.azure.cosmos
-
SessionRetryOptions
encapsulates hints which influence internal retry policies which are applied when the effective consistency used for the request is Session Consistency. - SessionRetryOptionsBuilder - Class in com.azure.cosmos
-
A
SessionRetryOptionsBuilder
instance will be used to build aSessionRetryOptions
instance. - SessionRetryOptionsBuilder() - Constructor for class com.azure.cosmos.SessionRetryOptionsBuilder
- set(String, T) - Method in class com.azure.cosmos.models.CosmosPatchOperations
-
This sets the value at the target location with a new value.
- setAggressiveWarmupDuration(Duration) - Method in class com.azure.cosmos.CosmosContainerProactiveInitConfigBuilder
-
Sets the time window represented as a
Duration
within which connections will be opened aggressively and in a blocking manner and outside which connections will be opened defensively and in a non-blocking manner - setAnalyticalStoreTimeToLiveInSeconds(Integer) - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Sets the analytical store time to live in seconds for items in a container from the Azure Cosmos DB service.
- setAutomatic(boolean) - Method in class com.azure.cosmos.models.IndexingPolicy
-
Sets whether automatic indexing is enabled for a container.
- setBody(String) - Method in class com.azure.cosmos.models.CosmosStoredProcedureProperties
-
Set the body of the stored procedure.
- setBody(String) - Method in class com.azure.cosmos.models.CosmosTriggerProperties
-
Set the body of the trigger.
- setBody(String) - Method in class com.azure.cosmos.models.CosmosUserDefinedFunctionProperties
-
Set the body of the user defined function.
- setChangeFeedPolicy(ChangeFeedPolicy) - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Sets the changeFeedPolicy for this container in the Azure Cosmos DB service.
- setClientEncryptionKeyId(String) - Method in class com.azure.cosmos.models.ClientEncryptionIncludedPath
-
Sets the identifier of the Data Encryption Key to be used to encrypt the path.
- setClientEncryptionPolicy(ClientEncryptionPolicy) - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Sets the ClientEncryptionPolicy that is used for encrypting item fields
- setCompositeIndexes(List<List<CompositePath>>) - Method in class com.azure.cosmos.models.IndexingPolicy
-
Sets the composite indexes for additional indexes.
- setComputedProperties(Collection<ComputedProperty>) - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Sets the computedProperties for this container in the Azure Cosmos DB service.
- setConflictResolutionPolicy(ConflictResolutionPolicy) - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Sets the conflictResolutionPolicy that is used for resolving conflicting writes on items in different regions, in a container in the Azure Cosmos DB service.
- setConnectionEndpointRediscoveryEnabled(boolean) - Method in class com.azure.cosmos.DirectConnectionConfig
-
Sets a value indicating whether Direct TCP connection endpoint rediscovery should be enabled.
- setConnectTimeout(Duration) - Method in class com.azure.cosmos.DirectConnectionConfig
-
Sets the connect timeout for direct client, represents timeout for establishing connections with an endpoint.
- setConsistencyLevel(ConsistencyLevel) - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Sets the consistency level required for the request.
- setConsistencyLevel(ConsistencyLevel) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Sets the consistency level required for the request.
- setConsistencyLevel(ConsistencyLevel) - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Sets the consistency level required for the request.
- setConsistencyLevel(ConsistencyLevel) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the consistency level.
- setContainerName(String) - Method in class com.azure.cosmos.models.CosmosPermissionProperties
-
Sets the name of the Cosmos container as the parent resource which is associated with this permission object.
- setContentResponseOnWriteEnabled(Boolean) - Method in class com.azure.cosmos.models.CosmosBulkItemRequestOptions
-
Sets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations in
CosmosItemOperation
. - setContentResponseOnWriteEnabled(Boolean) - Method in class com.azure.cosmos.models.CosmosBulkPatchItemRequestOptions
-
Sets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations in
CosmosItemOperation
. - setContentResponseOnWriteEnabled(Boolean) - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Sets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations on CosmosItem.
- setContentResponseOnWriteEnabled(Boolean) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the content response on write enabled.
- setContinuationToken(String) - Method in class com.azure.cosmos.models.ChangeFeedProcessorState
-
Sets a marker representing the last item that was processed.
- setControlItemExpireInterval(Duration) - Method in class com.azure.cosmos.GlobalThroughputControlConfigBuilder
-
Set the control item expire interval.
- setControlItemRenewInterval(Duration) - Method in class com.azure.cosmos.GlobalThroughputControlConfigBuilder
-
Set the control item renew interval.
- setCosmosEndToEndLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the CosmosEndToEndLatencyPolicyConfig.
- setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig) - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Sets the
CosmosEndToEndOperationLatencyPolicyConfig
to be used for the request. - setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Sets the
CosmosEndToEndOperationLatencyPolicyConfig
to be used for the request. - setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig) - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Sets the
CosmosEndToEndOperationLatencyPolicyConfig
to be used for the request. - setCosmosVectorEmbeddings(List<CosmosVectorEmbedding>) - Method in class com.azure.cosmos.models.CosmosVectorEmbeddingPolicy
-
Sets the paths for embeddings along with path-specific settings for the item.
- setCustomItemSerializer(CosmosItemSerializer) - Method in class com.azure.cosmos.models.CosmosBatchRequestOptions
-
Allows specifying a custom item serializer to be used for this operation.
- setCustomItemSerializer(CosmosItemSerializer) - Method in class com.azure.cosmos.models.CosmosBulkExecutionOptions
-
Allows specifying a custom item serializer to be used for this operation.
- setCustomItemSerializer(CosmosItemSerializer) - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Allows specifying a custom item serializer to be used for this operation.
- setCustomItemSerializer(CosmosItemSerializer) - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Allows specifying a custom item serializer to be used for this operation.
- setCustomItemSerializer(CosmosItemSerializer) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Allows specifying a custom item serializer to be used for this operation.
- setCustomItemSerializer(CosmosItemSerializer) - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Allows specifying a custom item serializer to be used for this operation.
- setDataType(CosmosVectorDataType) - Method in class com.azure.cosmos.models.CosmosVectorEmbedding
-
Sets the data type for the cosmosVectorEmbedding.
- setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions) - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Sets the Dedicated Gateway Request Options
- setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Sets the Dedicated Gateway Request Options
- setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions) - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Sets the Dedicated Gateway Request Options
- setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the DedicatedGatewayRequestOptions.
- setDefault(boolean) - Method in class com.azure.cosmos.ThroughputControlGroupConfigBuilder
-
Deprecated.
- setDefaultTimeToLiveInSeconds(Integer) - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Sets the container's default time-to-live value.
- setDiagnosticsThresholds(CosmosDiagnosticsThresholds) - Method in class com.azure.cosmos.models.CosmosBatchRequestOptions
-
Allows overriding the diagnostic thresholds for a specific operation.
- setDiagnosticsThresholds(CosmosDiagnosticsThresholds) - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Allows overriding the diagnostic thresholds for a specific operation.
- setDiagnosticsThresholds(CosmosDiagnosticsThresholds) - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Allows overriding the diagnostic thresholds for a specific operation.
- setDiagnosticsThresholds(CosmosDiagnosticsThresholds) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Allows overriding the diagnostic thresholds for a specific operation.
- setDiagnosticsThresholds(CosmosDiagnosticsThresholds) - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Allows overriding the diagnostic thresholds for a specific operation.
- setDiagnosticsThresholds(CosmosDiagnosticsThresholds) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the CosmosDiagnosticsThresholds.
- setDimensions(Long) - Method in class com.azure.cosmos.models.CosmosVectorEmbedding
-
Sets the dimensions for the cosmosVectorEmbedding.
- setDistanceFunction(CosmosVectorDistanceFunction) - Method in class com.azure.cosmos.models.CosmosVectorEmbedding
-
Sets the distanceFunction for the cosmosVectorEmbedding.
- setEnabled(boolean) - Method in class com.azure.cosmos.models.CosmosMicrometerMeterOptions
-
Enables or disables this meter.
- setEnabled(boolean) - Method in class com.azure.cosmos.models.CosmosMicrometerMetricsOptions
- setEnabled(boolean) - Method in class com.azure.cosmos.NonIdempotentWriteRetryOptions
-
Specifies whether automatic retries for write operations even when they are not guaranteed to be idempotent are enabled.
- setEncryptionAlgorithm(String) - Method in class com.azure.cosmos.models.ClientEncryptionIncludedPath
-
Sets the type of encryption algorithm to be performed.
- setEncryptionAlgorithm(String) - Method in class com.azure.cosmos.models.CosmosClientEncryptionKeyProperties
-
Sets the encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.
- setEncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata) - Method in class com.azure.cosmos.models.CosmosClientEncryptionKeyProperties
-
Sets the metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.
- setEncryptionType(String) - Method in class com.azure.cosmos.models.ClientEncryptionIncludedPath
-
Sets the type of encryption to be performed.
- setEstimatedLag(int) - Method in class com.azure.cosmos.models.ChangeFeedProcessorState
-
Sets the estimated lag.
- setExcludedPaths(List<ExcludedPath>) - Method in class com.azure.cosmos.models.IndexingPolicy
-
Sets excluded paths.
- setExcludedRegions(List<String>) - Method in class com.azure.cosmos.models.CosmosBatchRequestOptions
-
List of regions to exclude for the request/retries.
- setExcludedRegions(List<String>) - Method in class com.azure.cosmos.models.CosmosBulkExecutionOptions
-
List of regions to exclude for the request/retries.
- setExcludedRegions(List<String>) - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
List of regions to exclude for the request/retries.
- setExcludedRegions(List<String>) - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
List of regions to exclude for the request/retries.
- setExcludedRegions(List<String>) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
List of regions to be excluded for the request/retries.
- setExcludedRegions(List<String>) - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
List of regions to be excluded for the request/retries.
- setExcludeRegions(List<String>) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the exclude regions.
- setFailureHandler(BiPredicate<Integer, Integer>) - Method in class com.azure.cosmos.CosmosDiagnosticsThresholds
-
Can be used to customize the logic determining whether the outcome of an operation (based on statusCode + subStatusCode) is considered a failure (and diagnostics will be emitted) or not.
- setFeedPollDelay(Duration) - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Sets the delay in between polling a partition for new changes on the feed, after all current changes are drained.
- setFeedPollThroughputControlConfig(ThroughputControlGroupConfig) - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Set the feed poll local throughput control config.
- setFeedRange(FeedRange) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Sets the
FeedRange
that we want to query - setFilterPredicate(String) - Method in class com.azure.cosmos.models.CosmosBatchPatchItemRequestOptions
-
Sets the FilterPredicate associated with the request in the Azure Cosmos DB service.
- setFilterPredicate(String) - Method in class com.azure.cosmos.models.CosmosBulkPatchItemRequestOptions
-
Sets the FilterPredicate associated with the request in the Azure Cosmos DB service.
- setFilterPredicate(String) - Method in class com.azure.cosmos.models.CosmosPatchItemRequestOptions
-
Sets the FilterPredicate associated with the request in the Azure Cosmos DB service.
- setGroupName(String) - Method in class com.azure.cosmos.ThroughputControlGroupConfigBuilder
-
Deprecated.
- setHostName(String) - Method in class com.azure.cosmos.models.ChangeFeedProcessorState
-
Sets the name of the host which operates on the lease item.
- setId(String) - Method in class com.azure.cosmos.models.CosmosClientEncryptionKeyProperties
-
Sets the name of the resource.
- setId(String) - Method in class com.azure.cosmos.models.CosmosConflictProperties
-
Sets the name of the resource.
- setId(String) - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Sets the name of the resource.
- setId(String) - Method in class com.azure.cosmos.models.CosmosDatabaseProperties
-
Sets the name of the resource.
- setId(String) - Method in class com.azure.cosmos.models.CosmosPermissionProperties
-
Sets the name of the permission resource.
- setId(String) - Method in class com.azure.cosmos.models.CosmosStoredProcedureProperties
-
Sets the id
- setId(String) - Method in class com.azure.cosmos.models.CosmosTriggerProperties
-
Sets the id
- setId(String) - Method in class com.azure.cosmos.models.CosmosUserDefinedFunctionProperties
-
Sets the id
- setId(String) - Method in class com.azure.cosmos.models.CosmosUserProperties
-
Sets the id
- setIdleConnectionTimeout(Duration) - Method in class com.azure.cosmos.DirectConnectionConfig
-
Sets the idle connection timeout Default value is
Duration.ZERO
Direct client doesn't close a single connection to an endpoint by default unless specified. - setIdleConnectionTimeout(Duration) - Method in class com.azure.cosmos.GatewayConnectionConfig
-
sets the value of the timeout for an idle connection.
- setIdleEndpointTimeout(Duration) - Method in class com.azure.cosmos.DirectConnectionConfig
-
Sets the idle endpoint timeout Default value is 1 hour.
- setIfMatchETag(String) - Method in class com.azure.cosmos.models.CosmosBatchItemRequestOptions
-
Sets the If-Match (ETag) associated with the operation in CosmosBatch.
- setIfMatchETag(String) - Method in class com.azure.cosmos.models.CosmosBatchPatchItemRequestOptions
-
Sets the If-Match (ETag) associated with the operation in CosmosBatch.
- setIfMatchETag(String) - Method in class com.azure.cosmos.models.CosmosBulkItemRequestOptions
-
Sets the If-Match (ETag) associated with the operation in
CosmosItemOperation
. - setIfMatchETag(String) - Method in class com.azure.cosmos.models.CosmosBulkPatchItemRequestOptions
-
Sets the If-Match (ETag) associated with the operation in
CosmosItemOperation
. - setIfMatchETag(String) - Method in class com.azure.cosmos.models.CosmosConflictRequestOptions
-
Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
- setIfMatchETag(String) - Method in class com.azure.cosmos.models.CosmosContainerRequestOptions
-
Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
- setIfMatchETag(String) - Method in class com.azure.cosmos.models.CosmosDatabaseRequestOptions
-
Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
- setIfMatchETag(String) - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
- setIfMatchETag(String) - Method in class com.azure.cosmos.models.CosmosPermissionRequestOptions
-
Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
- setIfMatchETag(String) - Method in class com.azure.cosmos.models.CosmosStoredProcedureRequestOptions
-
Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service.
- setIfNoneMatchETag(String) - Method in class com.azure.cosmos.models.CosmosBatchItemRequestOptions
-
Sets the If-None-Match (ETag) associated with the request in operation in CosmosBatch.
- setIfNoneMatchETag(String) - Method in class com.azure.cosmos.models.CosmosBatchPatchItemRequestOptions
-
Sets the If-None-Match (ETag) associated with the request in operation in CosmosBatch.
- setIfNoneMatchETag(String) - Method in class com.azure.cosmos.models.CosmosBulkItemRequestOptions
-
Sets the If-None-Match (ETag) associated with the request in operation in
CosmosItemOperation
. - setIfNoneMatchETag(String) - Method in class com.azure.cosmos.models.CosmosBulkPatchItemRequestOptions
-
Sets the If-None-Match (ETag) associated with the request in operation in
CosmosItemOperation
. - setIfNoneMatchETag(String) - Method in class com.azure.cosmos.models.CosmosConflictRequestOptions
-
Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
- setIfNoneMatchETag(String) - Method in class com.azure.cosmos.models.CosmosContainerRequestOptions
-
Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
- setIfNoneMatchETag(String) - Method in class com.azure.cosmos.models.CosmosDatabaseRequestOptions
-
Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
- setIfNoneMatchETag(String) - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
- setIfNoneMatchETag(String) - Method in class com.azure.cosmos.models.CosmosPermissionRequestOptions
-
Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
- setIfNoneMatchETag(String) - Method in class com.azure.cosmos.models.CosmosStoredProcedureRequestOptions
-
Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service.
- setIncludedPaths(List<IncludedPath>) - Method in class com.azure.cosmos.models.IndexingPolicy
-
Sets included paths.
- setIndexingDirective(IndexingDirective) - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Sets the indexing directive (index, do not index etc).
- setIndexingMode(IndexingMode) - Method in class com.azure.cosmos.models.IndexingPolicy
-
Sets the indexing mode (consistent or lazy).
- setIndexingPolicy(IndexingPolicy) - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Sets the container's indexing policy
- setIndexMetricsEnabled(boolean) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Sets indexMetricsEnabled, which is used to obtain the index metrics to understand how the query engine used existing indexes and could use potential new indexes.
- setIndexMetricsEnabled(boolean) - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Sets indexMetricsEnabled, which is used to obtain the index metrics to understand how the query engine used existing indexes and could use potential new indexes.
- setIndexMetricsEnabled(Boolean) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the IndexMetricsEnabled.
- setInitialMicroBatchSize(int) - Method in class com.azure.cosmos.models.CosmosBulkExecutionOptions
-
Sets the initial size of micro batches that will be sent to the backend.
- setIntegratedCacheBypassed(boolean) - Method in class com.azure.cosmos.models.DedicatedGatewayRequestOptions
-
Sets if integrated cache should be enabled or bypassed for the request in Azure CosmosDB service.
- setKeywordIdentifiers(Set<String>) - Method in class com.azure.cosmos.models.CosmosBatchRequestOptions
-
Sets the custom ids.
- setKeywordIdentifiers(Set<String>) - Method in class com.azure.cosmos.models.CosmosBulkExecutionOptions
-
Sets the custom ids.
- setKeywordIdentifiers(Set<String>) - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Sets the custom ids.
- setKeywordIdentifiers(Set<String>) - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Sets the custom ids.
- setKeywordIdentifiers(Set<String>) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Sets the custom ids.
- setKeywordIdentifiers(Set<String>) - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Sets the custom ids.
- setKeywordIdentifiers(Set<String>) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the keywordIdentifiers.
- setKind(PartitionKind) - Method in class com.azure.cosmos.models.PartitionKeyDefinition
-
Sets the partition algorithm used to calculate the partition id given a partition key.
- setLeaseAcquireInterval(Duration) - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Sets he interval to kick off a task to compute if partitions are distributed evenly among known host instances.
- setLeaseExpirationInterval(Duration) - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Sets the interval for which the lease is taken on a lease representing a partition.
- setLeasePrefix(String) - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Sets a prefix to be used as part of the lease ID.
- setLeaseRenewInterval(Duration) - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Sets the renew interval for all leases for partitions currently held by
ChangeFeedProcessor
instance. - setLeaseToken(String) - Method in class com.azure.cosmos.models.ChangeFeedProcessorState
-
Sets the token of the lease item representing the persistent state of a change feed processor worker.
- setMaxBufferedItemCount(int) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Sets the maximum number of items that can be buffered client side during parallel query execution.
- setMaxBufferedItemCount(Integer) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the MaxBufferedItemCount.
- setMaxConnectionPoolSize(int) - Method in class com.azure.cosmos.GatewayConnectionConfig
-
Sets the value of the connection pool size, the default is 1000.
- setMaxConnectionsPerEndpoint(int) - Method in class com.azure.cosmos.DirectConnectionConfig
-
Sets the max connections per endpoint This represents the size of connection pool for a specific endpoint Default value is 130
- setMaxDegreeOfParallelism(int) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Sets the number of concurrent operations run client side during parallel query execution.
- setMaxDegreeOfParallelism(Integer) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the MaxDegreeOfParallelism.
- setMaxIntegratedCacheStaleness(Duration) - Method in class com.azure.cosmos.models.DedicatedGatewayRequestOptions
-
Sets the staleness value associated with the request in the Azure CosmosDB service.
- setMaxItemCount(int) - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Sets the maximum number of items to be returned in the enumeration operation.
- setMaxItemCount(int) - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Sets the maximum number of items to be returned in the enumeration operation.
- setMaxItemCount(Integer) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the MaxItemCount.
- setMaxMicroBatchConcurrency(int) - Method in class com.azure.cosmos.models.CosmosBulkExecutionOptions
-
Set the maximum concurrency for executing requests for a partition key range.
- setMaxMicroBatchSize(int) - Method in class com.azure.cosmos.models.CosmosBulkExecutionOptions
-
The maximum batch size for bulk operations.
- setMaxPrefetchPageCount(int) - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Sets the maximum number of pages that will be prefetched from the backend asynchronously in the background.
- setMaxPrefetchPageCount(Integer) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the MaxPrefetchPageCount.
- setMaxRequestsPerConnection(int) - Method in class com.azure.cosmos.DirectConnectionConfig
-
Sets the max requests per connection This represents the number of requests that will be queued on a single connection for a specific endpoint Default value is 30
- setMaxRetryAttemptsOnThrottledRequests(int) - Method in class com.azure.cosmos.ThrottlingRetryOptions
-
Sets the maximum number of retries in the case where the request fails because the service has applied rate limiting on the client.
- setMaxRetryWaitTime(Duration) - Method in class com.azure.cosmos.ThrottlingRetryOptions
-
Sets the maximum retry time in seconds.
- setMaxScaleCount(int) - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Sets the maximum number of partitions (parallel workers) the host can run.
- setMetricCategories(CosmosMetricCategory...) - Method in class com.azure.cosmos.models.CosmosMicrometerMetricsOptions
-
Sets the categories of metrics that should be emitted.
- setMinScaleCount(int) - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Sets the minimum partition count (parallel workers) for the current host.
- setName(String) - Method in class com.azure.cosmos.models.SqlParameter
-
Sets the name of the parameter.
- setNetworkRequestTimeout(Duration) - Method in class com.azure.cosmos.DirectConnectionConfig
-
Sets the network request timeout interval (time to wait for response from network peer).
- setNonIdempotentWriteRetriesEnabled(Boolean) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the NonIdempotentWriteRetriesEnabled.
- setNonIdempotentWriteRetryPolicy(boolean, boolean) - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Enables automatic retries for write operations even when the SDK can't guarantee that they are idempotent.
- setNonPointOperationLatencyThreshold(Duration) - Method in class com.azure.cosmos.CosmosDiagnosticsThresholds
-
Can be used to define custom latency thresholds.
- setOrder(CompositePathSortOrder) - Method in class com.azure.cosmos.models.CompositePath
-
Sets the sort order for the composite path.
- setParameters(List<SqlParameter>) - Method in class com.azure.cosmos.models.SqlQuerySpec
-
Sets the container of query parameters.
- setPartitionKey(PartitionKey) - Method in class com.azure.cosmos.models.CosmosConflictRequestOptions
-
Sets the partition key associated with the request in the Azure Cosmos DB service.
- setPartitionKey(PartitionKey) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Sets the partition key used to identify the current request's target partition.
- setPartitionKey(PartitionKey) - Method in class com.azure.cosmos.models.CosmosStoredProcedureRequestOptions
-
Sets the partition key used to identify the current request's target partition.
- setPartitionKeyDefinition(PartitionKeyDefinition) - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Sets the containers's partition key definition.
- setPath(String) - Method in class com.azure.cosmos.models.ClientEncryptionIncludedPath
-
Sets the path to be encrypted.
- setPath(String) - Method in class com.azure.cosmos.models.CompositePath
-
Sets path.
- setPath(String) - Method in class com.azure.cosmos.models.CosmosVectorEmbedding
-
Sets the path for the cosmosVectorEmbedding.
- setPath(String) - Method in class com.azure.cosmos.models.CosmosVectorIndexSpec
-
Sets path.
- setPath(String) - Method in class com.azure.cosmos.models.ExcludedPath
-
Sets path.
- setPath(String) - Method in class com.azure.cosmos.models.IncludedPath
-
Sets path.
- setPath(String) - Method in class com.azure.cosmos.models.SpatialSpec
-
Sets path.
- setPaths(List<String>) - Method in class com.azure.cosmos.models.PartitionKeyDefinition
-
Sets the item property paths for the partition key.
- setPaths(List<String>) - Method in class com.azure.cosmos.models.UniqueKey
-
Sets the paths, a set of which must be unique for each item in the Azure Cosmos DB service.
- setPayloadSizeThreshold(int) - Method in class com.azure.cosmos.CosmosDiagnosticsThresholds
-
Can be used to define a payload size threshold.
- setPermissionMode(PermissionMode) - Method in class com.azure.cosmos.models.CosmosPermissionProperties
-
Sets the permission mode.
- setPointOperationLatencyThreshold(Duration) - Method in class com.azure.cosmos.CosmosDiagnosticsThresholds
-
Can be used to define custom latency thresholds.
- setPostTriggerInclude(List<String>) - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Sets the triggers to be invoked after the operation.
- setPreTriggerInclude(List<String>) - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Sets the triggers to be invoked before the operation.
- setProactiveConnectionRegionsCount(int) - Method in class com.azure.cosmos.CosmosContainerProactiveInitConfigBuilder
-
Sets the no.
- setProxy(ProxyOptions) - Method in class com.azure.cosmos.GatewayConnectionConfig
-
Sets the proxy options.
- setQueryMetricsEnabled(boolean) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Sets the option to enable/disable getting metrics relating to query execution on item query requests.
- setQueryMetricsEnabled(boolean) - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Sets the option to enable/disable getting metrics relating to query execution on item query requests.
- setQueryMetricsEnabled(Boolean) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the QueryMetricsEnabled.
- setQueryName(String) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Sets the logical query name - this identifier is only used for metrics and logs to distinguish different queries in telemetry.
- setQueryName(String) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the QueryName.
- setQueryText(String) - Method in class com.azure.cosmos.models.SqlQuerySpec
-
Sets the text of the query.
- setQuotaInfoEnabled(boolean) - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Gets the quotaInfoEnabled setting for change feed request in the Azure Cosmos DB database service.
- setQuotaInfoEnabled(boolean) - Method in class com.azure.cosmos.models.CosmosContainerRequestOptions
-
Sets the quotaInfoEnabled setting for cosmos container read requests in the Azure Cosmos DB database service.
- setRequestChargeThreshold(float) - Method in class com.azure.cosmos.CosmosDiagnosticsThresholds
-
Can be used to define a custom RU (request charge) threshold.
- setRequestOptions(CosmosRequestOptions) - Method in class com.azure.cosmos.models.CosmosOperationDetails
-
Applies the options in CosmosRequestOptions to the internal request options.
- setResourcePartitionKey(PartitionKey) - Method in class com.azure.cosmos.models.CosmosPermissionProperties
-
Sets the resource partition key associated with this permission object.
- setResourcePath(ContainerChildResourceType, String) - Method in class com.azure.cosmos.models.CosmosPermissionProperties
-
Sets the resource path represented by the name and kind of a resource that has a Cosmos container as the parent resource which is associated with this permission object.
- setResponseContinuationTokenLimitInKb(int) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Sets the ResponseContinuationTokenLimitInKb request option for item query requests in the Azure Cosmos DB service.
- setResponseContinuationTokenLimitInKb(int) - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Sets the ResponseContinuationTokenLimitInKb request option for item query requests in the Azure Cosmos DB service.
- setResponseContinuationTokenLimitInKb(Integer) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the ResponseContinuationTokenLimitInKb.
- setScanInQueryEnabled(Boolean) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Sets the option to allow scan on the queries which couldn't be served as indexing was opted out on the requested paths.
- setScanInQueryEnabled(Boolean) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the ScanInQueryEnabled.
- setScheduler(Scheduler) - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Sets the internal
Scheduler
that hosts a pool of ExecutorService-based workers for any change feed processor related tasks. - setScriptLoggingEnabled(boolean) - Method in class com.azure.cosmos.models.CosmosStoredProcedureRequestOptions
-
Sets whether Javascript stored procedure logging is enabled for the current request in the Azure Cosmos DB database service or not.
- setSessionToken(String) - Method in class com.azure.cosmos.models.CosmosBatchRequestOptions
-
Sets the token for use with session consistency.
- setSessionToken(String) - Method in class com.azure.cosmos.models.CosmosContainerRequestOptions
-
Sets the token for use with session consistency.
- setSessionToken(String) - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Sets the token for use with session consistency.
- setSessionToken(String) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Sets the session token for use with session consistency.
- setSessionToken(String) - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Sets the session token for use with session consistency.
- setSessionToken(String) - Method in class com.azure.cosmos.models.CosmosStoredProcedureRequestOptions
-
Sets the token for use with session consistency.
- setSpatialIndexes(List<SpatialSpec>) - Method in class com.azure.cosmos.models.IndexingPolicy
-
Sets the spatial indexes for additional indexes.
- setSpatialTypes(List<SpatialType>) - Method in class com.azure.cosmos.models.SpatialSpec
-
Sets the container of spatial types.
- setStartContinuation(String) - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Sets the start request continuation token to start looking for changes after.
- setStartFromBeginning(boolean) - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Sets a value indicating whether change feed in the Azure Cosmos DB service should start from beginning.
- setStartTime(Instant) - Method in class com.azure.cosmos.models.ChangeFeedProcessorOptions
-
Sets the time (exclusive) to start looking for changes after (UTC time).
- setTargetThroughput(int) - Method in class com.azure.cosmos.ThroughputControlGroupConfigBuilder
-
Deprecated.
- setTargetThroughputThreshold(double) - Method in class com.azure.cosmos.ThroughputControlGroupConfigBuilder
-
Deprecated.
- setThresholdForDiagnosticsOnTracer(Duration) - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Sets the thresholdForDiagnosticsOnTracer, if latency on CRUD operation is greater than this diagnostics will be sent to open telemetry exporter as events in tracer span of end to end CRUD api.
- setThresholdForDiagnosticsOnTracer(Duration) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Sets the thresholdForDiagnosticsOnTracer, if latency on query operation is greater than this diagnostics will be send to open telemetry exporter as events in tracer span of end to end CRUD api.
- setThresholdForDiagnosticsOnTracer(Duration) - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Sets the thresholdForDiagnosticsOnTracer, if latency on query operation is greater than this diagnostics will be send to open telemetry exporter as events in tracer span of end to end CRUD api.
- setThroughputControlGroupName(String) - Method in class com.azure.cosmos.models.CosmosBatchItemRequestOptions
-
Sets the throughput control group name.
- setThroughputControlGroupName(String) - Method in class com.azure.cosmos.models.CosmosBulkExecutionOptions
-
Sets the throughput control group name.
- setThroughputControlGroupName(String) - Method in class com.azure.cosmos.models.CosmosChangeFeedRequestOptions
-
Set the throughput control group name.
- setThroughputControlGroupName(String) - Method in class com.azure.cosmos.models.CosmosItemRequestOptions
-
Sets the throughput control group name.
- setThroughputControlGroupName(String) - Method in class com.azure.cosmos.models.CosmosQueryRequestOptions
-
Set the throughput control group name.
- setThroughputControlGroupName(String) - Method in class com.azure.cosmos.models.CosmosReadManyRequestOptions
-
Set the throughput control group name.
- setThroughputControlGroupName(String) - Method in class com.azure.cosmos.models.CosmosRequestOptions
-
Sets the throughput control group name.
- setTrackingIdUsed(boolean) - Method in class com.azure.cosmos.NonIdempotentWriteRetryOptions
-
Specifies whether write operations can use the trackingId system property '/_trackingId' to allow identification of conflicts and pre-condition failures due to retries.
- setTriggerOperation(TriggerOperation) - Method in class com.azure.cosmos.models.CosmosTriggerProperties
-
Set the operation type of the trigger.
- setTriggerType(TriggerType) - Method in class com.azure.cosmos.models.CosmosTriggerProperties
-
Set the type of the resource.
- setType(String) - Method in class com.azure.cosmos.models.CosmosVectorIndexSpec
-
Sets the vector index type for the vector index
- setUniqueKeyPolicy(UniqueKeyPolicy) - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Sets the Containers unique key policy
- setUniqueKeys(List<UniqueKey>) - Method in class com.azure.cosmos.models.UniqueKeyPolicy
-
Unique keys unique key policy.
- setValue(Object) - Method in class com.azure.cosmos.models.SqlParameter
-
Sets the value of the parameter.
- setVectorEmbeddingPolicy(CosmosVectorEmbeddingPolicy) - Method in class com.azure.cosmos.models.CosmosContainerProperties
-
Sets the Vector Embedding Policy containing paths for embeddings along with path-specific settings for the item used in performing vector search on the items in a collection in the Azure CosmosDB database service.
- setVectorIndexes(List<CosmosVectorIndexSpec>) - Method in class com.azure.cosmos.models.IndexingPolicy
-
Sets the vector indexes.
- setVersion(PartitionKeyDefinitionVersion) - Method in class com.azure.cosmos.models.PartitionKeyDefinition
-
Sets version.
- setWrappedDataEncryptionKey(byte[]) - Method in class com.azure.cosmos.models.CosmosClientEncryptionKeyProperties
-
Sets the wrapped form of the client encryption key.
- showQueryMode(ShowQueryMode) - Method in class com.azure.cosmos.models.CosmosClientTelemetryConfig
-
Enables printing query in db.statement attribute and diagnostic logs.
- ShowQueryMode - Enum in com.azure.cosmos.models
-
Defines whether to print db.statement in tracing.
- size() - Method in class com.azure.cosmos.models.CosmosBatchResponse
-
Gets the number of operation results.
- SpatialSpec - Class in com.azure.cosmos.models
-
The type Spatial spec.
- SpatialSpec() - Constructor for class com.azure.cosmos.models.SpatialSpec
-
Constructor.
- SpatialType - Enum in com.azure.cosmos.models
-
Defines the target data type of an index path specification in the Azure Cosmos DB service.
- SqlParameter - Class in com.azure.cosmos.models
-
Represents a SQL parameter in the SqlQuerySpec used for queries in the Azure Cosmos DB database service.
- SqlParameter() - Constructor for class com.azure.cosmos.models.SqlParameter
-
Initializes a new instance of the SqlParameter class.
- SqlParameter(String, Object) - Constructor for class com.azure.cosmos.models.SqlParameter
-
Initializes a new instance of the SqlParameter class with the name and value of the parameter.
- SqlQuerySpec - Class in com.azure.cosmos.models
-
Represents a SQL query in the Azure Cosmos DB database service.
- SqlQuerySpec() - Constructor for class com.azure.cosmos.models.SqlQuerySpec
-
Initializes a new instance of the SqlQuerySpec class.
- SqlQuerySpec(String) - Constructor for class com.azure.cosmos.models.SqlQuerySpec
-
Initializes a new instance of the SqlQuerySpec class with the text of the query.
- SqlQuerySpec(String, SqlParameter...) - Constructor for class com.azure.cosmos.models.SqlQuerySpec
-
Initializes a new instance of the SqlQuerySpec class with the text of the query and parameters.
- SqlQuerySpec(String, List<SqlParameter>) - Constructor for class com.azure.cosmos.models.SqlQuerySpec
-
Initializes a new instance of the SqlQuerySpec class with the text of the query and parameters.
- start() - Method in interface com.azure.cosmos.ChangeFeedProcessor
-
Start listening for changes asynchronously.
- stop() - Method in interface com.azure.cosmos.ChangeFeedProcessor
-
Stops listening for changes asynchronously.
- STORED_PROCEDURE - Enum constant in enum com.azure.cosmos.models.ContainerChildResourceType
-
Represents a stored procedure resource that is created in a Cosmos container.
- STRONG - Enum constant in enum com.azure.cosmos.ConsistencyLevel
-
STRONG Consistency guarantees that read operations always return the value that was last written.
- subscribe(CoreSubscriber<? super T>) - Method in class com.azure.cosmos.util.CosmosPagedFlux
-
Subscribe to consume all items of type
T
in the sequence respectively. - suppressTagNames(CosmosMetricTagName...) - Method in class com.azure.cosmos.models.CosmosMicrometerMeterOptions
-
Sets the tags that should be used for this meter (when applicable)
- SYSTEM - Static variable in class com.azure.cosmos.models.CosmosMetricCategory
-
The metrics in the system category emit metrics that reflect system-wide CPU and memory usage based on the same snapshots taken and logged in request diagnostics
- SYSTEM_CPU - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
Avg.
- SYSTEM_MEMORY_FREE - Static variable in class com.azure.cosmos.models.CosmosMetricName
-
JVM's Free available memory (DistributionSummary)
T
- targetThroughput(int) - Method in class com.azure.cosmos.ThroughputControlGroupConfigBuilder
-
Set the throughput control group target throughput.
- targetThroughputThreshold(double) - Method in class com.azure.cosmos.ThroughputControlGroupConfigBuilder
-
Set the throughput control group target throughput threshold.
- ThresholdBasedAvailabilityStrategy - Class in com.azure.cosmos
-
The type Threshold based retry availability strategy.
- ThresholdBasedAvailabilityStrategy() - Constructor for class com.azure.cosmos.ThresholdBasedAvailabilityStrategy
-
Instantiates a new Threshold based retry availability strategy.
- ThresholdBasedAvailabilityStrategy(Duration, Duration) - Constructor for class com.azure.cosmos.ThresholdBasedAvailabilityStrategy
-
Instantiates a new Threshold based retry availability strategy.
- throttlingRetryOptions(ThrottlingRetryOptions) - Method in class com.azure.cosmos.CosmosClientBuilder
-
Sets the retry policy options associated with the DocumentClient instance.
- ThrottlingRetryOptions - Class in com.azure.cosmos
-
Encapsulates retry options in the Azure Cosmos DB database service.
- ThrottlingRetryOptions() - Constructor for class com.azure.cosmos.ThrottlingRetryOptions
-
Creates a new instance of the RetryOptions class and initializes all properties to default values.
- ThroughputControlGroupConfig - Class in com.azure.cosmos
-
Throughput control group configuration.
- ThroughputControlGroupConfigBuilder - Class in com.azure.cosmos
-
The throughput control group config builder.
- ThroughputControlGroupConfigBuilder() - Constructor for class com.azure.cosmos.ThroughputControlGroupConfigBuilder
- ThroughputProperties - Class in com.azure.cosmos.models
-
Represents throughput of the resources in the Azure Cosmos DB service.
- ThroughputResponse - Class in com.azure.cosmos.models
-
The cosmos throughput response.
- toJson() - Method in class com.azure.cosmos.CosmosDiagnosticsContext
-
Returns a json-string representation of the diagnostics context.
- toJsonNode() - Method in class com.azure.cosmos.models.ChangeFeedProcessorItem
-
Helper API to convert this changeFeedProcessorItem instance to raw JsonNode format.
- toString() - Method in enum com.azure.cosmos.ConsistencyLevel
- toString() - Method in class com.azure.cosmos.CosmosContainerProactiveInitConfig
- toString() - Method in class com.azure.cosmos.CosmosDiagnostics
-
Retrieves Response Diagnostic String
- toString() - Method in class com.azure.cosmos.CosmosDiagnosticsThresholds
- toString() - Method in class com.azure.cosmos.CosmosEndToEndOperationLatencyPolicyConfig
- toString() - Method in exception com.azure.cosmos.CosmosException
- toString() - Method in class com.azure.cosmos.CosmosExcludedRegions
- toString() - Method in class com.azure.cosmos.DirectConnectionConfig
- toString() - Method in class com.azure.cosmos.GatewayConnectionConfig
- toString() - Method in class com.azure.cosmos.models.ChangeFeedMetaData
- toString() - Method in class com.azure.cosmos.models.ChangeFeedProcessorItem
- toString() - Method in enum com.azure.cosmos.models.ConflictResolutionMode
- toString() - Method in enum com.azure.cosmos.models.ContainerChildResourceType
- toString() - Method in class com.azure.cosmos.models.CosmosClientTelemetryConfig
- toString() - Method in class com.azure.cosmos.models.CosmosMetricCategory
- toString() - Method in class com.azure.cosmos.models.CosmosMetricName
- toString() - Method in class com.azure.cosmos.models.CosmosMetricTagName
- toString() - Method in enum com.azure.cosmos.models.CosmosVectorDataType
- toString() - Method in enum com.azure.cosmos.models.CosmosVectorDistanceFunction
- toString() - Method in enum com.azure.cosmos.models.CosmosVectorIndexType
- toString() - Method in interface com.azure.cosmos.models.FeedRange
-
Gets a json representation of the feed range - the returned json string can be used to create a new feed range instance from it - (use factory method fromJsonString to do so)
- toString() - Method in enum com.azure.cosmos.models.IndexingDirective
- toString() - Method in enum com.azure.cosmos.models.IndexingMode
- toString() - Method in class com.azure.cosmos.models.PartitionKey
-
Serialize the PartitionKey object to a JSON string.
- toString() - Method in enum com.azure.cosmos.models.PartitionKind
- toString() - Method in enum com.azure.cosmos.models.PermissionMode
- toString() - Method in class com.azure.cosmos.models.PriorityLevel
- toString() - Method in enum com.azure.cosmos.models.ShowQueryMode
- toString() - Method in enum com.azure.cosmos.models.SpatialType
- toString() - Method in enum com.azure.cosmos.models.TriggerOperation
- toString() - Method in enum com.azure.cosmos.models.TriggerType
- toString() - Method in class com.azure.cosmos.SessionRetryOptions
- toString() - Method in class com.azure.cosmos.ThresholdBasedAvailabilityStrategy
- toString() - Method in class com.azure.cosmos.ThrottlingRetryOptions
- tracingOptions(TracingOptions) - Method in class com.azure.cosmos.models.CosmosClientTelemetryConfig
-
Sets
TracingOptions
that are applied to each tracing reported by the client. - TRIGGER - Enum constant in enum com.azure.cosmos.models.ContainerChildResourceType
-
Represents a trigger resource that is created in a Cosmos container.
- TriggerOperation - Enum in com.azure.cosmos.models
-
Specifies the operations on which a trigger should be executed in the Azure Cosmos DB database service.
- TriggerType - Enum in com.azure.cosmos.models
-
The trigger type in the Azure Cosmos DB database service.
U
- UINT8 - Enum constant in enum com.azure.cosmos.models.CosmosVectorDataType
-
Represents a uint8 data type.
- UniqueKey - Class in com.azure.cosmos.models
-
Represents a unique key on that enforces uniqueness constraint on items in the container in the Azure Cosmos DB service.
- UniqueKey(List<String>) - Constructor for class com.azure.cosmos.models.UniqueKey
-
Instantiates a new Unique key with paths.
- UniqueKeyPolicy - Class in com.azure.cosmos.models
-
Represents the unique key policy configuration for specifying uniqueness constraints on items in the container in the Azure Cosmos DB service.
- UniqueKeyPolicy() - Constructor for class com.azure.cosmos.models.UniqueKeyPolicy
-
Instantiates a new Unique key policy.
- UPDATE - Enum constant in enum com.azure.cosmos.models.TriggerOperation
-
UPDATE operations only.
- UPSERT - Enum constant in enum com.azure.cosmos.models.CosmosItemOperationType
-
Upsert operation type.
- upsertItem(T) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Upserts an item.
- upsertItem(T) - Method in class com.azure.cosmos.CosmosContainer
-
Upserts an Cosmos item in the current container.
- upsertItem(T, CosmosItemRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Upserts an item.
- upsertItem(T, CosmosItemRequestOptions) - Method in class com.azure.cosmos.CosmosContainer
-
Upserts a item Cosmos sync item while specifying additional options.
- upsertItem(T, PartitionKey, CosmosItemRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncContainer
-
Upserts an item.
- upsertItem(T, PartitionKey, CosmosItemRequestOptions) - Method in class com.azure.cosmos.CosmosContainer
-
Upserts an item Cosmos sync item while specifying additional options.
- upsertItemOperation(T) - Method in class com.azure.cosmos.models.CosmosBatch
-
Adds an operation to upsert an item into the batch.
- upsertItemOperation(T, CosmosBatchItemRequestOptions) - Method in class com.azure.cosmos.models.CosmosBatch
-
Adds an operation to upsert an item into the batch.
- upsertPermission(CosmosPermissionProperties, CosmosPermissionRequestOptions) - Method in class com.azure.cosmos.CosmosAsyncUser
-
Upserts a permission.
- upsertUser(CosmosUserProperties) - Method in class com.azure.cosmos.CosmosAsyncDatabase
-
Upsert a user.
- upsertUser(CosmosUserProperties) - Method in class com.azure.cosmos.CosmosDatabase
-
Upserts a Cosmos user.
- USER_DEFINED_FUNCTION - Enum constant in enum com.azure.cosmos.models.ContainerChildResourceType
-
Represents an user defined function resource that is created in a Cosmos container.
- userAgentSuffix(String) - Method in class com.azure.cosmos.CosmosClientBuilder
-
sets the value of the user-agent suffix.
V
- V1 - Enum constant in enum com.azure.cosmos.models.PartitionKeyDefinitionVersion
-
Original version of hash partitioning.
- V2 - Enum constant in enum com.azure.cosmos.models.PartitionKeyDefinitionVersion
-
Enhanced version of hash partitioning - offers better distribution of long partition keys and uses less storage.
- V4_11_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.11.0
- V4_12_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.12.0
- V4_13_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.13.0
- V4_14_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.14.0
- V4_15_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.15.0
- V4_16_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.16.0
- V4_17_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.17.0
- V4_18_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.18.0
- V4_19_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.19.0
- V4_22_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.22.0
- V4_23_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.23.0
- V4_24_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.24.0
- V4_25_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.25.0
- V4_26_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.26.0
- V4_27_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.27.0
- V4_28_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.28.0
- V4_3_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.3.0
- V4_35_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.35.0
- V4_37_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.37.0
- V4_4_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.4.0
- V4_5_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.5.0
- V4_5_1 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.5.1
- V4_51_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.51.0
- V4_6_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.6.0
- V4_7_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.7.0
- V4_8_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.8.0
- V4_9_0 - Enum constant in enum com.azure.cosmos.util.Beta.SinceVersion
-
v4.9.0
- value() - Element in annotation type com.azure.cosmos.util.Beta
- valueOf(String) - Static method in enum com.azure.cosmos.ConnectionMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.ConsistencyLevel
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.models.ChangeFeedOperationType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.models.CompositePathSortOrder
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.models.ConflictResolutionMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.models.ContainerChildResourceType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.models.CosmosItemOperationType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.models.CosmosVectorDataType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.models.CosmosVectorDistanceFunction
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.models.CosmosVectorIndexType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.models.IndexingDirective
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.models.IndexingMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.models.PartitionKeyDefinitionVersion
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.models.PartitionKind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.models.PermissionMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.models.ShowQueryMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.models.SpatialType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.models.TriggerOperation
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.models.TriggerType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.cosmos.util.Beta.SinceVersion
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.azure.cosmos.ConnectionMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.ConsistencyLevel
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.models.ChangeFeedOperationType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.models.CompositePathSortOrder
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.models.ConflictResolutionMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.models.ContainerChildResourceType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.models.CosmosItemOperationType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.models.CosmosVectorDataType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.models.CosmosVectorDistanceFunction
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.models.CosmosVectorIndexType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.models.IndexingDirective
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.models.IndexingMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.models.PartitionKeyDefinitionVersion
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.models.PartitionKind
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.models.PermissionMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.models.ShowQueryMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.models.SpatialType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.models.TriggerOperation
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.models.TriggerType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.cosmos.util.Beta.SinceVersion
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- warningText() - Element in annotation type com.azure.cosmos.util.Beta
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form