Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License. See License.txt in the project root for license information.
/** * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for * license information. */
package com.microsoft.azure; import java.util.ArrayList; import java.util.List; import com.fasterxml.jackson.databind.annotation.JsonDeserialize; import com.microsoft.azure.serializer.TypedErrorInfoDeserializer;
An instance of this class provides additional information about an http error response.
/** * An instance of this class provides additional information about an http error response. */
public final class CloudError {
The error code parsed from the body of the http error response.
/** * The error code parsed from the body of the http error response. */
private String code;
The error message parsed from the body of the http error response.
/** * The error message parsed from the body of the http error response. */
private String message;
The target of the error.
/** * The target of the error. */
private String target;
Details for the error.
/** * Details for the error. */
private List<CloudError> details;
Additional error information.
/** * Additional error information. */
@JsonDeserialize(contentUsing = TypedErrorInfoDeserializer.class) private List<TypedErrorInfo> additionalInfo;
Initializes a new instance of CloudError.
/** * Initializes a new instance of CloudError. */
public CloudError() { this.details = new ArrayList<CloudError>(); }
Returns:the error code parsed from the body of the http error response
/** * @return the error code parsed from the body of the http error response */
public String code() { return code; }
Sets the error code parsed from the body of the http error response.
Params:
  • code – the error code
Returns:the CloudError object itself
/** * Sets the error code parsed from the body of the http error response. * * @param code the error code * @return the CloudError object itself */
public CloudError withCode(String code) { this.code = code; return this; }
Returns:the error message
/** * @return the error message */
public String message() { return message; }
Sets the error message parsed from the body of the http error response.
Params:
  • message – the error message
Returns:the CloudError object itself
/** * Sets the error message parsed from the body of the http error response. * * @param message the error message * @return the CloudError object itself */
public CloudError withMessage(String message) { this.message = message; return this; }
Returns:the target of the error
/** * @return the target of the error */
public String target() { return target; }
Sets the target of the error.
Params:
  • target – the target of the error
Returns:the CloudError object itself
/** * Sets the target of the error. * * @param target the target of the error * @return the CloudError object itself */
public CloudError withTarget(String target) { this.target = target; return this; }
Returns:the details for the error
/** * @return the details for the error */
public List<CloudError> details() { return details; }
Returns:the additional error information
/** * @return the additional error information */
public List<TypedErrorInfo> additionalInfo() { return additionalInfo; } }