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