software.amazon.awssdk.services.ecs.model.ContainerInstanceHealthStatus Maven / Gradle / Ivy
Show all versions of ecs 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.ecs.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;
/**
*
* An object representing the health status of the container instance.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ContainerInstanceHealthStatus implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField OVERALL_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("overallStatus").getter(getter(ContainerInstanceHealthStatus::overallStatusAsString))
.setter(setter(Builder::overallStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("overallStatus").build()).build();
private static final SdkField> DETAILS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("details")
.getter(getter(ContainerInstanceHealthStatus::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(InstanceHealthCheckResult::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(OVERALL_STATUS_FIELD,
DETAILS_FIELD));
private static final long serialVersionUID = 1L;
private final String overallStatus;
private final List details;
private ContainerInstanceHealthStatus(BuilderImpl builder) {
this.overallStatus = builder.overallStatus;
this.details = builder.details;
}
/**
*
* The overall health status of the container instance. This is an aggregate status of all container instance health
* checks.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #overallStatus}
* will return {@link InstanceHealthCheckState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #overallStatusAsString}.
*
*
* @return The overall health status of the container instance. This is an aggregate status of all container
* instance health checks.
* @see InstanceHealthCheckState
*/
public final InstanceHealthCheckState overallStatus() {
return InstanceHealthCheckState.fromValue(overallStatus);
}
/**
*
* The overall health status of the container instance. This is an aggregate status of all container instance health
* checks.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #overallStatus}
* will return {@link InstanceHealthCheckState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #overallStatusAsString}.
*
*
* @return The overall health status of the container instance. This is an aggregate status of all container
* instance health checks.
* @see InstanceHealthCheckState
*/
public final String overallStatusAsString() {
return overallStatus;
}
/**
* 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);
}
/**
*
* An array of objects representing the details of the container instance health status.
*
*
* 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 An array of objects representing the details of the container instance health status.
*/
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(overallStatusAsString());
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 ContainerInstanceHealthStatus)) {
return false;
}
ContainerInstanceHealthStatus other = (ContainerInstanceHealthStatus) obj;
return Objects.equals(overallStatusAsString(), other.overallStatusAsString()) && 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("ContainerInstanceHealthStatus").add("OverallStatus", overallStatusAsString())
.add("Details", hasDetails() ? details() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "overallStatus":
return Optional.ofNullable(clazz.cast(overallStatusAsString()));
case "details":
return Optional.ofNullable(clazz.cast(details()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ContainerInstanceHealthStatus) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The overall health status of the container instance. This is an aggregate status of all container instance
* health checks.
*
*
* @param overallStatus
* The overall health status of the container instance. This is an aggregate status of all container
* instance health checks.
* @see InstanceHealthCheckState
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceHealthCheckState
*/
Builder overallStatus(String overallStatus);
/**
*
* The overall health status of the container instance. This is an aggregate status of all container instance
* health checks.
*
*
* @param overallStatus
* The overall health status of the container instance. This is an aggregate status of all container
* instance health checks.
* @see InstanceHealthCheckState
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceHealthCheckState
*/
Builder overallStatus(InstanceHealthCheckState overallStatus);
/**
*
* An array of objects representing the details of the container instance health status.
*
*
* @param details
* An array of objects representing the details of the container instance health status.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder details(Collection details);
/**
*
* An array of objects representing the details of the container instance health status.
*
*
* @param details
* An array of objects representing the details of the container instance health status.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder details(InstanceHealthCheckResult... details);
/**
*
* An array of objects representing the details of the container instance health status.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ecs.model.InstanceHealthCheckResult.Builder} avoiding the need to
* create one manually via {@link software.amazon.awssdk.services.ecs.model.InstanceHealthCheckResult#builder()}
* .
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.ecs.model.InstanceHealthCheckResult.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.ecs.model.InstanceHealthCheckResult.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 overallStatus;
private List details = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ContainerInstanceHealthStatus model) {
overallStatus(model.overallStatus);
details(model.details);
}
public final String getOverallStatus() {
return overallStatus;
}
public final void setOverallStatus(String overallStatus) {
this.overallStatus = overallStatus;
}
@Override
public final Builder overallStatus(String overallStatus) {
this.overallStatus = overallStatus;
return this;
}
@Override
public final Builder overallStatus(InstanceHealthCheckState overallStatus) {
this.overallStatus(overallStatus == null ? null : overallStatus.toString());
return this;
}
public final List getDetails() {
List result = InstanceHealthCheckResultListCopier.copyToBuilder(this.details);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setDetails(Collection details) {
this.details = InstanceHealthCheckResultListCopier.copyFromBuilder(details);
}
@Override
public final Builder details(Collection details) {
this.details = InstanceHealthCheckResultListCopier.copy(details);
return this;
}
@Override
@SafeVarargs
public final Builder details(InstanceHealthCheckResult... details) {
details(Arrays.asList(details));
return this;
}
@Override
@SafeVarargs
public final Builder details(Consumer... details) {
details(Stream.of(details).map(c -> InstanceHealthCheckResult.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public ContainerInstanceHealthStatus build() {
return new ContainerInstanceHealthStatus(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}