340 строки
25 KiB
YAML
340 строки
25 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.cosmos.CosmosDiagnosticsContext"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext"
|
|
name: "CosmosDiagnosticsContext"
|
|
nameWithType: "CosmosDiagnosticsContext"
|
|
summary: "This class provides metadata for an operation in the Cosmos DB SDK that can be used by diagnostic handlers"
|
|
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 **CosmosDiagnosticsContext**"
|
|
methods:
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getAccountName()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getAccountName()"
|
|
name: "getAccountName()"
|
|
nameWithType: "CosmosDiagnosticsContext.getAccountName()"
|
|
summary: "The name of the account related to the operation"
|
|
syntax: "public String getAccountName()"
|
|
desc: "The name of the account related to the operation"
|
|
returns:
|
|
description: "the name of the account related to the operation"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getActualItemCount()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getActualItemCount()"
|
|
name: "getActualItemCount()"
|
|
nameWithType: "CosmosDiagnosticsContext.getActualItemCount()"
|
|
summary: "The actual number of items returned by a feed operation"
|
|
syntax: "public Integer getActualItemCount()"
|
|
desc: "The actual number of items returned by a feed operation"
|
|
returns:
|
|
description: "the actual number of items returned by a feed operation. Will be null for point operations."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getConnectionMode()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getConnectionMode()"
|
|
name: "getConnectionMode()"
|
|
nameWithType: "CosmosDiagnosticsContext.getConnectionMode()"
|
|
summary: "Returns the connection mode used in the client."
|
|
syntax: "public String getConnectionMode()"
|
|
desc: "Returns the connection mode used in the client. NOTE: this information is not included in the json representation returned from <xref uid=\"com.azure.cosmos.CosmosDiagnosticsContext.toJson()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#toJson()\"></xref> because it is usually only relevant when thresholds are violated, in which case the entire diagnostics json-string is included."
|
|
returns:
|
|
description: "the connection mode used in the client."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getContactedRegionNames()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getContactedRegionNames()"
|
|
name: "getContactedRegionNames()"
|
|
nameWithType: "CosmosDiagnosticsContext.getContactedRegionNames()"
|
|
summary: "Returns the set of contacted regions"
|
|
syntax: "public Set<String> getContactedRegionNames()"
|
|
desc: "Returns the set of contacted regions"
|
|
returns:
|
|
description: "the set of contacted regions"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getContainerName()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getContainerName()"
|
|
name: "getContainerName()"
|
|
nameWithType: "CosmosDiagnosticsContext.getContainerName()"
|
|
summary: "The name of the container related to the operation"
|
|
syntax: "public String getContainerName()"
|
|
desc: "The name of the container related to the operation"
|
|
returns:
|
|
description: "the name of the collection related to the operation"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getDatabaseName()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getDatabaseName()"
|
|
name: "getDatabaseName()"
|
|
nameWithType: "CosmosDiagnosticsContext.getDatabaseName()"
|
|
summary: "The name of the database related to the operation"
|
|
syntax: "public String getDatabaseName()"
|
|
desc: "The name of the database related to the operation"
|
|
returns:
|
|
description: "the name of the database related to the operation"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getDiagnostics()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getDiagnostics()"
|
|
name: "getDiagnostics()"
|
|
nameWithType: "CosmosDiagnosticsContext.getDiagnostics()"
|
|
summary: "The diagnostic records for service interactions within the scope of this SDK operation"
|
|
syntax: "public Collection<CosmosDiagnostics> getDiagnostics()"
|
|
desc: "The diagnostic records for service interactions within the scope of this SDK operation"
|
|
returns:
|
|
description: "the diagnostic records for service interactions within the scope of this SDK operation"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.cosmos.CosmosDiagnostics?alt=com.azure.cosmos.CosmosDiagnostics&text=CosmosDiagnostics\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getDuration()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getDuration()"
|
|
name: "getDuration()"
|
|
nameWithType: "CosmosDiagnosticsContext.getDuration()"
|
|
summary: "The total end-to-end duration of the operation."
|
|
syntax: "public Duration getDuration()"
|
|
desc: "The total end-to-end duration of the operation."
|
|
returns:
|
|
description: "the total end-to-end duration of the operation."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getEffectiveConsistencyLevel()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getEffectiveConsistencyLevel()"
|
|
name: "getEffectiveConsistencyLevel()"
|
|
nameWithType: "CosmosDiagnosticsContext.getEffectiveConsistencyLevel()"
|
|
summary: "The effective consistency level of the operation"
|
|
syntax: "public ConsistencyLevel getEffectiveConsistencyLevel()"
|
|
desc: "The effective consistency level of the operation"
|
|
returns:
|
|
description: "the effective consistency level of the operation"
|
|
type: "<xref href=\"com.azure.cosmos.ConsistencyLevel?alt=com.azure.cosmos.ConsistencyLevel&text=ConsistencyLevel\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getFinalError()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getFinalError()"
|
|
name: "getFinalError()"
|
|
nameWithType: "CosmosDiagnosticsContext.getFinalError()"
|
|
summary: "The final error when the operation failed"
|
|
syntax: "public Throwable getFinalError()"
|
|
desc: "The final error when the operation failed"
|
|
returns:
|
|
description: "the final error when the operation failed"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html\">Throwable</a>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getKeywordIdentifiers()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getKeywordIdentifiers()"
|
|
name: "getKeywordIdentifiers()"
|
|
nameWithType: "CosmosDiagnosticsContext.getKeywordIdentifiers()"
|
|
summary: "Gets the custom ids."
|
|
syntax: "public Set<String> getKeywordIdentifiers()"
|
|
desc: "Gets the custom ids."
|
|
returns:
|
|
description: "the custom ids."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getMaxItemCount()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getMaxItemCount()"
|
|
name: "getMaxItemCount()"
|
|
nameWithType: "CosmosDiagnosticsContext.getMaxItemCount()"
|
|
summary: "The max."
|
|
syntax: "public Integer getMaxItemCount()"
|
|
desc: "The max. number of items requested in a feed operation"
|
|
returns:
|
|
description: "the max. number of items requested in a feed operation. Will be null for point operations."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getMaxRequestPayloadSizeInBytes()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getMaxRequestPayloadSizeInBytes()"
|
|
name: "getMaxRequestPayloadSizeInBytes()"
|
|
nameWithType: "CosmosDiagnosticsContext.getMaxRequestPayloadSizeInBytes()"
|
|
summary: "The max."
|
|
syntax: "public int getMaxRequestPayloadSizeInBytes()"
|
|
desc: "The max. request payload size in bytes"
|
|
returns:
|
|
description: "the max. request payload size in bytes"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getMaxResponsePayloadSizeInBytes()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getMaxResponsePayloadSizeInBytes()"
|
|
name: "getMaxResponsePayloadSizeInBytes()"
|
|
nameWithType: "CosmosDiagnosticsContext.getMaxResponsePayloadSizeInBytes()"
|
|
summary: "The max."
|
|
syntax: "public int getMaxResponsePayloadSizeInBytes()"
|
|
desc: "The max. response payload size in bytes."
|
|
returns:
|
|
description: "the max. response payload size in bytes"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getOperationId()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getOperationId()"
|
|
name: "getOperationId()"
|
|
nameWithType: "CosmosDiagnosticsContext.getOperationId()"
|
|
summary: "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."
|
|
syntax: "public String getOperationId()"
|
|
desc: "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."
|
|
returns:
|
|
description: "the operation identifier of the operation"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getOperationType()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getOperationType()"
|
|
name: "getOperationType()"
|
|
nameWithType: "CosmosDiagnosticsContext.getOperationType()"
|
|
summary: "The operation type of the operation"
|
|
syntax: "public String getOperationType()"
|
|
desc: "The operation type of the operation"
|
|
returns:
|
|
description: "the operation type of the operation"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getQueryStatement()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getQueryStatement()"
|
|
name: "getQueryStatement()"
|
|
nameWithType: "CosmosDiagnosticsContext.getQueryStatement()"
|
|
summary: "The query statement send by client"
|
|
syntax: "public String getQueryStatement()"
|
|
desc: "The query statement send by client"
|
|
returns:
|
|
description: "the query statement"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getRequestInfo()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getRequestInfo()"
|
|
name: "getRequestInfo()"
|
|
nameWithType: "CosmosDiagnosticsContext.getRequestInfo()"
|
|
summary: "Gets a collection of <xref uid=\"com.azure.cosmos.CosmosDiagnosticsRequestInfo\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosDiagnosticsRequestInfo\"></xref> records providing more information about individual requests issued in the transport layer to process this operation."
|
|
syntax: "public Collection<CosmosDiagnosticsRequestInfo> getRequestInfo()"
|
|
desc: "Gets a collection of <xref uid=\"com.azure.cosmos.CosmosDiagnosticsRequestInfo\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosDiagnosticsRequestInfo\"></xref> records providing more information about individual requests issued in the transport layer to process this operation. NOTE: this information is not included in the json representation returned from <xref uid=\"com.azure.cosmos.CosmosDiagnosticsContext.toJson()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#toJson()\"></xref> because it is usually only relevant when thresholds are violated, in which case the entire diagnostics json-string is included. Calling this method will lazily collect the user agent - which can be useful when writing a custom <xref uid=\"com.azure.cosmos.CosmosDiagnosticsHandler\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosDiagnosticsHandler\"></xref>"
|
|
returns:
|
|
description: "a collection of <xref uid=\"com.azure.cosmos.CosmosDiagnosticsRequestInfo\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosDiagnosticsRequestInfo\"></xref> records providing more information about\n individual requests issued in the transport layer to process this operation."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.cosmos.CosmosDiagnosticsRequestInfo?alt=com.azure.cosmos.CosmosDiagnosticsRequestInfo&text=CosmosDiagnosticsRequestInfo\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getResourceType()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getResourceType()"
|
|
name: "getResourceType()"
|
|
nameWithType: "CosmosDiagnosticsContext.getResourceType()"
|
|
summary: "The resource type of the operation"
|
|
syntax: "public String getResourceType()"
|
|
desc: "The resource type of the operation"
|
|
returns:
|
|
description: "the resource type of the operation"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getRetryCount()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getRetryCount()"
|
|
name: "getRetryCount()"
|
|
nameWithType: "CosmosDiagnosticsContext.getRetryCount()"
|
|
summary: "Returns the number of retries and/or attempts for speculative processing."
|
|
syntax: "public int getRetryCount()"
|
|
desc: "Returns the number of retries and/or attempts for speculative processing."
|
|
returns:
|
|
description: "the number of retries and/or attempts for speculative processing."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getStatusCode()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getStatusCode()"
|
|
name: "getStatusCode()"
|
|
nameWithType: "CosmosDiagnosticsContext.getStatusCode()"
|
|
summary: "The final status code of the operation (possibly after retries)"
|
|
syntax: "public int getStatusCode()"
|
|
desc: "The final status code of the operation (possibly after retries)"
|
|
returns:
|
|
description: "the final status code of the operation (possibly after retries)"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getSubStatusCode()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getSubStatusCode()"
|
|
name: "getSubStatusCode()"
|
|
nameWithType: "CosmosDiagnosticsContext.getSubStatusCode()"
|
|
summary: "The final sub-status code of the operation (possibly after retries)"
|
|
syntax: "public int getSubStatusCode()"
|
|
desc: "The final sub-status code of the operation (possibly after retries)"
|
|
returns:
|
|
description: "the final sub-status code of the operation (possibly after retries)"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getSystemUsage()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getSystemUsage()"
|
|
name: "getSystemUsage()"
|
|
nameWithType: "CosmosDiagnosticsContext.getSystemUsage()"
|
|
summary: "Returns the system usage NOTE: this information is not included in the json representation returned from <xref uid=\"com.azure.cosmos.CosmosDiagnosticsContext.toJson()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#toJson()\"></xref> because it is usually only relevant when thresholds are violated, in which case the entire diagnostics json-string is included."
|
|
syntax: "public Map<String,Object> getSystemUsage()"
|
|
desc: "Returns the system usage NOTE: this information is not included in the json representation returned from <xref uid=\"com.azure.cosmos.CosmosDiagnosticsContext.toJson()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#toJson()\"></xref> because it is usually only relevant when thresholds are violated, in which case the entire diagnostics json-string is included. Calling this method will lazily collect the system usage - which can be useful when writing a custom <xref uid=\"com.azure.cosmos.CosmosDiagnosticsHandler\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosDiagnosticsHandler\"></xref>"
|
|
returns:
|
|
description: "the system usage"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getTotalRequestCharge()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getTotalRequestCharge()"
|
|
name: "getTotalRequestCharge()"
|
|
nameWithType: "CosmosDiagnosticsContext.getTotalRequestCharge()"
|
|
summary: "The total request charge across all retries."
|
|
syntax: "public float getTotalRequestCharge()"
|
|
desc: "The total request charge across all retries."
|
|
returns:
|
|
description: "the total request charge across all retries."
|
|
type: "<xref href=\"float?alt=float&text=float\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getTrackingId()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getTrackingId()"
|
|
name: "getTrackingId()"
|
|
nameWithType: "CosmosDiagnosticsContext.getTrackingId()"
|
|
summary: "The tracking<wbr>Id of a write operation."
|
|
syntax: "public String getTrackingId()"
|
|
desc: "The trackingId of a write operation. Will be null for read-/query- or feed operations or when non-idempotent writes are disabled for writes or only enabled without trackingId propagation."
|
|
returns:
|
|
description: "the trackingId of an operation"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.getUserAgent()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.getUserAgent()"
|
|
name: "getUserAgent()"
|
|
nameWithType: "CosmosDiagnosticsContext.getUserAgent()"
|
|
summary: "Gets the User<wbr>Agent header value used by the client issuing this operation NOTE: this information is not included in the json representation returned from <xref uid=\"com.azure.cosmos.CosmosDiagnosticsContext.toJson()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#toJson()\"></xref> because it is usually only relevant when thresholds are violated, in which case the entire diagnostics json-string is included."
|
|
syntax: "public String getUserAgent()"
|
|
desc: "Gets the UserAgent header value used by the client issuing this operation NOTE: this information is not included in the json representation returned from <xref uid=\"com.azure.cosmos.CosmosDiagnosticsContext.toJson()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#toJson()\"></xref> because it is usually only relevant when thresholds are violated, in which case the entire diagnostics json-string is included."
|
|
returns:
|
|
description: "the UserAgent header value used for the client that issued this operation"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.isCompleted()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.isCompleted()"
|
|
name: "isCompleted()"
|
|
nameWithType: "CosmosDiagnosticsContext.isCompleted()"
|
|
summary: "Returns a flag indicating whether the operation has been completed yet."
|
|
syntax: "public boolean isCompleted()"
|
|
desc: "Returns a flag indicating whether the operation has been completed yet."
|
|
returns:
|
|
description: "a flag indicating whether the operation has been completed yet."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.isFailure()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.isFailure()"
|
|
name: "isFailure()"
|
|
nameWithType: "CosmosDiagnosticsContext.isFailure()"
|
|
summary: "A flag indicating whether the operation should be considered failed or not based on the status code handling rules in <xref uid=\"com.azure.cosmos.CosmosDiagnosticsThresholds.setFailureHandler*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosDiagnosticsThresholds#setFailureHandler(java.util.function.BiPredicate)\"></xref>"
|
|
syntax: "public boolean isFailure()"
|
|
desc: "A flag indicating whether the operation should be considered failed or not based on the status code handling rules in <xref uid=\"com.azure.cosmos.CosmosDiagnosticsThresholds.setFailureHandler*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosDiagnosticsThresholds#setFailureHandler(java.util.function.BiPredicate)\"></xref>"
|
|
returns:
|
|
description: "a flag indicating whether the operation should be considered failed or not"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.isPointOperation()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.isPointOperation()"
|
|
name: "isPointOperation()"
|
|
nameWithType: "CosmosDiagnosticsContext.isPointOperation()"
|
|
summary: "A flag indicating whether the operation is a point operation or not."
|
|
syntax: "public boolean isPointOperation()"
|
|
desc: "A flag indicating whether the operation is a point operation or not."
|
|
returns:
|
|
description: "a flag indicating whether the operation is a point operation or not."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.isThresholdViolated()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.isThresholdViolated()"
|
|
name: "isThresholdViolated()"
|
|
nameWithType: "CosmosDiagnosticsContext.isThresholdViolated()"
|
|
summary: "Indicates whether the latency, request charge or payload size of the operation exceeded the given threshold"
|
|
syntax: "public boolean isThresholdViolated()"
|
|
desc: "Indicates whether the latency, request charge or payload size of the operation exceeded the given threshold"
|
|
returns:
|
|
description: "a flag indicating whether the latency, request charge or payload size of the operation\n exceeded its threshold."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.CosmosDiagnosticsContext.toJson()"
|
|
fullName: "com.azure.cosmos.CosmosDiagnosticsContext.toJson()"
|
|
name: "toJson()"
|
|
nameWithType: "CosmosDiagnosticsContext.toJson()"
|
|
summary: "Returns a json-string representation of the diagnostics context."
|
|
syntax: "public String toJson()"
|
|
desc: "Returns a json-string representation of the diagnostics context. This string uses json format for readability, but it should be treated as an opaque string - the format can and will change between SDK versions - for any automatic processing of the diagnostics information the get-properties of public API should be used."
|
|
returns:
|
|
description: "a json-string representation of the diagnostics context. This string uses json format for readability,\n but it should be treated as an opaque string - the format can and will change between SDK versions -\n for any\n automatic processing of the diagnostics information the get-properties of public API should be used."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
type: "class"
|
|
desc: "This class provides metadata for an operation in the Cosmos DB SDK that can be used by diagnostic handlers"
|
|
metadata: {}
|
|
package: "com.azure.cosmos"
|
|
artifact: com.azure:azure-cosmos:4.63.3
|