294 строки
21 KiB
YAML
294 строки
21 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError"
|
|
name: "UserFacingError"
|
|
nameWithType: "UserFacingError"
|
|
summary: "Error object used by layers that have access to localized content, and propagate that to user."
|
|
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 **UserFacingError**</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.resourcemanager.dataprotection.models.UserFacingError?alt=com.azure.resourcemanager.dataprotection.models.UserFacingError&text=UserFacingError\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.UserFacingError()"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.UserFacingError()"
|
|
name: "UserFacingError()"
|
|
nameWithType: "UserFacingError.UserFacingError()"
|
|
summary: "Creates an instance of User<wbr>Facing<wbr>Error class."
|
|
syntax: "public UserFacingError()"
|
|
desc: "Creates an instance of UserFacingError class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.code()"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.code()"
|
|
name: "code()"
|
|
nameWithType: "UserFacingError.code()"
|
|
summary: "Get the code property: Unique code for this error."
|
|
syntax: "public String code()"
|
|
desc: "Get the code property: Unique code for this error."
|
|
returns:
|
|
description: "the code value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.details()"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.details()"
|
|
name: "details()"
|
|
nameWithType: "UserFacingError.details()"
|
|
summary: "Get the details property: Additional related Errors."
|
|
syntax: "public List<UserFacingError> details()"
|
|
desc: "Get the details property: Additional related Errors."
|
|
returns:
|
|
description: "the details value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.dataprotection.models.UserFacingError?alt=com.azure.resourcemanager.dataprotection.models.UserFacingError&text=UserFacingError\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "UserFacingError.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of User<wbr>Facing<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 UserFacingError fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while reading the UserFacingError."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of UserFacingError from the JsonReader."
|
|
returns:
|
|
description: "An instance of UserFacingError 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.resourcemanager.dataprotection.models.UserFacingError?alt=com.azure.resourcemanager.dataprotection.models.UserFacingError&text=UserFacingError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.innerError()"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.innerError()"
|
|
name: "innerError()"
|
|
nameWithType: "UserFacingError.innerError()"
|
|
summary: "Get the inner<wbr>Error property: Inner Error."
|
|
syntax: "public InnerError innerError()"
|
|
desc: "Get the innerError property: Inner Error."
|
|
returns:
|
|
description: "the innerError value."
|
|
type: "<xref href=\"com.azure.resourcemanager.dataprotection.models.InnerError?alt=com.azure.resourcemanager.dataprotection.models.InnerError&text=InnerError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.isRetryable()"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.isRetryable()"
|
|
name: "isRetryable()"
|
|
nameWithType: "UserFacingError.isRetryable()"
|
|
summary: "Get the is<wbr>Retryable property: Whether the operation will be retryable or not."
|
|
syntax: "public Boolean isRetryable()"
|
|
desc: "Get the isRetryable property: Whether the operation will be retryable or not."
|
|
returns:
|
|
description: "the isRetryable value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.isUserError()"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.isUserError()"
|
|
name: "isUserError()"
|
|
nameWithType: "UserFacingError.isUserError()"
|
|
summary: "Get the is<wbr>User<wbr>Error property: Whether the operation is due to a user error or service error."
|
|
syntax: "public Boolean isUserError()"
|
|
desc: "Get the isUserError property: Whether the operation is due to a user error or service error."
|
|
returns:
|
|
description: "the isUserError value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.message()"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.message()"
|
|
name: "message()"
|
|
nameWithType: "UserFacingError.message()"
|
|
summary: "Get the message property: The message property."
|
|
syntax: "public String message()"
|
|
desc: "Get the message property: The message property."
|
|
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.resourcemanager.dataprotection.models.UserFacingError.properties()"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.properties()"
|
|
name: "properties()"
|
|
nameWithType: "UserFacingError.properties()"
|
|
summary: "Get the properties property: Any key value pairs that can be injected inside error object."
|
|
syntax: "public Map<String,String> properties()"
|
|
desc: "Get the properties property: Any key value pairs that can be injected inside error object."
|
|
returns:
|
|
description: "the properties value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.recommendedAction()"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.recommendedAction()"
|
|
name: "recommendedAction()"
|
|
nameWithType: "UserFacingError.recommendedAction()"
|
|
summary: "Get the recommended<wbr>Action property: Recommended<wbr>Action \\\\ufffd localized."
|
|
syntax: "public List<String> recommendedAction()"
|
|
desc: "Get the recommendedAction property: RecommendedAction \\\\ufffd localized."
|
|
returns:
|
|
description: "the recommendedAction value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.target()"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.target()"
|
|
name: "target()"
|
|
nameWithType: "UserFacingError.target()"
|
|
summary: "Get the target property: Target of the error."
|
|
syntax: "public String target()"
|
|
desc: "Get the target property: Target of the error."
|
|
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.resourcemanager.dataprotection.models.UserFacingError.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "UserFacingError.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\" />"
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.validate()"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.validate()"
|
|
name: "validate()"
|
|
nameWithType: "UserFacingError.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withCode(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withCode(String code)"
|
|
name: "withCode(String code)"
|
|
nameWithType: "UserFacingError.withCode(String code)"
|
|
summary: "Set the code property: Unique code for this error."
|
|
parameters:
|
|
- description: "the code value to set."
|
|
name: "code"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public UserFacingError withCode(String code)"
|
|
desc: "Set the code property: Unique code for this error."
|
|
returns:
|
|
description: "the UserFacingError object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.dataprotection.models.UserFacingError?alt=com.azure.resourcemanager.dataprotection.models.UserFacingError&text=UserFacingError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withDetails(java.util.List<com.azure.resourcemanager.dataprotection.models.UserFacingError>)"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withDetails(List<UserFacingError> details)"
|
|
name: "withDetails(List<UserFacingError> details)"
|
|
nameWithType: "UserFacingError.withDetails(List<UserFacingError> details)"
|
|
summary: "Set the details property: Additional related Errors."
|
|
parameters:
|
|
- description: "the details value to set."
|
|
name: "details"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.dataprotection.models.UserFacingError?alt=com.azure.resourcemanager.dataprotection.models.UserFacingError&text=UserFacingError\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public UserFacingError withDetails(List<UserFacingError> details)"
|
|
desc: "Set the details property: Additional related Errors."
|
|
returns:
|
|
description: "the UserFacingError object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.dataprotection.models.UserFacingError?alt=com.azure.resourcemanager.dataprotection.models.UserFacingError&text=UserFacingError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withInnerError(com.azure.resourcemanager.dataprotection.models.InnerError)"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withInnerError(InnerError innerError)"
|
|
name: "withInnerError(InnerError innerError)"
|
|
nameWithType: "UserFacingError.withInnerError(InnerError innerError)"
|
|
summary: "Set the inner<wbr>Error property: Inner Error."
|
|
parameters:
|
|
- description: "the innerError value to set."
|
|
name: "innerError"
|
|
type: "<xref href=\"com.azure.resourcemanager.dataprotection.models.InnerError?alt=com.azure.resourcemanager.dataprotection.models.InnerError&text=InnerError\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public UserFacingError withInnerError(InnerError innerError)"
|
|
desc: "Set the innerError property: Inner Error."
|
|
returns:
|
|
description: "the UserFacingError object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.dataprotection.models.UserFacingError?alt=com.azure.resourcemanager.dataprotection.models.UserFacingError&text=UserFacingError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withIsRetryable(java.lang.Boolean)"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withIsRetryable(Boolean isRetryable)"
|
|
name: "withIsRetryable(Boolean isRetryable)"
|
|
nameWithType: "UserFacingError.withIsRetryable(Boolean isRetryable)"
|
|
summary: "Set the is<wbr>Retryable property: Whether the operation will be retryable or not."
|
|
parameters:
|
|
- description: "the isRetryable value to set."
|
|
name: "isRetryable"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public UserFacingError withIsRetryable(Boolean isRetryable)"
|
|
desc: "Set the isRetryable property: Whether the operation will be retryable or not."
|
|
returns:
|
|
description: "the UserFacingError object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.dataprotection.models.UserFacingError?alt=com.azure.resourcemanager.dataprotection.models.UserFacingError&text=UserFacingError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withIsUserError(java.lang.Boolean)"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withIsUserError(Boolean isUserError)"
|
|
name: "withIsUserError(Boolean isUserError)"
|
|
nameWithType: "UserFacingError.withIsUserError(Boolean isUserError)"
|
|
summary: "Set the is<wbr>User<wbr>Error property: Whether the operation is due to a user error or service error."
|
|
parameters:
|
|
- description: "the isUserError value to set."
|
|
name: "isUserError"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public UserFacingError withIsUserError(Boolean isUserError)"
|
|
desc: "Set the isUserError property: Whether the operation is due to a user error or service error."
|
|
returns:
|
|
description: "the UserFacingError object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.dataprotection.models.UserFacingError?alt=com.azure.resourcemanager.dataprotection.models.UserFacingError&text=UserFacingError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withMessage(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withMessage(String message)"
|
|
name: "withMessage(String message)"
|
|
nameWithType: "UserFacingError.withMessage(String message)"
|
|
summary: "Set the message property: The message property."
|
|
parameters:
|
|
- description: "the message value to set."
|
|
name: "message"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public UserFacingError withMessage(String message)"
|
|
desc: "Set the message property: The message property."
|
|
returns:
|
|
description: "the UserFacingError object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.dataprotection.models.UserFacingError?alt=com.azure.resourcemanager.dataprotection.models.UserFacingError&text=UserFacingError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withProperties(java.util.Map<java.lang.String,java.lang.String>)"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withProperties(Map<String,String> properties)"
|
|
name: "withProperties(Map<String,String> properties)"
|
|
nameWithType: "UserFacingError.withProperties(Map<String,String> properties)"
|
|
summary: "Set the properties property: Any key value pairs that can be injected inside error object."
|
|
parameters:
|
|
- description: "the properties value to set."
|
|
name: "properties"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public UserFacingError withProperties(Map<String,String> properties)"
|
|
desc: "Set the properties property: Any key value pairs that can be injected inside error object."
|
|
returns:
|
|
description: "the UserFacingError object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.dataprotection.models.UserFacingError?alt=com.azure.resourcemanager.dataprotection.models.UserFacingError&text=UserFacingError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withRecommendedAction(java.util.List<java.lang.String>)"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withRecommendedAction(List<String> recommendedAction)"
|
|
name: "withRecommendedAction(List<String> recommendedAction)"
|
|
nameWithType: "UserFacingError.withRecommendedAction(List<String> recommendedAction)"
|
|
summary: "Set the recommended<wbr>Action property: Recommended<wbr>Action \\\\ufffd localized."
|
|
parameters:
|
|
- description: "the recommendedAction value to set."
|
|
name: "recommendedAction"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public UserFacingError withRecommendedAction(List<String> recommendedAction)"
|
|
desc: "Set the recommendedAction property: RecommendedAction \\\\ufffd localized."
|
|
returns:
|
|
description: "the UserFacingError object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.dataprotection.models.UserFacingError?alt=com.azure.resourcemanager.dataprotection.models.UserFacingError&text=UserFacingError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withTarget(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.dataprotection.models.UserFacingError.withTarget(String target)"
|
|
name: "withTarget(String target)"
|
|
nameWithType: "UserFacingError.withTarget(String target)"
|
|
summary: "Set the target property: Target of the error."
|
|
parameters:
|
|
- description: "the target value to set."
|
|
name: "target"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public UserFacingError withTarget(String target)"
|
|
desc: "Set the target property: Target of the error."
|
|
returns:
|
|
description: "the UserFacingError object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.dataprotection.models.UserFacingError?alt=com.azure.resourcemanager.dataprotection.models.UserFacingError&text=UserFacingError\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Error object used by layers that have access to localized content, and propagate that to user."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.dataprotection.models.UserFacingError?alt=com.azure.resourcemanager.dataprotection.models.UserFacingError&text=UserFacingError\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.dataprotection.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-dataprotection:1.3.0
|