software.amazon.awssdk.services.ecs.model.Attachment 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 a container instance or task attachment.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Attachment implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("id")
.getter(getter(Attachment::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("id").build()).build();
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("type")
.getter(getter(Attachment::type)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("type").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("status")
.getter(getter(Attachment::status)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("status").build()).build();
private static final SdkField> DETAILS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("details")
.getter(getter(Attachment::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(KeyValuePair::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, TYPE_FIELD,
STATUS_FIELD, DETAILS_FIELD));
private static final long serialVersionUID = 1L;
private final String id;
private final String type;
private final String status;
private final List details;
private Attachment(BuilderImpl builder) {
this.id = builder.id;
this.type = builder.type;
this.status = builder.status;
this.details = builder.details;
}
/**
*
* The unique identifier for the attachment.
*
*
* @return The unique identifier for the attachment.
*/
public final String id() {
return id;
}
/**
*
* The type of the attachment, such as ElasticNetworkInterface, Service Connect, and
* AmazonElasticBlockStorage.
*
*
* @return The type of the attachment, such as ElasticNetworkInterface, Service Connect,
* and AmazonElasticBlockStorage.
*/
public final String type() {
return type;
}
/**
*
* The status of the attachment. Valid values are PRECREATED, CREATED,
* ATTACHING, ATTACHED, DETACHING, DETACHED,
* DELETED, and FAILED.
*
*
* @return The status of the attachment. Valid values are PRECREATED, CREATED,
* ATTACHING, ATTACHED, DETACHING, DETACHED,
* DELETED, and FAILED.
*/
public final String status() {
return status;
}
/**
* 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);
}
/**
*
* Details of the attachment.
*
*
* For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the
* private IPv4 address.
*
*
* For Service Connect services, this includes portName, clientAliases,
* discoveryName, and ingressPortOverride.
*
*
* For Elastic Block Storage, this includes roleArn, deleteOnTermination,
* volumeName, volumeId, and statusReason (only when the attachment fails to
* create or attach).
*
*
* 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 Details of the attachment.
*
* For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID,
* and the private IPv4 address.
*
*
* For Service Connect services, this includes portName, clientAliases,
* discoveryName, and ingressPortOverride.
*
*
* For Elastic Block Storage, this includes roleArn, deleteOnTermination,
* volumeName, volumeId, and statusReason (only when the attachment
* fails to create or attach).
*/
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(id());
hashCode = 31 * hashCode + Objects.hashCode(type());
hashCode = 31 * hashCode + Objects.hashCode(status());
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 Attachment)) {
return false;
}
Attachment other = (Attachment) obj;
return Objects.equals(id(), other.id()) && Objects.equals(type(), other.type())
&& Objects.equals(status(), other.status()) && 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("Attachment").add("Id", id()).add("Type", type()).add("Status", status())
.add("Details", hasDetails() ? details() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "id":
return Optional.ofNullable(clazz.cast(id()));
case "type":
return Optional.ofNullable(clazz.cast(type()));
case "status":
return Optional.ofNullable(clazz.cast(status()));
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((Attachment) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The unique identifier for the attachment.
*
*
* @param id
* The unique identifier for the attachment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* The type of the attachment, such as ElasticNetworkInterface, Service Connect, and
* AmazonElasticBlockStorage.
*
*
* @param type
* The type of the attachment, such as ElasticNetworkInterface, Service Connect
* , and AmazonElasticBlockStorage.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder type(String type);
/**
*
* The status of the attachment. Valid values are PRECREATED, CREATED,
* ATTACHING, ATTACHED, DETACHING, DETACHED,
* DELETED, and FAILED.
*
*
* @param status
* The status of the attachment. Valid values are PRECREATED, CREATED,
* ATTACHING, ATTACHED, DETACHING, DETACHED,
* DELETED, and FAILED.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder status(String status);
/**
*
* Details of the attachment.
*
*
* For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and
* the private IPv4 address.
*
*
* For Service Connect services, this includes portName, clientAliases,
* discoveryName, and ingressPortOverride.
*
*
* For Elastic Block Storage, this includes roleArn, deleteOnTermination,
* volumeName, volumeId, and statusReason (only when the attachment fails
* to create or attach).
*
*
* @param details
* Details of the attachment.
*
* For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet
* ID, and the private IPv4 address.
*
*
* For Service Connect services, this includes portName, clientAliases,
* discoveryName, and ingressPortOverride.
*
*
* For Elastic Block Storage, this includes roleArn, deleteOnTermination,
* volumeName, volumeId, and statusReason (only when the
* attachment fails to create or attach).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder details(Collection details);
/**
*
* Details of the attachment.
*
*
* For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and
* the private IPv4 address.
*
*
* For Service Connect services, this includes portName, clientAliases,
* discoveryName, and ingressPortOverride.
*
*
* For Elastic Block Storage, this includes roleArn, deleteOnTermination,
* volumeName, volumeId, and statusReason (only when the attachment fails
* to create or attach).
*
*
* @param details
* Details of the attachment.
*
* For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet
* ID, and the private IPv4 address.
*
*
* For Service Connect services, this includes portName, clientAliases,
* discoveryName, and ingressPortOverride.
*
*
* For Elastic Block Storage, this includes roleArn, deleteOnTermination,
* volumeName, volumeId, and statusReason (only when the
* attachment fails to create or attach).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder details(KeyValuePair... details);
/**
*
* Details of the attachment.
*
*
* For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and
* the private IPv4 address.
*
*
* For Service Connect services, this includes portName, clientAliases,
* discoveryName, and ingressPortOverride.
*
*
* For Elastic Block Storage, this includes roleArn, deleteOnTermination,
* volumeName, volumeId, and statusReason (only when the attachment fails
* to create or attach).
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ecs.model.KeyValuePair.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.ecs.model.KeyValuePair#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.ecs.model.KeyValuePair.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.KeyValuePair.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 id;
private String type;
private String status;
private List details = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(Attachment model) {
id(model.id);
type(model.type);
status(model.status);
details(model.details);
}
public final String getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
public final Builder type(String type) {
this.type = type;
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;
}
public final List getDetails() {
List result = AttachmentDetailsCopier.copyToBuilder(this.details);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setDetails(Collection details) {
this.details = AttachmentDetailsCopier.copyFromBuilder(details);
}
@Override
public final Builder details(Collection details) {
this.details = AttachmentDetailsCopier.copy(details);
return this;
}
@Override
@SafeVarargs
public final Builder details(KeyValuePair... details) {
details(Arrays.asList(details));
return this;
}
@Override
@SafeVarargs
public final Builder details(Consumer... details) {
details(Stream.of(details).map(c -> KeyValuePair.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Attachment build() {
return new Attachment(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}