azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.documen...

380 строки
22 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.documentdb.ResourceResponse"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>"
name: "ResourceResponse<T>"
nameWithType: "ResourceResponse<T>"
summary: "Represents the service response to a request made from Document<wbr>Client in the Azure Cosmos DB database service."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public final class **ResourceResponse<T>**"
methods:
- uid: "com.microsoft.azure.documentdb.ResourceResponse.close()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.close()"
name: "close()"
nameWithType: "ResourceResponse<T>.close()"
summary: "Deprecated."
syntax: "</br>public void close()"
desc: "Deprecated."
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getActivityId()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getActivityId()"
name: "getActivityId()"
nameWithType: "ResourceResponse<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 id."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getClientSideRequestStatistics()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getClientSideRequestStatistics()"
name: "getClientSideRequestStatistics()"
nameWithType: "ResourceResponse<T>.getClientSideRequestStatistics()"
summary: "Gets the request statistics for the current request to Azure Cosmos DB service."
syntax: "public ClientSideRequestStatistics getClientSideRequestStatistics()"
desc: "Gets the request statistics for the current request to Azure Cosmos DB service."
returns:
description: "request statistics for the current request to Azure Cosmos DB service."
type: "<xref href=\"com.microsoft.azure.documentdb.ClientSideRequestStatistics?alt=com.microsoft.azure.documentdb.ClientSideRequestStatistics&text=ClientSideRequestStatistics\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getCollectionQuota()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getCollectionQuota()"
name: "getCollectionQuota()"
nameWithType: "ResourceResponse<T>.getCollectionQuota()"
summary: "Max Quota."
syntax: "public long getCollectionQuota()"
desc: "Max Quota."
returns:
description: "the collection quota."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getCollectionSizeQuota()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getCollectionSizeQuota()"
name: "getCollectionSizeQuota()"
nameWithType: "ResourceResponse<T>.getCollectionSizeQuota()"
summary: "Max Quota."
syntax: "public long getCollectionSizeQuota()"
desc: "Max Quota."
returns:
description: "the collection size quota."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getCollectionSizeUsage()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getCollectionSizeUsage()"
name: "getCollectionSizeUsage()"
nameWithType: "ResourceResponse<T>.getCollectionSizeUsage()"
summary: "Current Usage."
syntax: "public long getCollectionSizeUsage()"
desc: "Current Usage."
returns:
description: "the collection size usage."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getCollectionUsage()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getCollectionUsage()"
name: "getCollectionUsage()"
nameWithType: "ResourceResponse<T>.getCollectionUsage()"
summary: "Current Usage."
syntax: "public long getCollectionUsage()"
desc: "Current Usage."
returns:
description: "the current collection usage."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getCurrentResourceQuotaUsage()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getCurrentResourceQuotaUsage()"
name: "getCurrentResourceQuotaUsage()"
nameWithType: "ResourceResponse<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: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getDatabaseQuota()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getDatabaseQuota()"
name: "getDatabaseQuota()"
nameWithType: "ResourceResponse<T>.getDatabaseQuota()"
summary: "Max Quota."
syntax: "public long getDatabaseQuota()"
desc: "Max Quota."
returns:
description: "the database quota."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getDatabaseUsage()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getDatabaseUsage()"
name: "getDatabaseUsage()"
nameWithType: "ResourceResponse<T>.getDatabaseUsage()"
summary: "Current Usage."
syntax: "public long getDatabaseUsage()"
desc: "Current Usage."
returns:
description: "the current database usage."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getDocumentCountQuota()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getDocumentCountQuota()"
name: "getDocumentCountQuota()"
nameWithType: "ResourceResponse<T>.getDocumentCountQuota()"
summary: "Max document count quota."
syntax: "public long getDocumentCountQuota()"
desc: "Max document count quota."
returns:
description: "the document count quota."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getDocumentCountUsage()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getDocumentCountUsage()"
name: "getDocumentCountUsage()"
nameWithType: "ResourceResponse<T>.getDocumentCountUsage()"
summary: "Current document count usage."
syntax: "public long getDocumentCountUsage()"
desc: "Current document count usage."
returns:
description: "the document count usage."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getDocumentQuota()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getDocumentQuota()"
name: "getDocumentQuota()"
nameWithType: "ResourceResponse<T>.getDocumentQuota()"
summary: "Max Quota."
syntax: "public long getDocumentQuota()"
desc: "Max Quota."
returns:
description: "the document quota."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getDocumentUsage()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getDocumentUsage()"
name: "getDocumentUsage()"
nameWithType: "ResourceResponse<T>.getDocumentUsage()"
summary: "Current Usage."
syntax: "public long getDocumentUsage()"
desc: "Current Usage."
returns:
description: "the document usage."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getIndexTransformationProgress()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getIndexTransformationProgress()"
name: "getIndexTransformationProgress()"
nameWithType: "ResourceResponse<T>.getIndexTransformationProgress()"
summary: "Gets the progress of an index transformation, if one is underway."
syntax: "public long getIndexTransformationProgress()"
desc: "Gets the progress of an index transformation, if one is underway."
returns:
description: "the progress of an index transformation."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getLazyIndexingProgress()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getLazyIndexingProgress()"
name: "getLazyIndexingProgress()"
nameWithType: "ResourceResponse<T>.getLazyIndexingProgress()"
summary: "Gets the progress of lazy indexing."
syntax: "public long getLazyIndexingProgress()"
desc: "Gets the progress of lazy indexing."
returns:
description: "the progress of lazy indexing."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getMaxResourceQuota()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getMaxResourceQuota()"
name: "getMaxResourceQuota()"
nameWithType: "ResourceResponse<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)."
returns:
description: "the max resource quota."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getPermissionQuota()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getPermissionQuota()"
name: "getPermissionQuota()"
nameWithType: "ResourceResponse<T>.getPermissionQuota()"
summary: "Max Quota."
syntax: "public long getPermissionQuota()"
desc: "Max Quota."
returns:
description: "the permission quota."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getPermissionUsage()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getPermissionUsage()"
name: "getPermissionUsage()"
nameWithType: "ResourceResponse<T>.getPermissionUsage()"
summary: "Current Usage."
syntax: "public long getPermissionUsage()"
desc: "Current Usage."
returns:
description: "the current permission usage."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getRUPerMinuteUsed()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getRUPerMinuteUsed()"
name: "getRUPerMinuteUsed()"
nameWithType: "ResourceResponse<T>.getRUPerMinuteUsed()"
summary: "Gets the flag associated with the response from the Azure Cosmos DB database service whether this request is served from Request Units(RUs)/minute capacity or not."
syntax: "public boolean getRUPerMinuteUsed()"
desc: "Gets the flag associated with the response from the Azure Cosmos DB database service whether this request is served from Request Units(RUs)/minute capacity or not."
returns:
description: "True if this request is served from RUs/minute capacity. Otherwise, false."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getRequestCharge()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getRequestCharge()"
name: "getRequestCharge()"
nameWithType: "ResourceResponse<T>.getRequestCharge()"
summary: "Gets the number of index paths (terms) generated by the operation."
syntax: "public double getRequestCharge()"
desc: "Gets the number of index paths (terms) generated by the operation."
returns:
description: "the request charge."
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getRequestDiagnosticsString()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getRequestDiagnosticsString()"
name: "getRequestDiagnosticsString()"
nameWithType: "ResourceResponse<T>.getRequestDiagnosticsString()"
summary: "Gets the diagnostics information for the current request to Azure Cosmos DB service."
syntax: "public String getRequestDiagnosticsString()"
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=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getRequestLatency()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getRequestLatency()"
name: "getRequestLatency()"
nameWithType: "ResourceResponse<T>.getRequestLatency()"
summary: "Gets the end-to-end request latency for the current request to Azure Cosmos DB service."
syntax: "public Period getRequestLatency()"
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: "<xref href=\"org.joda.time.Period?alt=org.joda.time.Period&text=Period\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getResource()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getResource()"
name: "getResource()"
nameWithType: "ResourceResponse<T>.getResource()"
summary: "Gets the resource for the request."
syntax: "public T getResource()"
desc: "Gets the resource for the request."
returns:
description: "the resource."
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getResponseHeaders()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getResponseHeaders()"
name: "getResponseHeaders()"
nameWithType: "ResourceResponse<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: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getSessionToken()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getSessionToken()"
name: "getSessionToken()"
nameWithType: "ResourceResponse<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: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getStatusCode()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getStatusCode()"
name: "getStatusCode()"
nameWithType: "ResourceResponse<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\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getStoredProceduresQuota()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getStoredProceduresQuota()"
name: "getStoredProceduresQuota()"
nameWithType: "ResourceResponse<T>.getStoredProceduresQuota()"
summary: "Max Quota."
syntax: "public long getStoredProceduresQuota()"
desc: "Max Quota."
returns:
description: "the stored procedures quota."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getStoredProceduresUsage()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getStoredProceduresUsage()"
name: "getStoredProceduresUsage()"
nameWithType: "ResourceResponse<T>.getStoredProceduresUsage()"
summary: "Current Usage."
syntax: "public long getStoredProceduresUsage()"
desc: "Current Usage."
returns:
description: "the current stored procedures usage."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getTriggersQuota()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getTriggersQuota()"
name: "getTriggersQuota()"
nameWithType: "ResourceResponse<T>.getTriggersQuota()"
summary: "Max Quota."
syntax: "public long getTriggersQuota()"
desc: "Max Quota."
returns:
description: "the triggers quota."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getTriggersUsage()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getTriggersUsage()"
name: "getTriggersUsage()"
nameWithType: "ResourceResponse<T>.getTriggersUsage()"
summary: "Current Usage."
syntax: "public long getTriggersUsage()"
desc: "Current Usage."
returns:
description: "the current triggers usage."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getUserDefinedFunctionsQuota()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getUserDefinedFunctionsQuota()"
name: "getUserDefinedFunctionsQuota()"
nameWithType: "ResourceResponse<T>.getUserDefinedFunctionsQuota()"
summary: "Max Quota."
syntax: "public long getUserDefinedFunctionsQuota()"
desc: "Max Quota."
returns:
description: "the user defined functions quota."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getUserDefinedFunctionsUsage()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getUserDefinedFunctionsUsage()"
name: "getUserDefinedFunctionsUsage()"
nameWithType: "ResourceResponse<T>.getUserDefinedFunctionsUsage()"
summary: "Current Usage."
syntax: "public long getUserDefinedFunctionsUsage()"
desc: "Current Usage."
returns:
description: "the current user defined functions usage."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getUserQuota()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getUserQuota()"
name: "getUserQuota()"
nameWithType: "ResourceResponse<T>.getUserQuota()"
summary: "Max Quota."
syntax: "public long getUserQuota()"
desc: "Max Quota."
returns:
description: "the user quota."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.ResourceResponse.getUserUsage()"
fullName: "com.microsoft.azure.documentdb.ResourceResponse<T>.getUserUsage()"
name: "getUserUsage()"
nameWithType: "ResourceResponse<T>.getUserUsage()"
summary: "Current Usage."
syntax: "public long getUserUsage()"
desc: "Current Usage."
returns:
description: "the current user usage."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
type: "class"
typeParameters:
- description: "the resource type of the resource response."
name: "T"
desc: "Represents the service response to a request made from DocumentClient in the Azure Cosmos DB database service. Contains both the resource and the response headers."
metadata: {}
package: "com.microsoft.azure.documentdb"
artifact: com.microsoft.azure:azure-documentdb:2.4.7