156 строки
12 KiB
YAML
156 строки
12 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions"
|
|
fullName: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions"
|
|
name: "CosmosStoredProcedureRequestOptions"
|
|
nameWithType: "CosmosStoredProcedureRequestOptions"
|
|
summary: "Encapsulates options that can be specified for a request issued to cosmos stored procedure."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **CosmosStoredProcedureRequestOptions**"
|
|
constructors:
|
|
- uid: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.CosmosStoredProcedureRequestOptions()"
|
|
fullName: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.CosmosStoredProcedureRequestOptions()"
|
|
name: "CosmosStoredProcedureRequestOptions()"
|
|
nameWithType: "CosmosStoredProcedureRequestOptions.CosmosStoredProcedureRequestOptions()"
|
|
syntax: "public CosmosStoredProcedureRequestOptions()"
|
|
methods:
|
|
- uid: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.getIfMatchETag()"
|
|
fullName: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.getIfMatchETag()"
|
|
name: "getIfMatchETag()"
|
|
nameWithType: "CosmosStoredProcedureRequestOptions.getIfMatchETag()"
|
|
summary: "Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service."
|
|
syntax: "public String getIfMatchETag()"
|
|
desc: "Gets the If-Match (ETag) associated with the request in the Azure Cosmos DB service."
|
|
returns:
|
|
description: "the ifMatchETag associated with the request."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.getIfNoneMatchETag()"
|
|
fullName: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.getIfNoneMatchETag()"
|
|
name: "getIfNoneMatchETag()"
|
|
nameWithType: "CosmosStoredProcedureRequestOptions.getIfNoneMatchETag()"
|
|
summary: "Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service."
|
|
syntax: "public String getIfNoneMatchETag()"
|
|
desc: "Gets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service."
|
|
returns:
|
|
description: "the ifNoneMatchETag associated with the request."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.getPartitionKey()"
|
|
fullName: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.getPartitionKey()"
|
|
name: "getPartitionKey()"
|
|
nameWithType: "CosmosStoredProcedureRequestOptions.getPartitionKey()"
|
|
summary: "Gets the partition key used to identify the current request's target partition."
|
|
syntax: "public PartitionKey getPartitionKey()"
|
|
desc: "Gets the partition key used to identify the current request's target partition."
|
|
returns:
|
|
description: "the partition key value."
|
|
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.getSessionToken()"
|
|
fullName: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.getSessionToken()"
|
|
name: "getSessionToken()"
|
|
nameWithType: "CosmosStoredProcedureRequestOptions.getSessionToken()"
|
|
summary: "Gets the token for use with session consistency."
|
|
syntax: "public String getSessionToken()"
|
|
desc: "Gets the token for use with session consistency."
|
|
returns:
|
|
description: "the session token."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.isScriptLoggingEnabled()"
|
|
fullName: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.isScriptLoggingEnabled()"
|
|
name: "isScriptLoggingEnabled()"
|
|
nameWithType: "CosmosStoredProcedureRequestOptions.isScriptLoggingEnabled()"
|
|
summary: "Gets whether Javascript stored procedure logging is enabled for the current request in the Azure Cosmos DB database service or not."
|
|
syntax: "public boolean isScriptLoggingEnabled()"
|
|
desc: "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:
|
|
description: "true if Javascript stored procedure logging is enabled"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.setIfMatchETag(java.lang.String)"
|
|
fullName: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.setIfMatchETag(String ifMatchETag)"
|
|
name: "setIfMatchETag(String ifMatchETag)"
|
|
nameWithType: "CosmosStoredProcedureRequestOptions.setIfMatchETag(String ifMatchETag)"
|
|
summary: "Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service."
|
|
parameters:
|
|
- description: "the ifMatchETag associated with the request."
|
|
name: "ifMatchETag"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CosmosStoredProcedureRequestOptions setIfMatchETag(String ifMatchETag)"
|
|
desc: "Sets the If-Match (ETag) associated with the request in the Azure Cosmos DB service."
|
|
returns:
|
|
description: "the current request options"
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureRequestOptions?alt=com.azure.cosmos.models.CosmosStoredProcedureRequestOptions&text=CosmosStoredProcedureRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.setIfNoneMatchETag(java.lang.String)"
|
|
fullName: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.setIfNoneMatchETag(String ifNoneMatchETag)"
|
|
name: "setIfNoneMatchETag(String ifNoneMatchETag)"
|
|
nameWithType: "CosmosStoredProcedureRequestOptions.setIfNoneMatchETag(String ifNoneMatchETag)"
|
|
summary: "Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service."
|
|
parameters:
|
|
- description: "the ifNoneMatchETag associated with the request."
|
|
name: "ifNoneMatchETag"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CosmosStoredProcedureRequestOptions setIfNoneMatchETag(String ifNoneMatchETag)"
|
|
desc: "Sets the If-None-Match (ETag) associated with the request in the Azure Cosmos DB service."
|
|
returns:
|
|
description: "the current request options"
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureRequestOptions?alt=com.azure.cosmos.models.CosmosStoredProcedureRequestOptions&text=CosmosStoredProcedureRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.setPartitionKey(com.azure.cosmos.models.PartitionKey)"
|
|
fullName: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.setPartitionKey(PartitionKey partitionKey)"
|
|
name: "setPartitionKey(PartitionKey partitionKey)"
|
|
nameWithType: "CosmosStoredProcedureRequestOptions.setPartitionKey(PartitionKey partitionKey)"
|
|
summary: "Sets the partition key used to identify the current request's target partition."
|
|
parameters:
|
|
- description: "the partition key value."
|
|
name: "partitionKey"
|
|
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CosmosStoredProcedureRequestOptions setPartitionKey(PartitionKey partitionKey)"
|
|
desc: "Sets the partition key used to identify the current request's target partition."
|
|
returns:
|
|
description: "the CosmosStoredProcedureRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureRequestOptions?alt=com.azure.cosmos.models.CosmosStoredProcedureRequestOptions&text=CosmosStoredProcedureRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.setScriptLoggingEnabled(boolean)"
|
|
fullName: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.setScriptLoggingEnabled(boolean scriptLoggingEnabled)"
|
|
name: "setScriptLoggingEnabled(boolean scriptLoggingEnabled)"
|
|
nameWithType: "CosmosStoredProcedureRequestOptions.setScriptLoggingEnabled(boolean scriptLoggingEnabled)"
|
|
summary: "Sets whether Javascript stored procedure logging is enabled for the current request in the Azure Cosmos DB database service or not."
|
|
parameters:
|
|
- description: "true if stored procedure Javascript logging is enabled"
|
|
name: "scriptLoggingEnabled"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CosmosStoredProcedureRequestOptions setScriptLoggingEnabled(boolean scriptLoggingEnabled)"
|
|
desc: "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"
|
|
returns:
|
|
description: "the CosmosStoredProcedureRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureRequestOptions?alt=com.azure.cosmos.models.CosmosStoredProcedureRequestOptions&text=CosmosStoredProcedureRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.setSessionToken(java.lang.String)"
|
|
fullName: "com.azure.cosmos.models.CosmosStoredProcedureRequestOptions.setSessionToken(String sessionToken)"
|
|
name: "setSessionToken(String sessionToken)"
|
|
nameWithType: "CosmosStoredProcedureRequestOptions.setSessionToken(String sessionToken)"
|
|
summary: "Sets the token for use with session consistency."
|
|
parameters:
|
|
- description: "the session token."
|
|
name: "sessionToken"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CosmosStoredProcedureRequestOptions setSessionToken(String sessionToken)"
|
|
desc: "Sets the token for use with session consistency."
|
|
returns:
|
|
description: "the CosmosStoredProcedureRequestOptions."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosStoredProcedureRequestOptions?alt=com.azure.cosmos.models.CosmosStoredProcedureRequestOptions&text=CosmosStoredProcedureRequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Encapsulates options that can be specified for a request issued to cosmos stored procedure."
|
|
metadata: {}
|
|
package: "com.azure.cosmos.models"
|
|
artifact: com.azure:azure-cosmos:4.63.4
|