187 строки
15 KiB
YAML
187 строки
15 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.indexes.models.IndexerExecutionResult"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexerExecutionResult"
|
|
name: "IndexerExecutionResult"
|
|
nameWithType: "IndexerExecutionResult"
|
|
summary: "Represents the result of an individual indexer 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 **IndexerExecutionResult**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.models.IndexerExecutionResult?alt=com.azure.search.documents.indexes.models.IndexerExecutionResult&text=IndexerExecutionResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.indexes.models.IndexerExecutionResult.IndexerExecutionResult(com.azure.search.documents.indexes.models.IndexerExecutionStatus,java.util.List<com.azure.search.documents.indexes.models.SearchIndexerError>,java.util.List<com.azure.search.documents.indexes.models.SearchIndexerWarning>,int,int)"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexerExecutionResult.IndexerExecutionResult(IndexerExecutionStatus status, List<SearchIndexerError> errors, List<SearchIndexerWarning> warnings, int itemCount, int failedItemCount)"
|
|
name: "IndexerExecutionResult(IndexerExecutionStatus status, List<SearchIndexerError> errors, List<SearchIndexerWarning> warnings, int itemCount, int failedItemCount)"
|
|
nameWithType: "IndexerExecutionResult.IndexerExecutionResult(IndexerExecutionStatus status, List<SearchIndexerError> errors, List<SearchIndexerWarning> warnings, int itemCount, int failedItemCount)"
|
|
summary: "Creates an instance of Indexer<wbr>Execution<wbr>Result class."
|
|
parameters:
|
|
- description: "the status value to set."
|
|
name: "status"
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.IndexerExecutionStatus?alt=com.azure.search.documents.indexes.models.IndexerExecutionStatus&text=IndexerExecutionStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the errors value to set."
|
|
name: "errors"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerError?alt=com.azure.search.documents.indexes.models.SearchIndexerError&text=SearchIndexerError\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "the warnings value to set."
|
|
name: "warnings"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerWarning?alt=com.azure.search.documents.indexes.models.SearchIndexerWarning&text=SearchIndexerWarning\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "the itemCount value to set."
|
|
name: "itemCount"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the failedItemCount value to set."
|
|
name: "failedItemCount"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public IndexerExecutionResult(IndexerExecutionStatus status, List<SearchIndexerError> errors, List<SearchIndexerWarning> warnings, int itemCount, int failedItemCount)"
|
|
desc: "Creates an instance of IndexerExecutionResult class."
|
|
methods:
|
|
- uid: "com.azure.search.documents.indexes.models.IndexerExecutionResult.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexerExecutionResult.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "IndexerExecutionResult.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Indexer<wbr>Execution<wbr>Result from the Json<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The JsonReader being read."
|
|
name: "jsonReader"
|
|
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static IndexerExecutionResult fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If the deserialized JSON object was missing any required properties."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of IndexerExecutionResult from the JsonReader."
|
|
returns:
|
|
description: "An instance of IndexerExecutionResult if the JsonReader was pointing to an instance of it, or null if it\n was pointing to JSON null."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.IndexerExecutionResult?alt=com.azure.search.documents.indexes.models.IndexerExecutionResult&text=IndexerExecutionResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getEndTime()"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getEndTime()"
|
|
name: "getEndTime()"
|
|
nameWithType: "IndexerExecutionResult.getEndTime()"
|
|
summary: "Get the end<wbr>Time property: The end time of this indexer execution, if the execution has already completed."
|
|
syntax: "public OffsetDateTime getEndTime()"
|
|
desc: "Get the endTime property: The end time of this indexer execution, if the execution has already completed."
|
|
returns:
|
|
description: "the endTime value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getErrorMessage()"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getErrorMessage()"
|
|
name: "getErrorMessage()"
|
|
nameWithType: "IndexerExecutionResult.getErrorMessage()"
|
|
summary: "Get the error<wbr>Message property: The error message indicating the top-level error, if any."
|
|
syntax: "public String getErrorMessage()"
|
|
desc: "Get the errorMessage property: The error message indicating the top-level error, if any."
|
|
returns:
|
|
description: "the errorMessage value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getErrors()"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getErrors()"
|
|
name: "getErrors()"
|
|
nameWithType: "IndexerExecutionResult.getErrors()"
|
|
summary: "Get the errors property: The item-level indexing errors."
|
|
syntax: "public List<SearchIndexerError> getErrors()"
|
|
desc: "Get the errors property: The item-level indexing errors."
|
|
returns:
|
|
description: "the errors value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerError?alt=com.azure.search.documents.indexes.models.SearchIndexerError&text=SearchIndexerError\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getFailedItemCount()"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getFailedItemCount()"
|
|
name: "getFailedItemCount()"
|
|
nameWithType: "IndexerExecutionResult.getFailedItemCount()"
|
|
summary: "Get the failed<wbr>Item<wbr>Count property: The number of items that failed to be indexed during this indexer execution."
|
|
syntax: "public int getFailedItemCount()"
|
|
desc: "Get the failedItemCount property: The number of items that failed to be indexed during this indexer execution."
|
|
returns:
|
|
description: "the failedItemCount value."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getFinalTrackingState()"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getFinalTrackingState()"
|
|
name: "getFinalTrackingState()"
|
|
nameWithType: "IndexerExecutionResult.getFinalTrackingState()"
|
|
summary: "Get the final<wbr>Tracking<wbr>State property: Change tracking state with which an indexer execution finished."
|
|
syntax: "public String getFinalTrackingState()"
|
|
desc: "Get the finalTrackingState property: Change tracking state with which an indexer execution finished."
|
|
returns:
|
|
description: "the finalTrackingState value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getInitialTrackingState()"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getInitialTrackingState()"
|
|
name: "getInitialTrackingState()"
|
|
nameWithType: "IndexerExecutionResult.getInitialTrackingState()"
|
|
summary: "Get the initial<wbr>Tracking<wbr>State property: Change tracking state with which an indexer execution started."
|
|
syntax: "public String getInitialTrackingState()"
|
|
desc: "Get the initialTrackingState property: Change tracking state with which an indexer execution started."
|
|
returns:
|
|
description: "the initialTrackingState value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getItemCount()"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getItemCount()"
|
|
name: "getItemCount()"
|
|
nameWithType: "IndexerExecutionResult.getItemCount()"
|
|
summary: "Get the item<wbr>Count property: The number of items that were processed during this indexer execution."
|
|
syntax: "public int getItemCount()"
|
|
desc: "Get the itemCount property: The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed."
|
|
returns:
|
|
description: "the itemCount value."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getStartTime()"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getStartTime()"
|
|
name: "getStartTime()"
|
|
nameWithType: "IndexerExecutionResult.getStartTime()"
|
|
summary: "Get the start<wbr>Time property: The start time of this indexer execution."
|
|
syntax: "public OffsetDateTime getStartTime()"
|
|
desc: "Get the startTime property: The start time of this indexer execution."
|
|
returns:
|
|
description: "the startTime value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getStatus()"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getStatus()"
|
|
name: "getStatus()"
|
|
nameWithType: "IndexerExecutionResult.getStatus()"
|
|
summary: "Get the status property: The outcome of this indexer execution."
|
|
syntax: "public IndexerExecutionStatus getStatus()"
|
|
desc: "Get the status property: The outcome of this indexer execution."
|
|
returns:
|
|
description: "the status value."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.IndexerExecutionStatus?alt=com.azure.search.documents.indexes.models.IndexerExecutionStatus&text=IndexerExecutionStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getWarnings()"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexerExecutionResult.getWarnings()"
|
|
name: "getWarnings()"
|
|
nameWithType: "IndexerExecutionResult.getWarnings()"
|
|
summary: "Get the warnings property: The item-level indexing warnings."
|
|
syntax: "public List<SearchIndexerWarning> getWarnings()"
|
|
desc: "Get the warnings property: The item-level indexing warnings."
|
|
returns:
|
|
description: "the warnings value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerWarning?alt=com.azure.search.documents.indexes.models.SearchIndexerWarning&text=SearchIndexerWarning\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.documents.indexes.models.IndexerExecutionResult.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.search.documents.indexes.models.IndexerExecutionResult.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "IndexerExecutionResult.toJson(JsonWriter jsonWriter)"
|
|
parameters:
|
|
- name: "jsonWriter"
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Represents the result of an individual indexer execution."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.models.IndexerExecutionResult?alt=com.azure.search.documents.indexes.models.IndexerExecutionResult&text=IndexerExecutionResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.search.documents.indexes.models"
|
|
artifact: com.azure:azure-search-documents:11.7.3
|