azure-docs-sdk-java/docs-ref-autogen/com.azure.ai.textanalytics.models.TextAnalyticsError.yml

### YamlMime:JavaType
uid: "com.azure.ai.textanalytics.models.TextAnalyticsError"
fullName: "com.azure.ai.textanalytics.models.TextAnalyticsError"
name: "TextAnalyticsError"
nameWithType: "TextAnalyticsError"
summary: "The `TextAnalyticsError` model."
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 **TextAnalyticsError**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.ai.textanalytics.models.TextAnalyticsError?alt=com.azure.ai.textanalytics.models.TextAnalyticsError&text=TextAnalyticsError\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.ai.textanalytics.models.TextAnalyticsError.TextAnalyticsError(com.azure.ai.textanalytics.models.TextAnalyticsErrorCode,java.lang.String,java.lang.String)"
  fullName: "com.azure.ai.textanalytics.models.TextAnalyticsError.TextAnalyticsError(TextAnalyticsErrorCode errorCode, String message, String target)"
  name: "TextAnalyticsError(TextAnalyticsErrorCode errorCode, String message, String target)"
  nameWithType: "TextAnalyticsError.TextAnalyticsError(TextAnalyticsErrorCode errorCode, String message, String target)"
  summary: "Creates a `TextAnalyticsError` model that describes text analytics error."
  parameters:
  - description: "The error code."
    name: "errorCode"
    type: "<xref href=\"com.azure.ai.textanalytics.models.TextAnalyticsErrorCode?alt=com.azure.ai.textanalytics.models.TextAnalyticsErrorCode&text=TextAnalyticsErrorCode\" data-throw-if-not-resolved=\"False\" />"
  - description: "The error message."
    name: "message"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The error target."
    name: "target"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public TextAnalyticsError(TextAnalyticsErrorCode errorCode, String message, String target)"
  desc: "Creates a `TextAnalyticsError` model that describes text analytics error."
methods:
- uid: "com.azure.ai.textanalytics.models.TextAnalyticsError.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.ai.textanalytics.models.TextAnalyticsError.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "TextAnalyticsError.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Text<wbr>Analytics<wbr>Error 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 TextAnalyticsError 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 TextAnalyticsError from the JsonReader."
  returns:
    description: "An instance of TextAnalyticsError if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
    type: "<xref href=\"com.azure.ai.textanalytics.models.TextAnalyticsError?alt=com.azure.ai.textanalytics.models.TextAnalyticsError&text=TextAnalyticsError\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.textanalytics.models.TextAnalyticsError.getErrorCode()"
  fullName: "com.azure.ai.textanalytics.models.TextAnalyticsError.getErrorCode()"
  name: "getErrorCode()"
  nameWithType: "TextAnalyticsError.getErrorCode()"
  summary: "Get the code property: Error code."
  syntax: "public TextAnalyticsErrorCode getErrorCode()"
  desc: "Get the code property: Error code. Possible values include: 'invalidRequest', 'invalidArgument', 'internalServerError', 'serviceUnavailable'."
  returns:
    description: "The code value."
    type: "<xref href=\"com.azure.ai.textanalytics.models.TextAnalyticsErrorCode?alt=com.azure.ai.textanalytics.models.TextAnalyticsErrorCode&text=TextAnalyticsErrorCode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.textanalytics.models.TextAnalyticsError.getMessage()"
  fullName: "com.azure.ai.textanalytics.models.TextAnalyticsError.getMessage()"
  name: "getMessage()"
  nameWithType: "TextAnalyticsError.getMessage()"
  summary: "Get the message property: Error message."
  syntax: "public String getMessage()"
  desc: "Get the message property: Error message."
  returns:
    description: "The message value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.textanalytics.models.TextAnalyticsError.getTarget()"
  fullName: "com.azure.ai.textanalytics.models.TextAnalyticsError.getTarget()"
  name: "getTarget()"
  nameWithType: "TextAnalyticsError.getTarget()"
  summary: "Get the target property: Error target."
  syntax: "public String getTarget()"
  desc: "Get the target property: Error target."
  returns:
    description: "The target value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.textanalytics.models.TextAnalyticsError.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.ai.textanalytics.models.TextAnalyticsError.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "TextAnalyticsError.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: "The `TextAnalyticsError` model."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.ai.textanalytics.models.TextAnalyticsError?alt=com.azure.ai.textanalytics.models.TextAnalyticsError&text=TextAnalyticsError\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.ai.textanalytics.models"
artifact: com.azure:azure-ai-textanalytics:5.5.1