133 строки
8.4 KiB
YAML
133 строки
8.4 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.cosmos.models.CosmosResponse"
|
|
fullName: "com.azure.cosmos.models.CosmosResponse<T>"
|
|
name: "CosmosResponse<T>"
|
|
nameWithType: "CosmosResponse<T>"
|
|
summary: "The cosmos response"
|
|
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 class **CosmosResponse<T>**"
|
|
methods:
|
|
- uid: "com.azure.cosmos.models.CosmosResponse.getActivityId()"
|
|
fullName: "com.azure.cosmos.models.CosmosResponse<T>.getActivityId()"
|
|
name: "getActivityId()"
|
|
nameWithType: "CosmosResponse<T>.getActivityId()"
|
|
summary: "Gets the Activity ID for the request."
|
|
syntax: "public String getActivityId()"
|
|
desc: "Gets the Activity ID for the request."
|
|
returns:
|
|
description: "the activity getId."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosResponse.getCurrentResourceQuotaUsage()"
|
|
fullName: "com.azure.cosmos.models.CosmosResponse<T>.getCurrentResourceQuotaUsage()"
|
|
name: "getCurrentResourceQuotaUsage()"
|
|
nameWithType: "CosmosResponse<T>.getCurrentResourceQuotaUsage()"
|
|
summary: "Gets the current size of this entity (in megabytes (MB) for server resources and in count for master resources)"
|
|
syntax: "public String getCurrentResourceQuotaUsage()"
|
|
desc: "Gets the current size of this entity (in megabytes (MB) for server resources and in count for master resources)"
|
|
returns:
|
|
description: "the current resource quota usage."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosResponse.getDiagnostics()"
|
|
fullName: "com.azure.cosmos.models.CosmosResponse<T>.getDiagnostics()"
|
|
name: "getDiagnostics()"
|
|
nameWithType: "CosmosResponse<T>.getDiagnostics()"
|
|
summary: "Gets the diagnostics information for the current request to Azure Cosmos DB service."
|
|
syntax: "public CosmosDiagnostics getDiagnostics()"
|
|
desc: "Gets the diagnostics information for the current request to Azure Cosmos DB service."
|
|
returns:
|
|
description: "diagnostics information for the current request to Azure Cosmos DB service."
|
|
type: "<xref href=\"com.azure.cosmos.CosmosDiagnostics?alt=com.azure.cosmos.CosmosDiagnostics&text=CosmosDiagnostics\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosResponse.getDuration()"
|
|
fullName: "com.azure.cosmos.models.CosmosResponse<T>.getDuration()"
|
|
name: "getDuration()"
|
|
nameWithType: "CosmosResponse<T>.getDuration()"
|
|
summary: "Gets the end-to-end request latency for the current request to Azure Cosmos DB service."
|
|
syntax: "public Duration getDuration()"
|
|
desc: "Gets the end-to-end request latency for the current request to Azure Cosmos DB service."
|
|
returns:
|
|
description: "end-to-end request latency for the current request to Azure Cosmos DB service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosResponse.getMaxResourceQuota()"
|
|
fullName: "com.azure.cosmos.models.CosmosResponse<T>.getMaxResourceQuota()"
|
|
name: "getMaxResourceQuota()"
|
|
nameWithType: "CosmosResponse<T>.getMaxResourceQuota()"
|
|
summary: "Gets the maximum size limit for this entity (in megabytes (MB) for server resources and in count for master resources)."
|
|
syntax: "public String getMaxResourceQuota()"
|
|
desc: "Gets the maximum size limit for this entity (in megabytes (MB) for server resources and in count for master resources).\n\nFor CosmosContainer, users will need to set <xref uid=\"com.azure.cosmos.models.CosmosContainerRequestOptions.setQuotaInfoEnabled(boolean)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosContainerRequestOptions#setQuotaInfoEnabled(boolean)\"></xref> to true to get the quota information."
|
|
returns:
|
|
description: "the max resource quota."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.models.CosmosResponse.getProperties()"
|
|
fullName: "com.azure.cosmos.models.CosmosResponse<T>.getProperties()"
|
|
name: "getProperties()"
|
|
nameWithType: "CosmosResponse<T>.getProperties()"
|
|
summary: "Gets properties."
|
|
syntax: "public T getProperties()"
|
|
desc: "Gets properties."
|
|
returns:
|
|
description: "the properties"
|
|
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosResponse.getRequestCharge()"
|
|
fullName: "com.azure.cosmos.models.CosmosResponse<T>.getRequestCharge()"
|
|
name: "getRequestCharge()"
|
|
nameWithType: "CosmosResponse<T>.getRequestCharge()"
|
|
summary: "Gets the request charge as request units (RU) consumed by the operation."
|
|
syntax: "public double getRequestCharge()"
|
|
desc: "Gets the request charge as request units (RU) consumed by the operation.\n\nFor more information about the RU and factors that can impact the effective charges please visit [Request Units in Azure Cosmos DB][]\n\n\n[Request Units in Azure Cosmos DB]: https://docs.microsoft.com/en-us/azure/cosmos-db/request-units"
|
|
returns:
|
|
description: "the request charge."
|
|
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosResponse.getResponseHeaders()"
|
|
fullName: "com.azure.cosmos.models.CosmosResponse<T>.getResponseHeaders()"
|
|
name: "getResponseHeaders()"
|
|
nameWithType: "CosmosResponse<T>.getResponseHeaders()"
|
|
summary: "Gets the headers associated with the response."
|
|
syntax: "public Map<String,String> getResponseHeaders()"
|
|
desc: "Gets the headers associated with the response."
|
|
returns:
|
|
description: "the response headers."
|
|
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/String.html\">String</a>>"
|
|
- uid: "com.azure.cosmos.models.CosmosResponse.getSessionToken()"
|
|
fullName: "com.azure.cosmos.models.CosmosResponse<T>.getSessionToken()"
|
|
name: "getSessionToken()"
|
|
nameWithType: "CosmosResponse<T>.getSessionToken()"
|
|
summary: "Gets the token used for managing client's consistency requirements."
|
|
syntax: "public String getSessionToken()"
|
|
desc: "Gets the token used for managing client's consistency requirements."
|
|
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.CosmosResponse.getStatusCode()"
|
|
fullName: "com.azure.cosmos.models.CosmosResponse<T>.getStatusCode()"
|
|
name: "getStatusCode()"
|
|
nameWithType: "CosmosResponse<T>.getStatusCode()"
|
|
summary: "Gets the HTTP status code associated with the response."
|
|
syntax: "public int getStatusCode()"
|
|
desc: "Gets the HTTP status code associated with the response."
|
|
returns:
|
|
description: "the status code."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
typeParameters:
|
|
- description: "the type of resource"
|
|
name: "T"
|
|
desc: "The cosmos response"
|
|
metadata: {}
|
|
package: "com.azure.cosmos.models"
|
|
artifact: com.azure:azure-cosmos:4.63.3
|