software.amazon.awssdk.services.emr.model.ClusterStatus Maven / Gradle / Ivy
Show all versions of emr 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.emr.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
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 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;
/**
*
* The detailed status of the cluster.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ClusterStatus implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(ClusterStatus::stateAsString)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField STATE_CHANGE_REASON_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("StateChangeReason")
.getter(getter(ClusterStatus::stateChangeReason)).setter(setter(Builder::stateChangeReason))
.constructor(ClusterStateChangeReason::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StateChangeReason").build()).build();
private static final SdkField TIMELINE_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Timeline").getter(getter(ClusterStatus::timeline)).setter(setter(Builder::timeline))
.constructor(ClusterTimeline::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Timeline").build()).build();
private static final SdkField> ERROR_DETAILS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ErrorDetails")
.getter(getter(ClusterStatus::errorDetails))
.setter(setter(Builder::errorDetails))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ErrorDetails").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ErrorDetail::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STATE_FIELD,
STATE_CHANGE_REASON_FIELD, TIMELINE_FIELD, ERROR_DETAILS_FIELD));
private static final long serialVersionUID = 1L;
private final String state;
private final ClusterStateChangeReason stateChangeReason;
private final ClusterTimeline timeline;
private final List errorDetails;
private ClusterStatus(BuilderImpl builder) {
this.state = builder.state;
this.stateChangeReason = builder.stateChangeReason;
this.timeline = builder.timeline;
this.errorDetails = builder.errorDetails;
}
/**
*
* The current state of the cluster.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link ClusterState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The current state of the cluster.
* @see ClusterState
*/
public final ClusterState state() {
return ClusterState.fromValue(state);
}
/**
*
* The current state of the cluster.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link ClusterState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The current state of the cluster.
* @see ClusterState
*/
public final String stateAsString() {
return state;
}
/**
*
* The reason for the cluster status change.
*
*
* @return The reason for the cluster status change.
*/
public final ClusterStateChangeReason stateChangeReason() {
return stateChangeReason;
}
/**
*
* A timeline that represents the status of a cluster over the lifetime of the cluster.
*
*
* @return A timeline that represents the status of a cluster over the lifetime of the cluster.
*/
public final ClusterTimeline timeline() {
return timeline;
}
/**
* For responses, this returns true if the service returned a value for the ErrorDetails 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 hasErrorDetails() {
return errorDetails != null && !(errorDetails instanceof SdkAutoConstructList);
}
/**
*
* A list of tuples that provides information about the errors that caused a cluster to terminate. This structure
* can contain up to 10 different ErrorDetail tuples.
*
*
* 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 #hasErrorDetails} method.
*
*
* @return A list of tuples that provides information about the errors that caused a cluster to terminate. This
* structure can contain up to 10 different ErrorDetail tuples.
*/
public final List errorDetails() {
return errorDetails;
}
@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(stateChangeReason());
hashCode = 31 * hashCode + Objects.hashCode(timeline());
hashCode = 31 * hashCode + Objects.hashCode(hasErrorDetails() ? errorDetails() : 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 ClusterStatus)) {
return false;
}
ClusterStatus other = (ClusterStatus) obj;
return Objects.equals(stateAsString(), other.stateAsString())
&& Objects.equals(stateChangeReason(), other.stateChangeReason()) && Objects.equals(timeline(), other.timeline())
&& hasErrorDetails() == other.hasErrorDetails() && Objects.equals(errorDetails(), other.errorDetails());
}
/**
* 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("ClusterStatus").add("State", stateAsString()).add("StateChangeReason", stateChangeReason())
.add("Timeline", timeline()).add("ErrorDetails", hasErrorDetails() ? errorDetails() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "State":
return Optional.ofNullable(clazz.cast(stateAsString()));
case "StateChangeReason":
return Optional.ofNullable(clazz.cast(stateChangeReason()));
case "Timeline":
return Optional.ofNullable(clazz.cast(timeline()));
case "ErrorDetails":
return Optional.ofNullable(clazz.cast(errorDetails()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ClusterStatus) 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 cluster.
*
*
* @param state
* The current state of the cluster.
* @see ClusterState
* @return Returns a reference to this object so that method calls can be chained together.
* @see ClusterState
*/
Builder state(String state);
/**
*
* The current state of the cluster.
*
*
* @param state
* The current state of the cluster.
* @see ClusterState
* @return Returns a reference to this object so that method calls can be chained together.
* @see ClusterState
*/
Builder state(ClusterState state);
/**
*
* The reason for the cluster status change.
*
*
* @param stateChangeReason
* The reason for the cluster status change.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stateChangeReason(ClusterStateChangeReason stateChangeReason);
/**
*
* The reason for the cluster status change.
*
* This is a convenience method that creates an instance of the {@link ClusterStateChangeReason.Builder}
* avoiding the need to create one manually via {@link ClusterStateChangeReason#builder()}.
*
*
* When the {@link Consumer} completes, {@link ClusterStateChangeReason.Builder#build()} is called immediately
* and its result is passed to {@link #stateChangeReason(ClusterStateChangeReason)}.
*
* @param stateChangeReason
* a consumer that will call methods on {@link ClusterStateChangeReason.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #stateChangeReason(ClusterStateChangeReason)
*/
default Builder stateChangeReason(Consumer stateChangeReason) {
return stateChangeReason(ClusterStateChangeReason.builder().applyMutation(stateChangeReason).build());
}
/**
*
* A timeline that represents the status of a cluster over the lifetime of the cluster.
*
*
* @param timeline
* A timeline that represents the status of a cluster over the lifetime of the cluster.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder timeline(ClusterTimeline timeline);
/**
*
* A timeline that represents the status of a cluster over the lifetime of the cluster.
*
* This is a convenience method that creates an instance of the {@link ClusterTimeline.Builder} avoiding the
* need to create one manually via {@link ClusterTimeline#builder()}.
*
*
* When the {@link Consumer} completes, {@link ClusterTimeline.Builder#build()} is called immediately and its
* result is passed to {@link #timeline(ClusterTimeline)}.
*
* @param timeline
* a consumer that will call methods on {@link ClusterTimeline.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #timeline(ClusterTimeline)
*/
default Builder timeline(Consumer timeline) {
return timeline(ClusterTimeline.builder().applyMutation(timeline).build());
}
/**
*
* A list of tuples that provides information about the errors that caused a cluster to terminate. This
* structure can contain up to 10 different ErrorDetail tuples.
*
*
* @param errorDetails
* A list of tuples that provides information about the errors that caused a cluster to terminate. This
* structure can contain up to 10 different ErrorDetail tuples.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder errorDetails(Collection errorDetails);
/**
*
* A list of tuples that provides information about the errors that caused a cluster to terminate. This
* structure can contain up to 10 different ErrorDetail tuples.
*
*
* @param errorDetails
* A list of tuples that provides information about the errors that caused a cluster to terminate. This
* structure can contain up to 10 different ErrorDetail tuples.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder errorDetails(ErrorDetail... errorDetails);
/**
*
* A list of tuples that provides information about the errors that caused a cluster to terminate. This
* structure can contain up to 10 different ErrorDetail tuples.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.emr.model.ErrorDetail.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.emr.model.ErrorDetail#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.emr.model.ErrorDetail.Builder#build()} is called immediately and its
* result is passed to {@link #errorDetails(List)}.
*
* @param errorDetails
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.emr.model.ErrorDetail.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #errorDetails(java.util.Collection)
*/
Builder errorDetails(Consumer... errorDetails);
}
static final class BuilderImpl implements Builder {
private String state;
private ClusterStateChangeReason stateChangeReason;
private ClusterTimeline timeline;
private List errorDetails = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ClusterStatus model) {
state(model.state);
stateChangeReason(model.stateChangeReason);
timeline(model.timeline);
errorDetails(model.errorDetails);
}
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(ClusterState state) {
this.state(state == null ? null : state.toString());
return this;
}
public final ClusterStateChangeReason.Builder getStateChangeReason() {
return stateChangeReason != null ? stateChangeReason.toBuilder() : null;
}
public final void setStateChangeReason(ClusterStateChangeReason.BuilderImpl stateChangeReason) {
this.stateChangeReason = stateChangeReason != null ? stateChangeReason.build() : null;
}
@Override
public final Builder stateChangeReason(ClusterStateChangeReason stateChangeReason) {
this.stateChangeReason = stateChangeReason;
return this;
}
public final ClusterTimeline.Builder getTimeline() {
return timeline != null ? timeline.toBuilder() : null;
}
public final void setTimeline(ClusterTimeline.BuilderImpl timeline) {
this.timeline = timeline != null ? timeline.build() : null;
}
@Override
public final Builder timeline(ClusterTimeline timeline) {
this.timeline = timeline;
return this;
}
public final List getErrorDetails() {
List result = ErrorDetailListCopier.copyToBuilder(this.errorDetails);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setErrorDetails(Collection errorDetails) {
this.errorDetails = ErrorDetailListCopier.copyFromBuilder(errorDetails);
}
@Override
public final Builder errorDetails(Collection errorDetails) {
this.errorDetails = ErrorDetailListCopier.copy(errorDetails);
return this;
}
@Override
@SafeVarargs
public final Builder errorDetails(ErrorDetail... errorDetails) {
errorDetails(Arrays.asList(errorDetails));
return this;
}
@Override
@SafeVarargs
public final Builder errorDetails(Consumer... errorDetails) {
errorDetails(Stream.of(errorDetails).map(c -> ErrorDetail.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public ClusterStatus build() {
return new ClusterStatus(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}