-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.cosmos.models.CosmosBatchResponse.yml
169 lines (169 loc) · 11.2 KB
/
com.azure.cosmos.models.CosmosBatchResponse.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
### YamlMime:JavaType
uid: "com.azure.cosmos.models.CosmosBatchResponse"
fullName: "com.azure.cosmos.models.CosmosBatchResponse"
name: "CosmosBatchResponse"
nameWithType: "CosmosBatchResponse"
summary: "Response of a <xref uid=\"com.azure.cosmos.models.CosmosBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosBatch\"></xref> request."
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 **CosmosBatchResponse**"
methods:
- uid: "com.azure.cosmos.models.CosmosBatchResponse.getActivityId()"
fullName: "com.azure.cosmos.models.CosmosBatchResponse.getActivityId()"
name: "getActivityId()"
nameWithType: "CosmosBatchResponse.getActivityId()"
summary: "Gets the activity ID that identifies the server request made to execute the batch."
syntax: "public String getActivityId()"
desc: "Gets the activity ID that identifies the server request made to execute the batch."
returns:
description: "the activity ID that identifies the server request made to execute the batch."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.models.CosmosBatchResponse.getDiagnostics()"
fullName: "com.azure.cosmos.models.CosmosBatchResponse.getDiagnostics()"
name: "getDiagnostics()"
nameWithType: "CosmosBatchResponse.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.CosmosBatchResponse.getDuration()"
fullName: "com.azure.cosmos.models.CosmosBatchResponse.getDuration()"
name: "getDuration()"
nameWithType: "CosmosBatchResponse.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.CosmosBatchResponse.getErrorMessage()"
fullName: "com.azure.cosmos.models.CosmosBatchResponse.getErrorMessage()"
name: "getErrorMessage()"
nameWithType: "CosmosBatchResponse.getErrorMessage()"
summary: "Gets the reason for the failure of the batch request, if any, or `null`."
syntax: "public String getErrorMessage()"
desc: "Gets the reason for the failure of the batch request, if any, or `null`."
returns:
description: "the reason for the failure of the batch request, if any, or <code>null</code>."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.models.CosmosBatchResponse.getRequestCharge()"
fullName: "com.azure.cosmos.models.CosmosBatchResponse.getRequestCharge()"
name: "getRequestCharge()"
nameWithType: "CosmosBatchResponse.getRequestCharge()"
summary: "Gets the request charge as request units (RU) consumed by the batch operation."
syntax: "public double getRequestCharge()"
desc: "Gets the request charge as request units (RU) consumed by the batch 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.CosmosBatchResponse.getResponseHeaders()"
fullName: "com.azure.cosmos.models.CosmosBatchResponse.getResponseHeaders()"
name: "getResponseHeaders()"
nameWithType: "CosmosBatchResponse.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.CosmosBatchResponse.getResponseLength()"
fullName: "com.azure.cosmos.models.CosmosBatchResponse.getResponseLength()"
name: "getResponseLength()"
nameWithType: "CosmosBatchResponse.getResponseLength()"
summary: "Get the length of the response of a batch operation change it in the down path."
syntax: "public int getResponseLength()"
desc: "Get the length of the response of a batch operation change it in the down path."
returns:
description: "length of the response."
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBatchResponse.getResults()"
fullName: "com.azure.cosmos.models.CosmosBatchResponse.getResults()"
name: "getResults()"
nameWithType: "CosmosBatchResponse.getResults()"
summary: "Get all the results of the operations in a batch in an unmodifiable instance so no one can change it in the down path."
syntax: "public List<CosmosBatchOperationResult> getResults()"
desc: "Get all the results of the operations in a batch in an unmodifiable instance so no one can change it in the down path."
returns:
description: "Results of operations in a batch."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.cosmos.models.CosmosBatchOperationResult?alt=com.azure.cosmos.models.CosmosBatchOperationResult&text=CosmosBatchOperationResult\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.cosmos.models.CosmosBatchResponse.getRetryAfterDuration()"
fullName: "com.azure.cosmos.models.CosmosBatchResponse.getRetryAfterDuration()"
name: "getRetryAfterDuration()"
nameWithType: "CosmosBatchResponse.getRetryAfterDuration()"
summary: "Gets the amount of time to wait before retrying this or any other request due to throttling."
syntax: "public Duration getRetryAfterDuration()"
desc: "Gets the amount of time to wait before retrying this or any other request due to throttling."
returns:
description: "the amount of time to wait before retrying this or any other request due to throttling."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.cosmos.models.CosmosBatchResponse.getSessionToken()"
fullName: "com.azure.cosmos.models.CosmosBatchResponse.getSessionToken()"
name: "getSessionToken()"
nameWithType: "CosmosBatchResponse.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.CosmosBatchResponse.getStatusCode()"
fullName: "com.azure.cosmos.models.CosmosBatchResponse.getStatusCode()"
name: "getStatusCode()"
nameWithType: "CosmosBatchResponse.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.azure.cosmos.models.CosmosBatchResponse.getSubStatusCode()"
fullName: "com.azure.cosmos.models.CosmosBatchResponse.getSubStatusCode()"
name: "getSubStatusCode()"
nameWithType: "CosmosBatchResponse.getSubStatusCode()"
summary: "Gets the HTTP sub status code associated with the response."
syntax: "public int getSubStatusCode()"
desc: "Gets the HTTP sub status code associated with the response."
returns:
description: "the sub status code."
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBatchResponse.isSuccessStatusCode()"
fullName: "com.azure.cosmos.models.CosmosBatchResponse.isSuccessStatusCode()"
name: "isSuccessStatusCode()"
nameWithType: "CosmosBatchResponse.isSuccessStatusCode()"
summary: "Returns a value indicating whether the batch was successfully processed."
syntax: "public boolean isSuccessStatusCode()"
desc: "Returns a value indicating whether the batch was successfully processed."
returns:
description: "a value indicating whether the batch was successfully processed."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBatchResponse.size()"
fullName: "com.azure.cosmos.models.CosmosBatchResponse.size()"
name: "size()"
nameWithType: "CosmosBatchResponse.size()"
summary: "Gets the number of operation results."
syntax: "public int size()"
desc: "Gets the number of operation results."
returns:
description: "the number of operations results in this response."
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Response of a <xref uid=\"com.azure.cosmos.models.CosmosBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosBatch\"></xref> request."
metadata: {}
package: "com.azure.cosmos.models"
artifact: com.azure:azure-cosmos:4.62.0