132 строки
11 KiB
YAML
132 строки
11 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.indexes.models.IndexDocumentsBatch"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexDocumentsBatch<T>"
|
|
name: "IndexDocumentsBatch<T>"
|
|
nameWithType: "IndexDocumentsBatch<T>"
|
|
summary: "Contains a batch of document write actions to send to the index."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.models.IndexBatchBase?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.search.documents.models.IndexBatchBase?alt=com.azure.search.documents.models.IndexBatchBase&text=IndexBatchBase\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.search.documents.models.IndexBatchBase.getActions()?alt=com.azure.search.documents.models.IndexBatchBase.getActions&text=getActions\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public class **IndexDocumentsBatch<T>**</br> extends <xref href=\"com.azure.search.documents.models.IndexBatchBase?alt=com.azure.search.documents.models.IndexBatchBase&text=IndexBatchBase\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.indexes.models.IndexDocumentsBatch.IndexDocumentsBatch()"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexDocumentsBatch<T>.IndexDocumentsBatch()"
|
|
name: "IndexDocumentsBatch()"
|
|
nameWithType: "IndexDocumentsBatch<T>.IndexDocumentsBatch()"
|
|
summary: "Constructor of <xref uid=\"com.azure.search.documents.indexes.models.IndexDocumentsBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IndexDocumentsBatch\"></xref>."
|
|
syntax: "public IndexDocumentsBatch()"
|
|
desc: "Constructor of <xref uid=\"com.azure.search.documents.indexes.models.IndexDocumentsBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IndexDocumentsBatch\"></xref>."
|
|
methods:
|
|
- uid: "com.azure.search.documents.indexes.models.IndexDocumentsBatch.addActions(java.lang.Iterable<com.azure.search.documents.models.IndexAction<T>>)"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexDocumentsBatch<T>.addActions(Iterable<IndexAction<T>> actions)"
|
|
name: "addActions(Iterable<IndexAction<T>> actions)"
|
|
nameWithType: "IndexDocumentsBatch<T>.addActions(Iterable<IndexAction<T>> actions)"
|
|
summary: "Adds document index actions to the batch."
|
|
parameters:
|
|
- description: "Index actions."
|
|
name: "actions"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.azure.search.documents.models.IndexAction?alt=com.azure.search.documents.models.IndexAction&text=IndexAction\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>>"
|
|
syntax: "public IndexDocumentsBatch<T> addActions(Iterable<IndexAction<T>> actions)"
|
|
desc: "Adds document index actions to the batch."
|
|
returns:
|
|
description: "The updated IndexDocumentsBatch object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.IndexDocumentsBatch?alt=com.azure.search.documents.indexes.models.IndexDocumentsBatch&text=IndexDocumentsBatch\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.documents.indexes.models.IndexDocumentsBatch.addDeleteActions(java.lang.Iterable<T>)"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexDocumentsBatch<T>.addDeleteActions(Iterable<T> documents)"
|
|
name: "addDeleteActions(Iterable<T> documents)"
|
|
nameWithType: "IndexDocumentsBatch<T>.addDeleteActions(Iterable<T> documents)"
|
|
summary: "Adds document delete actions to the batch."
|
|
parameters:
|
|
- description: "Document to be deleted."
|
|
name: "documents"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public IndexDocumentsBatch<T> addDeleteActions(Iterable<T> documents)"
|
|
desc: "Adds document delete actions to the batch."
|
|
returns:
|
|
description: "The updated IndexDocumentsBatch object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.IndexDocumentsBatch?alt=com.azure.search.documents.indexes.models.IndexDocumentsBatch&text=IndexDocumentsBatch\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.documents.indexes.models.IndexDocumentsBatch.addDeleteActions(java.lang.String,java.lang.Iterable<java.lang.String>)"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexDocumentsBatch<T>.addDeleteActions(String keyName, Iterable<String> keyValues)"
|
|
name: "addDeleteActions(String keyName, Iterable<String> keyValues)"
|
|
nameWithType: "IndexDocumentsBatch<T>.addDeleteActions(String keyName, Iterable<String> keyValues)"
|
|
summary: "Adds document delete actions based on key IDs to the batch."
|
|
parameters:
|
|
- description: "The key field name."
|
|
name: "keyName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Keys of the documents to delete."
|
|
name: "keyValues"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public IndexDocumentsBatch<T> addDeleteActions(String keyName, Iterable<String> keyValues)"
|
|
desc: "Adds document delete actions based on key IDs to the batch."
|
|
returns:
|
|
description: "The updated IndexDocumentsBatch object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.IndexDocumentsBatch?alt=com.azure.search.documents.indexes.models.IndexDocumentsBatch&text=IndexDocumentsBatch\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.documents.indexes.models.IndexDocumentsBatch.addMergeActions(java.lang.Iterable<T>)"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexDocumentsBatch<T>.addMergeActions(Iterable<T> documents)"
|
|
name: "addMergeActions(Iterable<T> documents)"
|
|
nameWithType: "IndexDocumentsBatch<T>.addMergeActions(Iterable<T> documents)"
|
|
summary: "Adds merge document actions to the batch."
|
|
parameters:
|
|
- description: "Documents to be merged."
|
|
name: "documents"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public IndexDocumentsBatch<T> addMergeActions(Iterable<T> documents)"
|
|
desc: "Adds merge document actions to the batch."
|
|
returns:
|
|
description: "The updated IndexDocumentsBatch object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.IndexDocumentsBatch?alt=com.azure.search.documents.indexes.models.IndexDocumentsBatch&text=IndexDocumentsBatch\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.documents.indexes.models.IndexDocumentsBatch.addMergeOrUploadActions(java.lang.Iterable<T>)"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexDocumentsBatch<T>.addMergeOrUploadActions(Iterable<T> documents)"
|
|
name: "addMergeOrUploadActions(Iterable<T> documents)"
|
|
nameWithType: "IndexDocumentsBatch<T>.addMergeOrUploadActions(Iterable<T> documents)"
|
|
summary: "Adds merge or upload document actions to the batch."
|
|
parameters:
|
|
- description: "Documents to be merged or uploaded."
|
|
name: "documents"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public IndexDocumentsBatch<T> addMergeOrUploadActions(Iterable<T> documents)"
|
|
desc: "Adds merge or upload document actions to the batch."
|
|
returns:
|
|
description: "The updated IndexDocumentsBatch object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.IndexDocumentsBatch?alt=com.azure.search.documents.indexes.models.IndexDocumentsBatch&text=IndexDocumentsBatch\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.documents.indexes.models.IndexDocumentsBatch.addUploadActions(java.lang.Iterable<T>)"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexDocumentsBatch<T>.addUploadActions(Iterable<T> documents)"
|
|
name: "addUploadActions(Iterable<T> documents)"
|
|
nameWithType: "IndexDocumentsBatch<T>.addUploadActions(Iterable<T> documents)"
|
|
summary: "Adds upload document actions to the batch."
|
|
parameters:
|
|
- description: "Documents to be uploaded."
|
|
name: "documents"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public IndexDocumentsBatch<T> addUploadActions(Iterable<T> documents)"
|
|
desc: "Adds upload document actions to the batch."
|
|
returns:
|
|
description: "The updated IndexDocumentsBatch object."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.IndexDocumentsBatch?alt=com.azure.search.documents.indexes.models.IndexDocumentsBatch&text=IndexDocumentsBatch\" data-throw-if-not-resolved=\"False\" /><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "class"
|
|
typeParameters:
|
|
- description: "The type of documents contained by the indexing batch."
|
|
name: "T"
|
|
desc: "Contains a batch of document write actions to send to the index."
|
|
metadata: {}
|
|
package: "com.azure.search.documents.indexes.models"
|
|
artifact: com.azure:azure-search-documents:11.7.3
|