software.amazon.awssdk.services.ecs.model.ContainerStateChange 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 that represents a change in state for a container.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ContainerStateChange implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField CONTAINER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("containerName").getter(getter(ContainerStateChange::containerName))
.setter(setter(Builder::containerName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("containerName").build()).build();
private static final SdkField IMAGE_DIGEST_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("imageDigest").getter(getter(ContainerStateChange::imageDigest)).setter(setter(Builder::imageDigest))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("imageDigest").build()).build();
private static final SdkField RUNTIME_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("runtimeId").getter(getter(ContainerStateChange::runtimeId)).setter(setter(Builder::runtimeId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("runtimeId").build()).build();
private static final SdkField EXIT_CODE_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("exitCode").getter(getter(ContainerStateChange::exitCode)).setter(setter(Builder::exitCode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("exitCode").build()).build();
private static final SdkField> NETWORK_BINDINGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("networkBindings")
.getter(getter(ContainerStateChange::networkBindings))
.setter(setter(Builder::networkBindings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("networkBindings").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(NetworkBinding::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField REASON_FIELD = SdkField. builder(MarshallingType.STRING).memberName("reason")
.getter(getter(ContainerStateChange::reason)).setter(setter(Builder::reason))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("reason").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("status")
.getter(getter(ContainerStateChange::status)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("status").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CONTAINER_NAME_FIELD,
IMAGE_DIGEST_FIELD, RUNTIME_ID_FIELD, EXIT_CODE_FIELD, NETWORK_BINDINGS_FIELD, REASON_FIELD, STATUS_FIELD));
private static final long serialVersionUID = 1L;
private final String containerName;
private final String imageDigest;
private final String runtimeId;
private final Integer exitCode;
private final List networkBindings;
private final String reason;
private final String status;
private ContainerStateChange(BuilderImpl builder) {
this.containerName = builder.containerName;
this.imageDigest = builder.imageDigest;
this.runtimeId = builder.runtimeId;
this.exitCode = builder.exitCode;
this.networkBindings = builder.networkBindings;
this.reason = builder.reason;
this.status = builder.status;
}
/**
*
* The name of the container.
*
*
* @return The name of the container.
*/
public final String containerName() {
return containerName;
}
/**
*
* The container image SHA 256 digest.
*
*
* @return The container image SHA 256 digest.
*/
public final String imageDigest() {
return imageDigest;
}
/**
*
* The ID of the Docker container.
*
*
* @return The ID of the Docker container.
*/
public final String runtimeId() {
return runtimeId;
}
/**
*
* The exit code for the container, if the state change is a result of the container exiting.
*
*
* @return The exit code for the container, if the state change is a result of the container exiting.
*/
public final Integer exitCode() {
return exitCode;
}
/**
* For responses, this returns true if the service returned a value for the NetworkBindings 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 hasNetworkBindings() {
return networkBindings != null && !(networkBindings instanceof SdkAutoConstructList);
}
/**
*
* Any network bindings that are associated with the container.
*
*
* 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 #hasNetworkBindings} method.
*
*
* @return Any network bindings that are associated with the container.
*/
public final List networkBindings() {
return networkBindings;
}
/**
*
* The reason for the state change.
*
*
* @return The reason for the state change.
*/
public final String reason() {
return reason;
}
/**
*
* The status of the container.
*
*
* @return The status of the container.
*/
public final String status() {
return status;
}
@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(containerName());
hashCode = 31 * hashCode + Objects.hashCode(imageDigest());
hashCode = 31 * hashCode + Objects.hashCode(runtimeId());
hashCode = 31 * hashCode + Objects.hashCode(exitCode());
hashCode = 31 * hashCode + Objects.hashCode(hasNetworkBindings() ? networkBindings() : null);
hashCode = 31 * hashCode + Objects.hashCode(reason());
hashCode = 31 * hashCode + Objects.hashCode(status());
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 ContainerStateChange)) {
return false;
}
ContainerStateChange other = (ContainerStateChange) obj;
return Objects.equals(containerName(), other.containerName()) && Objects.equals(imageDigest(), other.imageDigest())
&& Objects.equals(runtimeId(), other.runtimeId()) && Objects.equals(exitCode(), other.exitCode())
&& hasNetworkBindings() == other.hasNetworkBindings()
&& Objects.equals(networkBindings(), other.networkBindings()) && Objects.equals(reason(), other.reason())
&& Objects.equals(status(), other.status());
}
/**
* 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("ContainerStateChange").add("ContainerName", containerName()).add("ImageDigest", imageDigest())
.add("RuntimeId", runtimeId()).add("ExitCode", exitCode())
.add("NetworkBindings", hasNetworkBindings() ? networkBindings() : null).add("Reason", reason())
.add("Status", status()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "containerName":
return Optional.ofNullable(clazz.cast(containerName()));
case "imageDigest":
return Optional.ofNullable(clazz.cast(imageDigest()));
case "runtimeId":
return Optional.ofNullable(clazz.cast(runtimeId()));
case "exitCode":
return Optional.ofNullable(clazz.cast(exitCode()));
case "networkBindings":
return Optional.ofNullable(clazz.cast(networkBindings()));
case "reason":
return Optional.ofNullable(clazz.cast(reason()));
case "status":
return Optional.ofNullable(clazz.cast(status()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ContainerStateChange) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the container.
*
*
* @param containerName
* The name of the container.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder containerName(String containerName);
/**
*
* The container image SHA 256 digest.
*
*
* @param imageDigest
* The container image SHA 256 digest.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder imageDigest(String imageDigest);
/**
*
* The ID of the Docker container.
*
*
* @param runtimeId
* The ID of the Docker container.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder runtimeId(String runtimeId);
/**
*
* The exit code for the container, if the state change is a result of the container exiting.
*
*
* @param exitCode
* The exit code for the container, if the state change is a result of the container exiting.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder exitCode(Integer exitCode);
/**
*
* Any network bindings that are associated with the container.
*
*
* @param networkBindings
* Any network bindings that are associated with the container.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder networkBindings(Collection networkBindings);
/**
*
* Any network bindings that are associated with the container.
*
*
* @param networkBindings
* Any network bindings that are associated with the container.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder networkBindings(NetworkBinding... networkBindings);
/**
*
* Any network bindings that are associated with the container.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ecs.model.NetworkBinding.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.ecs.model.NetworkBinding#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.ecs.model.NetworkBinding.Builder#build()} is called immediately and
* its result is passed to {@link #networkBindings(List)}.
*
* @param networkBindings
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.ecs.model.NetworkBinding.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #networkBindings(java.util.Collection)
*/
Builder networkBindings(Consumer... networkBindings);
/**
*
* The reason for the state change.
*
*
* @param reason
* The reason for the state change.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reason(String reason);
/**
*
* The status of the container.
*
*
* @param status
* The status of the container.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder status(String status);
}
static final class BuilderImpl implements Builder {
private String containerName;
private String imageDigest;
private String runtimeId;
private Integer exitCode;
private List networkBindings = DefaultSdkAutoConstructList.getInstance();
private String reason;
private String status;
private BuilderImpl() {
}
private BuilderImpl(ContainerStateChange model) {
containerName(model.containerName);
imageDigest(model.imageDigest);
runtimeId(model.runtimeId);
exitCode(model.exitCode);
networkBindings(model.networkBindings);
reason(model.reason);
status(model.status);
}
public final String getContainerName() {
return containerName;
}
public final void setContainerName(String containerName) {
this.containerName = containerName;
}
@Override
public final Builder containerName(String containerName) {
this.containerName = containerName;
return this;
}
public final String getImageDigest() {
return imageDigest;
}
public final void setImageDigest(String imageDigest) {
this.imageDigest = imageDigest;
}
@Override
public final Builder imageDigest(String imageDigest) {
this.imageDigest = imageDigest;
return this;
}
public final String getRuntimeId() {
return runtimeId;
}
public final void setRuntimeId(String runtimeId) {
this.runtimeId = runtimeId;
}
@Override
public final Builder runtimeId(String runtimeId) {
this.runtimeId = runtimeId;
return this;
}
public final Integer getExitCode() {
return exitCode;
}
public final void setExitCode(Integer exitCode) {
this.exitCode = exitCode;
}
@Override
public final Builder exitCode(Integer exitCode) {
this.exitCode = exitCode;
return this;
}
public final List getNetworkBindings() {
List result = NetworkBindingsCopier.copyToBuilder(this.networkBindings);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setNetworkBindings(Collection networkBindings) {
this.networkBindings = NetworkBindingsCopier.copyFromBuilder(networkBindings);
}
@Override
public final Builder networkBindings(Collection networkBindings) {
this.networkBindings = NetworkBindingsCopier.copy(networkBindings);
return this;
}
@Override
@SafeVarargs
public final Builder networkBindings(NetworkBinding... networkBindings) {
networkBindings(Arrays.asList(networkBindings));
return this;
}
@Override
@SafeVarargs
public final Builder networkBindings(Consumer... networkBindings) {
networkBindings(Stream.of(networkBindings).map(c -> NetworkBinding.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getReason() {
return reason;
}
public final void setReason(String reason) {
this.reason = reason;
}
@Override
public final Builder reason(String reason) {
this.reason = reason;
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public ContainerStateChange build() {
return new ContainerStateChange(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}