104 строки
10 KiB
YAML
104 строки
10 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.models.IndexBatchException"
|
|
fullName: "com.azure.search.documents.models.IndexBatchException"
|
|
name: "IndexBatchException"
|
|
nameWithType: "IndexBatchException"
|
|
summary: "An `IndexBatchException` is thrown whenever Azure AI Search index call was only partially successful."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Throwable?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Exception?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.RuntimeException?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.exception.AzureException?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#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>"
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html\">Throwable</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html#addSuppressed-java.lang.Throwable-\">addSuppressed</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html#fillInStackTrace--\">fillInStackTrace</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html#getCause--\">getCause</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html#getLocalizedMessage--\">getLocalizedMessage</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html#getMessage--\">getMessage</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html#getStackTrace--\">getStackTrace</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html#getSuppressed--\">getSuppressed</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html#initCause-java.lang.Throwable-\">initCause</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html#printStackTrace--\">printStackTrace</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html#printStackTrace-java.io.PrintStream-\">printStackTrace</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html#printStackTrace-java.io.PrintWriter-\">printStackTrace</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html#setStackTrace-java.lang.StackTraceElement:A-\">setStackTrace</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html#toString--\">toString</a>"
|
|
syntax: "public final class **IndexBatchException**</br> extends <xref href=\"com.azure.core.exception.AzureException?alt=com.azure.core.exception.AzureException&text=AzureException\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.models.IndexBatchException.IndexBatchException(com.azure.search.documents.models.IndexDocumentsResult)"
|
|
fullName: "com.azure.search.documents.models.IndexBatchException.IndexBatchException(IndexDocumentsResult result)"
|
|
name: "IndexBatchException(IndexDocumentsResult result)"
|
|
nameWithType: "IndexBatchException.IndexBatchException(IndexDocumentsResult result)"
|
|
summary: "Constructs an `IndexBatchException` from the given <xref uid=\"com.azure.search.documents.models.IndexDocumentsResult\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IndexDocumentsResult\"></xref>."
|
|
parameters:
|
|
- description: "The DocumentIndexResult returned from the service."
|
|
name: "result"
|
|
type: "<xref href=\"com.azure.search.documents.models.IndexDocumentsResult?alt=com.azure.search.documents.models.IndexDocumentsResult&text=IndexDocumentsResult\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public IndexBatchException(IndexDocumentsResult result)"
|
|
desc: "Constructs an `IndexBatchException` from the given <xref uid=\"com.azure.search.documents.models.IndexDocumentsResult\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IndexDocumentsResult\"></xref>."
|
|
methods:
|
|
- uid: "com.azure.search.documents.models.IndexBatchException.<T>findFailedActionsToRetry(com.azure.search.documents.models.IndexBatchBase<T>,java.util.function.Function<T,java.lang.String>)"
|
|
fullName: "com.azure.search.documents.models.IndexBatchException.findFailedActionsToRetry(IndexBatchBase<T> originBatch, Function<T,String> keySelector)"
|
|
name: "findFailedActionsToRetry(IndexBatchBase<T> originBatch, Function<T,String> keySelector)"
|
|
nameWithType: "IndexBatchException.findFailedActionsToRetry(IndexBatchBase<T> originBatch, Function<T,String> keySelector)"
|
|
summary: "Finds all index actions in the given batch that failed and need to be retried, and returns them in a new batch."
|
|
parameters:
|
|
- description: "The batch that partially failed indexing."
|
|
name: "originBatch"
|
|
type: "<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\" />>"
|
|
- description: "A lambda that retrieves a key value from a given document of type T."
|
|
name: "keySelector"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html\">Function</a><<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public IndexBatchBase<T> <T>findFailedActionsToRetry(IndexBatchBase<T> originBatch, Function<T,String> keySelector)"
|
|
desc: "Finds all index actions in the given batch that failed and need to be retried, and returns them in a new batch."
|
|
returns:
|
|
description: "A new batch containing all the actions from the given batch that failed and should be retried."
|
|
type: "<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\" />>"
|
|
- uid: "com.azure.search.documents.models.IndexBatchException.findFailedActionsToRetry(com.azure.search.documents.models.IndexBatchBase<com.azure.search.documents.SearchDocument>,java.lang.String)"
|
|
fullName: "com.azure.search.documents.models.IndexBatchException.findFailedActionsToRetry(IndexBatchBase<SearchDocument> originalBatch, String keyFieldName)"
|
|
name: "findFailedActionsToRetry(IndexBatchBase<SearchDocument> originalBatch, String keyFieldName)"
|
|
nameWithType: "IndexBatchException.findFailedActionsToRetry(IndexBatchBase<SearchDocument> originalBatch, String keyFieldName)"
|
|
summary: "Finds all index actions in the given batch that failed and need to be retried, and returns them in a new batch."
|
|
parameters:
|
|
- description: "The batch that partially failed indexing."
|
|
name: "originalBatch"
|
|
type: "<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=\"com.azure.search.documents.SearchDocument?alt=com.azure.search.documents.SearchDocument&text=SearchDocument\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "The name of the key field from the index schema."
|
|
name: "keyFieldName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public IndexBatchBase<SearchDocument> findFailedActionsToRetry(IndexBatchBase<SearchDocument> originalBatch, String keyFieldName)"
|
|
desc: "Finds all index actions in the given batch that failed and need to be retried, and returns them in a new batch."
|
|
returns:
|
|
description: "A new batch containing all the actions from the given batch that failed and should be retried."
|
|
type: "<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=\"com.azure.search.documents.SearchDocument?alt=com.azure.search.documents.SearchDocument&text=SearchDocument\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.documents.models.IndexBatchException.getIndexingResults()"
|
|
fullName: "com.azure.search.documents.models.IndexBatchException.getIndexingResults()"
|
|
name: "getIndexingResults()"
|
|
nameWithType: "IndexBatchException.getIndexingResults()"
|
|
summary: "Gets the indexing results returned by the service."
|
|
syntax: "public List<IndexingResult> getIndexingResults()"
|
|
desc: "Gets the indexing results returned by the service."
|
|
returns:
|
|
description: "The indexing results returned by the service."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.search.documents.models.IndexingResult?alt=com.azure.search.documents.models.IndexingResult&text=IndexingResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "class"
|
|
desc: "An `IndexBatchException` is thrown whenever Azure AI Search index call was only partially successful. Users can inspect the indexingResults to determine the operation(s) that have failed."
|
|
metadata: {}
|
|
package: "com.azure.search.documents.models"
|
|
artifact: com.azure:azure-search-documents:11.7.1
|