azure-docs-sdk-java/docs-ref-autogen/com.azure.cosmos.models.Cos...

588 строки
48 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.cosmos.models.CosmosBulkOperations"
fullName: "com.azure.cosmos.models.CosmosBulkOperations"
name: "CosmosBulkOperations"
nameWithType: "CosmosBulkOperations"
summary: "Utility for creating bulk operations which can be executed by calling <xref uid=\"com.azure.cosmos.CosmosAsyncContainer.<TContext>executeBulkOperations(reactor.core.publisher.Flux<com.azure.cosmos.models.CosmosItemOperation>,com.azure.cosmos.models.CosmosBulkExecutionOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosAsyncContainer#executeBulkOperations(Flux, CosmosBulkExecutionOptions)\"></xref> ."
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 **CosmosBulkOperations**"
constructors:
- uid: "com.azure.cosmos.models.CosmosBulkOperations.CosmosBulkOperations()"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.CosmosBulkOperations()"
name: "CosmosBulkOperations()"
nameWithType: "CosmosBulkOperations.CosmosBulkOperations()"
syntax: "public CosmosBulkOperations()"
methods:
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<T,TContext>getCreateItemOperation(T,com.azure.cosmos.models.PartitionKey,TContext)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.<T,TContext>getCreateItemOperation(T item, PartitionKey partitionKey, TContext context)"
name: "<T,TContext>getCreateItemOperation(T item, PartitionKey partitionKey, TContext context)"
nameWithType: "CosmosBulkOperations.<T,TContext>getCreateItemOperation(T item, PartitionKey partitionKey, TContext context)"
summary: "Instantiate an operation for Creating item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "A JSON serializable object that must contain an id property."
name: "item"
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- description: "the partition key for the operation"
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "The caller provided context for this operation."
name: "context"
type: "<xref href=\"TContext?alt=TContext&text=TContext\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <T,TContext>getCreateItemOperation(T item, PartitionKey partitionKey, TContext context)"
desc: "Instantiate an operation for Creating item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<T,TContext>getCreateItemOperation(T,com.azure.cosmos.models.PartitionKey,com.azure.cosmos.models.CosmosBulkItemRequestOptions,TContext)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.<T,TContext>getCreateItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
name: "<T,TContext>getCreateItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
nameWithType: "CosmosBulkOperations.<T,TContext>getCreateItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
summary: "Instantiate an operation for Creating item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "A JSON serializable object that must contain an id property."
name: "item"
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "The options for the item request."
name: "requestOptions"
type: "<xref href=\"com.azure.cosmos.models.CosmosBulkItemRequestOptions?alt=com.azure.cosmos.models.CosmosBulkItemRequestOptions&text=CosmosBulkItemRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- description: "The caller provided context for this operation."
name: "context"
type: "<xref href=\"TContext?alt=TContext&text=TContext\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <T,TContext>getCreateItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
desc: "Instantiate an operation for Creating item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<T,TContext>getReplaceItemOperation(java.lang.String,T,com.azure.cosmos.models.PartitionKey,TContext)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.<T,TContext>getReplaceItemOperation(String id, T item, PartitionKey partitionKey, TContext context)"
name: "<T,TContext>getReplaceItemOperation(String id, T item, PartitionKey partitionKey, TContext context)"
nameWithType: "CosmosBulkOperations.<T,TContext>getReplaceItemOperation(String id, T item, PartitionKey partitionKey, TContext context)"
summary: "Instantiate an operation for replace item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "The unique id of the item."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A JSON serializable object that must contain an id property."
name: "item"
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "The caller provided context for this operation."
name: "context"
type: "<xref href=\"TContext?alt=TContext&text=TContext\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <T,TContext>getReplaceItemOperation(String id, T item, PartitionKey partitionKey, TContext context)"
desc: "Instantiate an operation for replace item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<T,TContext>getReplaceItemOperation(java.lang.String,T,com.azure.cosmos.models.PartitionKey,com.azure.cosmos.models.CosmosBulkItemRequestOptions,TContext)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.<T,TContext>getReplaceItemOperation(String id, T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
name: "<T,TContext>getReplaceItemOperation(String id, T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
nameWithType: "CosmosBulkOperations.<T,TContext>getReplaceItemOperation(String id, T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
summary: "Instantiate an operation for replace item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "The unique id of the item.."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A JSON serializable object that must contain an id property."
name: "item"
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "The options for the item request."
name: "requestOptions"
type: "<xref href=\"com.azure.cosmos.models.CosmosBulkItemRequestOptions?alt=com.azure.cosmos.models.CosmosBulkItemRequestOptions&text=CosmosBulkItemRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- description: "The caller provided context for this operation."
name: "context"
type: "<xref href=\"TContext?alt=TContext&text=TContext\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <T,TContext>getReplaceItemOperation(String id, T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
desc: "Instantiate an operation for replace item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<T,TContext>getUpsertItemOperation(T,com.azure.cosmos.models.PartitionKey,TContext)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.<T,TContext>getUpsertItemOperation(T item, PartitionKey partitionKey, TContext context)"
name: "<T,TContext>getUpsertItemOperation(T item, PartitionKey partitionKey, TContext context)"
nameWithType: "CosmosBulkOperations.<T,TContext>getUpsertItemOperation(T item, PartitionKey partitionKey, TContext context)"
summary: "Instantiate an operation for upsert item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "A JSON serializable object that must contain an id property."
name: "item"
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "The caller provided context for this operation."
name: "context"
type: "<xref href=\"TContext?alt=TContext&text=TContext\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <T,TContext>getUpsertItemOperation(T item, PartitionKey partitionKey, TContext context)"
desc: "Instantiate an operation for upsert item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<T,TContext>getUpsertItemOperation(T,com.azure.cosmos.models.PartitionKey,com.azure.cosmos.models.CosmosBulkItemRequestOptions,TContext)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.<T,TContext>getUpsertItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
name: "<T,TContext>getUpsertItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
nameWithType: "CosmosBulkOperations.<T,TContext>getUpsertItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
summary: "Instantiate an operation for upsert item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "A JSON serializable object that must contain an id property."
name: "item"
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "The options for the item request."
name: "requestOptions"
type: "<xref href=\"com.azure.cosmos.models.CosmosBulkItemRequestOptions?alt=com.azure.cosmos.models.CosmosBulkItemRequestOptions&text=CosmosBulkItemRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- description: "The caller provided context for this operation."
name: "context"
type: "<xref href=\"TContext?alt=TContext&text=TContext\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <T,TContext>getUpsertItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
desc: "Instantiate an operation for upsert item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<T>getCreateItemOperation(T,com.azure.cosmos.models.PartitionKey)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getCreateItemOperation(T item, PartitionKey partitionKey)"
name: "getCreateItemOperation(T item, PartitionKey partitionKey)"
nameWithType: "CosmosBulkOperations.getCreateItemOperation(T item, PartitionKey partitionKey)"
summary: "Instantiate an operation for Creating item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "A JSON serializable object that must contain an id property."
name: "item"
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- description: "the partition key for the operation"
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <T>getCreateItemOperation(T item, PartitionKey partitionKey)"
desc: "Instantiate an operation for Creating item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<T>getCreateItemOperation(T,com.azure.cosmos.models.PartitionKey,com.azure.cosmos.models.CosmosBulkItemRequestOptions)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getCreateItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
name: "getCreateItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
nameWithType: "CosmosBulkOperations.getCreateItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
summary: "Instantiate an operation for Creating item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "A JSON serializable object that must contain an id property."
name: "item"
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "The options for the item request."
name: "requestOptions"
type: "<xref href=\"com.azure.cosmos.models.CosmosBulkItemRequestOptions?alt=com.azure.cosmos.models.CosmosBulkItemRequestOptions&text=CosmosBulkItemRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <T>getCreateItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
desc: "Instantiate an operation for Creating item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<T>getReplaceItemOperation(java.lang.String,T,com.azure.cosmos.models.PartitionKey)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getReplaceItemOperation(String id, T item, PartitionKey partitionKey)"
name: "getReplaceItemOperation(String id, T item, PartitionKey partitionKey)"
nameWithType: "CosmosBulkOperations.getReplaceItemOperation(String id, T item, PartitionKey partitionKey)"
summary: "Instantiate an operation for replace item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "The unique id of the item."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A JSON serializable object that must contain an id property."
name: "item"
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <T>getReplaceItemOperation(String id, T item, PartitionKey partitionKey)"
desc: "Instantiate an operation for replace item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<T>getReplaceItemOperation(java.lang.String,T,com.azure.cosmos.models.PartitionKey,com.azure.cosmos.models.CosmosBulkItemRequestOptions)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getReplaceItemOperation(String id, T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
name: "getReplaceItemOperation(String id, T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
nameWithType: "CosmosBulkOperations.getReplaceItemOperation(String id, T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
summary: "Instantiate an operation for replace item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "The unique id of the item.."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "A JSON serializable object that must contain an id property."
name: "item"
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "The options for the item request."
name: "requestOptions"
type: "<xref href=\"com.azure.cosmos.models.CosmosBulkItemRequestOptions?alt=com.azure.cosmos.models.CosmosBulkItemRequestOptions&text=CosmosBulkItemRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <T>getReplaceItemOperation(String id, T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
desc: "Instantiate an operation for replace item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<T>getUpsertItemOperation(T,com.azure.cosmos.models.PartitionKey)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getUpsertItemOperation(T item, PartitionKey partitionKey)"
name: "getUpsertItemOperation(T item, PartitionKey partitionKey)"
nameWithType: "CosmosBulkOperations.getUpsertItemOperation(T item, PartitionKey partitionKey)"
summary: "Instantiate an operation for upsert item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "A JSON serializable object that must contain an id property."
name: "item"
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <T>getUpsertItemOperation(T item, PartitionKey partitionKey)"
desc: "Instantiate an operation for upsert item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<T>getUpsertItemOperation(T,com.azure.cosmos.models.PartitionKey,com.azure.cosmos.models.CosmosBulkItemRequestOptions)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getUpsertItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
name: "getUpsertItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
nameWithType: "CosmosBulkOperations.getUpsertItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
summary: "Instantiate an operation for upsert item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "A JSON serializable object that must contain an id property."
name: "item"
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "The options for the item request."
name: "requestOptions"
type: "<xref href=\"com.azure.cosmos.models.CosmosBulkItemRequestOptions?alt=com.azure.cosmos.models.CosmosBulkItemRequestOptions&text=CosmosBulkItemRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <T>getUpsertItemOperation(T item, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
desc: "Instantiate an operation for upsert item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<TContext>getDeleteItemOperation(java.lang.String,com.azure.cosmos.models.PartitionKey,TContext)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey, TContext context)"
name: "getDeleteItemOperation(String id, PartitionKey partitionKey, TContext context)"
nameWithType: "CosmosBulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey, TContext context)"
summary: "Instantiate an operation for deleting item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "The unique id of the item."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "The caller provided context for this operation."
name: "context"
type: "<xref href=\"TContext?alt=TContext&text=TContext\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <TContext>getDeleteItemOperation(String id, PartitionKey partitionKey, TContext context)"
desc: "Instantiate an operation for deleting item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<TContext>getDeleteItemOperation(java.lang.String,com.azure.cosmos.models.PartitionKey,com.azure.cosmos.models.CosmosBulkItemRequestOptions,TContext)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
name: "getDeleteItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
nameWithType: "CosmosBulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
summary: "Instantiate an operation for deleting item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "The unique id of the item."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the partition key for the operation.."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "The options for the item request."
name: "requestOptions"
type: "<xref href=\"com.azure.cosmos.models.CosmosBulkItemRequestOptions?alt=com.azure.cosmos.models.CosmosBulkItemRequestOptions&text=CosmosBulkItemRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- description: "The caller provided context for this operation."
name: "context"
type: "<xref href=\"TContext?alt=TContext&text=TContext\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <TContext>getDeleteItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
desc: "Instantiate an operation for deleting item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<TContext>getPatchItemOperation(java.lang.String,com.azure.cosmos.models.PartitionKey,com.azure.cosmos.models.CosmosPatchOperations,TContext)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, TContext context)"
name: "getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, TContext context)"
nameWithType: "CosmosBulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, TContext context)"
summary: "Instantiate an operation for a patch in Bulk execution."
modifiers:
- "static"
parameters:
- description: "the item id."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "Represents a container having list of operations to be sequentially\n applied to the referred Cosmos item."
name: "cosmosPatchOperations"
type: "<xref href=\"com.azure.cosmos.models.CosmosPatchOperations?alt=com.azure.cosmos.models.CosmosPatchOperations&text=CosmosPatchOperations\" data-throw-if-not-resolved=\"False\" />"
- description: "The caller provided context for this operation."
name: "context"
type: "<xref href=\"TContext?alt=TContext&text=TContext\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <TContext>getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, TContext context)"
desc: "Instantiate an operation for a patch in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<TContext>getPatchItemOperation(java.lang.String,com.azure.cosmos.models.PartitionKey,com.azure.cosmos.models.CosmosPatchOperations,com.azure.cosmos.models.CosmosBulkPatchItemRequestOptions,TContext)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosBulkPatchItemRequestOptions requestOptions, TContext context)"
name: "getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosBulkPatchItemRequestOptions requestOptions, TContext context)"
nameWithType: "CosmosBulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosBulkPatchItemRequestOptions requestOptions, TContext context)"
summary: "Instantiate an operation for a patch in Bulk execution."
modifiers:
- "static"
parameters:
- description: "the item id."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "Represents a container having list of operations to be sequentially applied to the referred Cosmos item."
name: "cosmosPatchOperations"
type: "<xref href=\"com.azure.cosmos.models.CosmosPatchOperations?alt=com.azure.cosmos.models.CosmosPatchOperations&text=CosmosPatchOperations\" data-throw-if-not-resolved=\"False\" />"
- description: "The options for the item request."
name: "requestOptions"
type: "<xref href=\"com.azure.cosmos.models.CosmosBulkPatchItemRequestOptions?alt=com.azure.cosmos.models.CosmosBulkPatchItemRequestOptions&text=CosmosBulkPatchItemRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- description: "The caller provided context for this operation."
name: "context"
type: "<xref href=\"TContext?alt=TContext&text=TContext\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <TContext>getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosBulkPatchItemRequestOptions requestOptions, TContext context)"
desc: "Instantiate an operation for a patch in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<TContext>getReadItemOperation(java.lang.String,com.azure.cosmos.models.PartitionKey,TContext)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getReadItemOperation(String id, PartitionKey partitionKey, TContext context)"
name: "getReadItemOperation(String id, PartitionKey partitionKey, TContext context)"
nameWithType: "CosmosBulkOperations.getReadItemOperation(String id, PartitionKey partitionKey, TContext context)"
summary: "Instantiate an operation for read item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "The unique id of the item."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "The caller provided context for this operation."
name: "context"
type: "<xref href=\"TContext?alt=TContext&text=TContext\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <TContext>getReadItemOperation(String id, PartitionKey partitionKey, TContext context)"
desc: "Instantiate an operation for read item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.<TContext>getReadItemOperation(java.lang.String,com.azure.cosmos.models.PartitionKey,com.azure.cosmos.models.CosmosBulkItemRequestOptions,TContext)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getReadItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
name: "getReadItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
nameWithType: "CosmosBulkOperations.getReadItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
summary: "Instantiate an operation for read item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "The unique id of the item."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the partition key for the operation.."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "The options for the item request."
name: "requestOptions"
type: "<xref href=\"com.azure.cosmos.models.CosmosBulkItemRequestOptions?alt=com.azure.cosmos.models.CosmosBulkItemRequestOptions&text=CosmosBulkItemRequestOptions\" data-throw-if-not-resolved=\"False\" />"
- description: "The caller provided context for this operation."
name: "context"
type: "<xref href=\"TContext?alt=TContext&text=TContext\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation <TContext>getReadItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions, TContext context)"
desc: "Instantiate an operation for read item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.getDeleteItemOperation(java.lang.String,com.azure.cosmos.models.PartitionKey)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey)"
name: "getDeleteItemOperation(String id, PartitionKey partitionKey)"
nameWithType: "CosmosBulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey)"
summary: "Instantiate an operation for deleting item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "The unique id of the item."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation getDeleteItemOperation(String id, PartitionKey partitionKey)"
desc: "Instantiate an operation for deleting item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.getDeleteItemOperation(java.lang.String,com.azure.cosmos.models.PartitionKey,com.azure.cosmos.models.CosmosBulkItemRequestOptions)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
name: "getDeleteItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
nameWithType: "CosmosBulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
summary: "Instantiate an operation for deleting item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "The unique id of the item."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the partition key for the operation.."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "The options for the item request."
name: "requestOptions"
type: "<xref href=\"com.azure.cosmos.models.CosmosBulkItemRequestOptions?alt=com.azure.cosmos.models.CosmosBulkItemRequestOptions&text=CosmosBulkItemRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation getDeleteItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
desc: "Instantiate an operation for deleting item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.getPatchItemOperation(java.lang.String,com.azure.cosmos.models.PartitionKey,com.azure.cosmos.models.CosmosPatchOperations)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations)"
name: "getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations)"
nameWithType: "CosmosBulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations)"
summary: "Instantiate an operation for a patch in Bulk execution."
modifiers:
- "static"
parameters:
- description: "the item id."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "Represents a container having list of operations to be sequentially applied to the referred Cosmos item."
name: "cosmosPatchOperations"
type: "<xref href=\"com.azure.cosmos.models.CosmosPatchOperations?alt=com.azure.cosmos.models.CosmosPatchOperations&text=CosmosPatchOperations\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations)"
desc: "Instantiate an operation for a patch in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.getPatchItemOperation(java.lang.String,com.azure.cosmos.models.PartitionKey,com.azure.cosmos.models.CosmosPatchOperations,com.azure.cosmos.models.CosmosBulkPatchItemRequestOptions)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosBulkPatchItemRequestOptions requestOptions)"
name: "getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosBulkPatchItemRequestOptions requestOptions)"
nameWithType: "CosmosBulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosBulkPatchItemRequestOptions requestOptions)"
summary: "Instantiate an operation for a patch in Bulk execution."
modifiers:
- "static"
parameters:
- description: "the item id."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "Represents a container having list of operations to be sequentially applied to the referred Cosmos item."
name: "cosmosPatchOperations"
type: "<xref href=\"com.azure.cosmos.models.CosmosPatchOperations?alt=com.azure.cosmos.models.CosmosPatchOperations&text=CosmosPatchOperations\" data-throw-if-not-resolved=\"False\" />"
- description: "The options for the item request."
name: "requestOptions"
type: "<xref href=\"com.azure.cosmos.models.CosmosBulkPatchItemRequestOptions?alt=com.azure.cosmos.models.CosmosBulkPatchItemRequestOptions&text=CosmosBulkPatchItemRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosBulkPatchItemRequestOptions requestOptions)"
desc: "Instantiate an operation for a patch in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.getReadItemOperation(java.lang.String,com.azure.cosmos.models.PartitionKey)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getReadItemOperation(String id, PartitionKey partitionKey)"
name: "getReadItemOperation(String id, PartitionKey partitionKey)"
nameWithType: "CosmosBulkOperations.getReadItemOperation(String id, PartitionKey partitionKey)"
summary: "Instantiate an operation for read item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "The unique id of the item."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the partition key for the operation."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation getReadItemOperation(String id, PartitionKey partitionKey)"
desc: "Instantiate an operation for read item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.CosmosBulkOperations.getReadItemOperation(java.lang.String,com.azure.cosmos.models.PartitionKey,com.azure.cosmos.models.CosmosBulkItemRequestOptions)"
fullName: "com.azure.cosmos.models.CosmosBulkOperations.getReadItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
name: "getReadItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
nameWithType: "CosmosBulkOperations.getReadItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
summary: "Instantiate an operation for read item in Bulk execution."
modifiers:
- "static"
parameters:
- description: "The unique id of the item."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the partition key for the operation.."
name: "partitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- description: "The options for the item request."
name: "requestOptions"
type: "<xref href=\"com.azure.cosmos.models.CosmosBulkItemRequestOptions?alt=com.azure.cosmos.models.CosmosBulkItemRequestOptions&text=CosmosBulkItemRequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static CosmosItemOperation getReadItemOperation(String id, PartitionKey partitionKey, CosmosBulkItemRequestOptions requestOptions)"
desc: "Instantiate an operation for read item in Bulk execution."
returns:
description: "the bulk operation."
type: "<xref href=\"com.azure.cosmos.models.CosmosItemOperation?alt=com.azure.cosmos.models.CosmosItemOperation&text=CosmosItemOperation\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Utility for creating bulk operations which can be executed by calling <xref uid=\"com.azure.cosmos.CosmosAsyncContainer.<TContext>executeBulkOperations(reactor.core.publisher.Flux<com.azure.cosmos.models.CosmosItemOperation>,com.azure.cosmos.models.CosmosBulkExecutionOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosAsyncContainer#executeBulkOperations(Flux, CosmosBulkExecutionOptions)\"></xref> . Also while creating these operation, if some options which are only for individual operation can be provided by passing a <xref uid=\"com.azure.cosmos.models.CosmosBulkItemRequestOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosBulkItemRequestOptions\"></xref> while creating the bulk operation. See also <xref uid=\"com.azure.cosmos.models.CosmosBulkExecutionOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CosmosBulkExecutionOptions\"></xref>."
metadata: {}
package: "com.azure.cosmos.models"
artifact: com.azure:azure-cosmos:4.63.3