-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.cosmos.models.CosmosBulkItemRequestOptions.yml
109 lines (109 loc) · 10.8 KB
/
com.azure.cosmos.models.CosmosBulkItemRequestOptions.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
### YamlMime:JavaType
uid: "com.azure.cosmos.models.CosmosBulkItemRequestOptions"
fullName: "com.azure.cosmos.models.CosmosBulkItemRequestOptions"
name: "CosmosBulkItemRequestOptions"
nameWithType: "CosmosBulkItemRequestOptions"
summary: "Encapsulates options that can be specified for an operation used in Bulk execution."
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 **CosmosBulkItemRequestOptions**"
constructors:
- uid: "com.azure.cosmos.models.CosmosBulkItemRequestOptions.CosmosBulkItemRequestOptions()"
fullName: "com.azure.cosmos.models.CosmosBulkItemRequestOptions.CosmosBulkItemRequestOptions()"
name: "CosmosBulkItemRequestOptions()"
nameWithType: "CosmosBulkItemRequestOptions.CosmosBulkItemRequestOptions()"
summary: "Constructor"
syntax: "public CosmosBulkItemRequestOptions()"
desc: "Constructor"
methods:
- uid: "com.azure.cosmos.models.CosmosBulkItemRequestOptions.getIfMatchETag()"
fullName: "com.azure.cosmos.models.CosmosBulkItemRequestOptions.getIfMatchETag()"
name: "getIfMatchETag()"
nameWithType: "CosmosBulkItemRequestOptions.getIfMatchETag()"
summary: "Gets the If-Match (ETag) associated with the operation in <xref uid=\"com.azure.cosmos.models.CosmosItemOperation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosItemOperation\"></xref>."
syntax: "public String getIfMatchETag()"
desc: "Gets the If-Match (ETag) associated with the operation in <xref uid=\"com.azure.cosmos.models.CosmosItemOperation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosItemOperation\"></xref>."
returns:
description: "ifMatchETag 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.CosmosBulkItemRequestOptions.getIfNoneMatchETag()"
fullName: "com.azure.cosmos.models.CosmosBulkItemRequestOptions.getIfNoneMatchETag()"
name: "getIfNoneMatchETag()"
nameWithType: "CosmosBulkItemRequestOptions.getIfNoneMatchETag()"
summary: "Gets the If-None-Match (ETag) associated with the request in operation in <xref uid=\"com.azure.cosmos.models.CosmosItemOperation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosItemOperation\"></xref>."
syntax: "public String getIfNoneMatchETag()"
desc: "Gets the If-None-Match (ETag) associated with the request in operation in <xref uid=\"com.azure.cosmos.models.CosmosItemOperation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosItemOperation\"></xref>."
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.CosmosBulkItemRequestOptions.isContentResponseOnWriteEnabled()"
fullName: "com.azure.cosmos.models.CosmosBulkItemRequestOptions.isContentResponseOnWriteEnabled()"
name: "isContentResponseOnWriteEnabled()"
nameWithType: "CosmosBulkItemRequestOptions.isContentResponseOnWriteEnabled()"
summary: "Gets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations in <xref uid=\"com.azure.cosmos.models.CosmosItemOperation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosItemOperation\"></xref>."
syntax: "public Boolean isContentResponseOnWriteEnabled()"
desc: "Gets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations in <xref uid=\"com.azure.cosmos.models.CosmosItemOperation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosItemOperation\"></xref>. If set to false, service doesn't return payload in the response. It reduces networking and CPU load by not sending the payload back over the network and serializing it on the client. This feature does not impact RU usage for read or write operations. By-default, this is null."
returns:
description: "a boolean indicating whether payload will be included in the response or not for this operation."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.cosmos.models.CosmosBulkItemRequestOptions.setContentResponseOnWriteEnabled(java.lang.Boolean)"
fullName: "com.azure.cosmos.models.CosmosBulkItemRequestOptions.setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled)"
name: "setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled)"
nameWithType: "CosmosBulkItemRequestOptions.setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled)"
summary: "Sets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations in <xref uid=\"com.azure.cosmos.models.CosmosItemOperation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosItemOperation\"></xref>."
parameters:
- description: "a boolean indicating whether payload will be included\n in the response or not for this operation."
name: "contentResponseOnWriteEnabled"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public CosmosBulkItemRequestOptions setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled)"
desc: "Sets the boolean to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete operations in <xref uid=\"com.azure.cosmos.models.CosmosItemOperation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosItemOperation\"></xref>. If set to false, service doesn't return payload in the response. It reduces networking and CPU load by not sending the payload back over the network and serializing it on the client. This feature does not impact RU usage for read or write operations. By-default, this is null. NOTE: This flag is also present on <xref uid=\"com.azure.cosmos.CosmosClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosClientBuilder\"></xref>, however if specified here, it will override the value specified in <xref uid=\"com.azure.cosmos.CosmosClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosClientBuilder\"></xref> for this request."
returns:
description: "the current request options."
type: "<xref href=\"com.azure.cosmos.models.CosmosBulkItemRequestOptions?alt=com.azure.cosmos.models.CosmosBulkItemRequestOptions&text=CosmosBulkItemRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkItemRequestOptions.setIfMatchETag(java.lang.String)"
fullName: "com.azure.cosmos.models.CosmosBulkItemRequestOptions.setIfMatchETag(String ifMatchETag)"
name: "setIfMatchETag(String ifMatchETag)"
nameWithType: "CosmosBulkItemRequestOptions.setIfMatchETag(String ifMatchETag)"
summary: "Sets the If-Match (ETag) associated with the operation in <xref uid=\"com.azure.cosmos.models.CosmosItemOperation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosItemOperation\"></xref>."
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 CosmosBulkItemRequestOptions setIfMatchETag(String ifMatchETag)"
desc: "Sets the If-Match (ETag) associated with the operation in <xref uid=\"com.azure.cosmos.models.CosmosItemOperation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosItemOperation\"></xref>."
returns:
description: "the current request options"
type: "<xref href=\"com.azure.cosmos.models.CosmosBulkItemRequestOptions?alt=com.azure.cosmos.models.CosmosBulkItemRequestOptions&text=CosmosBulkItemRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkItemRequestOptions.setIfNoneMatchETag(java.lang.String)"
fullName: "com.azure.cosmos.models.CosmosBulkItemRequestOptions.setIfNoneMatchETag(String ifNoneMatchEtag)"
name: "setIfNoneMatchETag(String ifNoneMatchEtag)"
nameWithType: "CosmosBulkItemRequestOptions.setIfNoneMatchETag(String ifNoneMatchEtag)"
summary: "Sets the If-None-Match (ETag) associated with the request in operation in <xref uid=\"com.azure.cosmos.models.CosmosItemOperation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosItemOperation\"></xref>."
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 CosmosBulkItemRequestOptions setIfNoneMatchETag(String ifNoneMatchEtag)"
desc: "Sets the If-None-Match (ETag) associated with the request in operation in <xref uid=\"com.azure.cosmos.models.CosmosItemOperation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosItemOperation\"></xref>."
returns:
description: "the current request options."
type: "<xref href=\"com.azure.cosmos.models.CosmosBulkItemRequestOptions?alt=com.azure.cosmos.models.CosmosBulkItemRequestOptions&text=CosmosBulkItemRequestOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Encapsulates options that can be specified for an operation used in Bulk execution. It can be passed while creating bulk request using <xref uid=\"com.azure.cosmos.models.CosmosBulkOperations\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosBulkOperations\"></xref>."
metadata: {}
package: "com.azure.cosmos.models"
artifact: com.azure:azure-cosmos:4.62.0