Package com.azure.cosmos.models

Class CosmosStoredProcedureRequestOptions

java.lang.Object
com.azure.cosmos.models.CosmosStoredProcedureRequestOptions
public final class CosmosStoredProcedureRequestOptions extends Object
Encapsulates options that can be specified for a request issued to cosmos stored procedure.

  • Constructor Details

    • CosmosStoredProcedureRequestOptions

      public CosmosStoredProcedureRequestOptions()

  • Method Details

    • getIfMatchETag

      public String getIfMatchETag()
      Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service. Most commonly used with replace and delete requests. This will be ignored if specified for create requests. For more details, refer to optimistic concurrency control documentation
      Returns:
      the ifMatchETag associated with the request.

    • setIfMatchETag

      public CosmosStoredProcedureRequestOptions setIfMatchETag(String ifMatchETag)
      Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service. Most commonly used with replace and delete requests. This will be ignored if specified for create requests. For more details, refer to optimistic concurrency control documentation
      Parameters:
      ifMatchETag - the ifMatchETag associated with the request.
      Returns:
      the current request options

    • getIfNoneMatchETag

      public String getIfNoneMatchETag()
      Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service. Most commonly used to detect changes to the resource via read requests. When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. To match any Etag use "*" This will be ignored if specified for write requests (ex: Create, Replace, Delete). For more details, refer to optimistic concurrency control documentation
      Returns:
      the ifNoneMatchETag associated with the request.

    • setIfNoneMatchETag

      public CosmosStoredProcedureRequestOptions setIfNoneMatchETag(String ifNoneMatchETag)
      Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service. Most commonly used to detect changes to the resource via read requests. When Item Etag matches the specified ifNoneMatchETag then 304 status code will be returned, otherwise existing Item will be returned with 200. To match any Etag use "*" This will be ignored if specified for write requests (ex: Create, Replace, Delete). For more details, refer to optimistic concurrency control documentation
      Parameters:
      ifNoneMatchETag - the ifNoneMatchETag associated with the request.
      Returns:
      the current request options

    • getPartitionKey

      public PartitionKey getPartitionKey()
      Gets the partition key used to identify the current request's target partition.
      Returns:
      the partition key value.

    • setPartitionKey

      public CosmosStoredProcedureRequestOptions setPartitionKey(PartitionKey partitionKey)
      Sets the partition key used to identify the current request's target partition.
      Parameters:
      partitionKey - the partition key value.
      Returns:
      the CosmosStoredProcedureRequestOptions.

    • getSessionToken

      public String getSessionToken()
      Gets the token for use with session consistency.
      Returns:
      the session token.

    • setSessionToken

      public CosmosStoredProcedureRequestOptions setSessionToken(String sessionToken)
      Sets the token for use with session consistency.
      Parameters:
      sessionToken - the session token.
      Returns:
      the CosmosStoredProcedureRequestOptions.

    • isScriptLoggingEnabled

      public boolean isScriptLoggingEnabled()
      Gets whether Javascript stored procedure logging is enabled for the current request in the Azure Cosmos DB database service or not. Default value is false
      Returns:
      true if Javascript stored procedure logging is enabled

    • setScriptLoggingEnabled

      public CosmosStoredProcedureRequestOptions setScriptLoggingEnabled(boolean scriptLoggingEnabled)
      Sets whether Javascript stored procedure logging is enabled for the current request in the Azure Cosmos DB database service or not. Default value is false
      Parameters:
      scriptLoggingEnabled - true if stored procedure Javascript logging is enabled
      Returns:
      the CosmosStoredProcedureRequestOptions.

    • setAdditionalHeaders

      public CosmosStoredProcedureRequestOptions setAdditionalHeaders(Map<CosmosAdditionalHeaderName,String> additionalHeaders)
      Sets additional headers to be included with this specific request.

      The CosmosAdditionalHeaderName class defines exactly which headers are supported. This allows per-request header customization, such as setting a workload ID that overrides the client-level default set via CosmosClientBuilder.additionalHeaders(java.util.Map).

      If the same header is also set at the client level, the request-level value takes precedence.

      Note: This method uses additive (merge) semantics — headers from multiple calls are merged into the existing set. Passing null or an empty map does not clear previously set headers. To reset headers, create a new options instance.

      Parameters:
      additionalHeaders - map of CosmosAdditionalHeaderName to value
      Returns:
      the CosmosStoredProcedureRequestOptions.
      Throws:
      IllegalArgumentException - if the workload-id value is not a valid integer

    • getAdditionalHeaders

      public Map<CosmosAdditionalHeaderName,String> getAdditionalHeaders()
      Gets the additional headers configured on this request options instance.
      Returns:
      unmodifiable map of additional headers, or null if none are set