software.amazon.awssdk.services.iottwinmaker.model.Status Maven / Gradle / Ivy
Show all versions of iottwinmaker 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.iottwinmaker.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* An object that represents the status of an entity, component, component type, or workspace.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Status implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("state")
.getter(getter(Status::stateAsString)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("state").build()).build();
private static final SdkField ERROR_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("error").getter(getter(Status::error)).setter(setter(Builder::error)).constructor(ErrorDetails::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("error").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STATE_FIELD, ERROR_FIELD));
private static final long serialVersionUID = 1L;
private final String state;
private final ErrorDetails error;
private Status(BuilderImpl builder) {
this.state = builder.state;
this.error = builder.error;
}
/**
*
* The current state of the entity, component, component type, or workspace.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link State#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The current state of the entity, component, component type, or workspace.
* @see State
*/
public final State state() {
return State.fromValue(state);
}
/**
*
* The current state of the entity, component, component type, or workspace.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link State#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The current state of the entity, component, component type, or workspace.
* @see State
*/
public final String stateAsString() {
return state;
}
/**
*
* The error message.
*
*
* @return The error message.
*/
public final ErrorDetails error() {
return error;
}
@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(stateAsString());
hashCode = 31 * hashCode + Objects.hashCode(error());
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 Status)) {
return false;
}
Status other = (Status) obj;
return Objects.equals(stateAsString(), other.stateAsString()) && Objects.equals(error(), other.error());
}
/**
* 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("Status").add("State", stateAsString()).add("Error", error()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "state":
return Optional.ofNullable(clazz.cast(stateAsString()));
case "error":
return Optional.ofNullable(clazz.cast(error()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Status) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The current state of the entity, component, component type, or workspace.
*
*
* @param state
* The current state of the entity, component, component type, or workspace.
* @see State
* @return Returns a reference to this object so that method calls can be chained together.
* @see State
*/
Builder state(String state);
/**
*
* The current state of the entity, component, component type, or workspace.
*
*
* @param state
* The current state of the entity, component, component type, or workspace.
* @see State
* @return Returns a reference to this object so that method calls can be chained together.
* @see State
*/
Builder state(State state);
/**
*
* The error message.
*
*
* @param error
* The error message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder error(ErrorDetails error);
/**
*
* The error message.
*
* This is a convenience method that creates an instance of the {@link ErrorDetails.Builder} avoiding the need
* to create one manually via {@link ErrorDetails#builder()}.
*
*
* When the {@link Consumer} completes, {@link ErrorDetails.Builder#build()} is called immediately and its
* result is passed to {@link #error(ErrorDetails)}.
*
* @param error
* a consumer that will call methods on {@link ErrorDetails.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #error(ErrorDetails)
*/
default Builder error(Consumer error) {
return error(ErrorDetails.builder().applyMutation(error).build());
}
}
static final class BuilderImpl implements Builder {
private String state;
private ErrorDetails error;
private BuilderImpl() {
}
private BuilderImpl(Status model) {
state(model.state);
error(model.error);
}
public final String getState() {
return state;
}
public final void setState(String state) {
this.state = state;
}
@Override
public final Builder state(String state) {
this.state = state;
return this;
}
@Override
public final Builder state(State state) {
this.state(state == null ? null : state.toString());
return this;
}
public final ErrorDetails.Builder getError() {
return error != null ? error.toBuilder() : null;
}
public final void setError(ErrorDetails.BuilderImpl error) {
this.error = error != null ? error.build() : null;
}
@Override
public final Builder error(ErrorDetails error) {
this.error = error;
return this;
}
@Override
public Status build() {
return new Status(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}