software.amazon.awssdk.services.iotsitewise.model.ErrorDetails Maven / Gradle / Ivy
Show all versions of iotsitewise Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.iotsitewise.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains the details of an IoT SiteWise error.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ErrorDetails implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField CODE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("code")
.getter(getter(ErrorDetails::codeAsString)).setter(setter(Builder::code))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("code").build()).build();
private static final SdkField MESSAGE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("message")
.getter(getter(ErrorDetails::message)).setter(setter(Builder::message))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("message").build()).build();
private static final SdkField> DETAILS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("details")
.getter(getter(ErrorDetails::details))
.setter(setter(Builder::details))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("details").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(DetailedError::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CODE_FIELD, MESSAGE_FIELD,
DETAILS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("code", CODE_FIELD);
put("message", MESSAGE_FIELD);
put("details", DETAILS_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final String code;
private final String message;
private final List details;
private ErrorDetails(BuilderImpl builder) {
this.code = builder.code;
this.message = builder.message;
this.details = builder.details;
}
/**
*
* The error code.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #code} will return
* {@link ErrorCode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #codeAsString}.
*
*
* @return The error code.
* @see ErrorCode
*/
public final ErrorCode code() {
return ErrorCode.fromValue(code);
}
/**
*
* The error code.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #code} will return
* {@link ErrorCode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #codeAsString}.
*
*
* @return The error code.
* @see ErrorCode
*/
public final String codeAsString() {
return code;
}
/**
*
* The error message.
*
*
* @return The error message.
*/
public final String message() {
return message;
}
/**
* For responses, this returns true if the service returned a value for the Details property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasDetails() {
return details != null && !(details instanceof SdkAutoConstructList);
}
/**
*
* A list of detailed errors.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasDetails} method.
*
*
* @return A list of detailed errors.
*/
public final List details() {
return details;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(codeAsString());
hashCode = 31 * hashCode + Objects.hashCode(message());
hashCode = 31 * hashCode + Objects.hashCode(hasDetails() ? details() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ErrorDetails)) {
return false;
}
ErrorDetails other = (ErrorDetails) obj;
return Objects.equals(codeAsString(), other.codeAsString()) && Objects.equals(message(), other.message())
&& hasDetails() == other.hasDetails() && Objects.equals(details(), other.details());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("ErrorDetails").add("Code", codeAsString()).add("Message", message())
.add("Details", hasDetails() ? details() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "code":
return Optional.ofNullable(clazz.cast(codeAsString()));
case "message":
return Optional.ofNullable(clazz.cast(message()));
case "details":
return Optional.ofNullable(clazz.cast(details()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((ErrorDetails) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The error code.
*
*
* @param code
* The error code.
* @see ErrorCode
* @return Returns a reference to this object so that method calls can be chained together.
* @see ErrorCode
*/
Builder code(String code);
/**
*
* The error code.
*
*
* @param code
* The error code.
* @see ErrorCode
* @return Returns a reference to this object so that method calls can be chained together.
* @see ErrorCode
*/
Builder code(ErrorCode code);
/**
*
* The error message.
*
*
* @param message
* The error message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder message(String message);
/**
*
* A list of detailed errors.
*
*
* @param details
* A list of detailed errors.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder details(Collection details);
/**
*
* A list of detailed errors.
*
*
* @param details
* A list of detailed errors.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder details(DetailedError... details);
/**
*
* A list of detailed errors.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.iotsitewise.model.DetailedError.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.iotsitewise.model.DetailedError#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.iotsitewise.model.DetailedError.Builder#build()} is called immediately
* and its result is passed to {@link #details(List)}.
*
* @param details
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.iotsitewise.model.DetailedError.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #details(java.util.Collection)
*/
Builder details(Consumer... details);
}
static final class BuilderImpl implements Builder {
private String code;
private String message;
private List details = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ErrorDetails model) {
code(model.code);
message(model.message);
details(model.details);
}
public final String getCode() {
return code;
}
public final void setCode(String code) {
this.code = code;
}
@Override
public final Builder code(String code) {
this.code = code;
return this;
}
@Override
public final Builder code(ErrorCode code) {
this.code(code == null ? null : code.toString());
return this;
}
public final String getMessage() {
return message;
}
public final void setMessage(String message) {
this.message = message;
}
@Override
public final Builder message(String message) {
this.message = message;
return this;
}
public final List getDetails() {
List result = DetailedErrorsCopier.copyToBuilder(this.details);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setDetails(Collection details) {
this.details = DetailedErrorsCopier.copyFromBuilder(details);
}
@Override
public final Builder details(Collection details) {
this.details = DetailedErrorsCopier.copy(details);
return this;
}
@Override
@SafeVarargs
public final Builder details(DetailedError... details) {
details(Arrays.asList(details));
return this;
}
@Override
@SafeVarargs
public final Builder details(Consumer... details) {
details(Stream.of(details).map(c -> DetailedError.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public ErrorDetails build() {
return new ErrorDetails(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}