software.amazon.awssdk.services.ecs.model.DescribeContainerInstancesRequest 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.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 software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeContainerInstancesRequest extends EcsRequest implements
ToCopyableBuilder {
private static final SdkField CLUSTER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("cluster")
.getter(getter(DescribeContainerInstancesRequest::cluster)).setter(setter(Builder::cluster))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("cluster").build()).build();
private static final SdkField> CONTAINER_INSTANCES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("containerInstances")
.getter(getter(DescribeContainerInstancesRequest::containerInstances))
.setter(setter(Builder::containerInstances))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("containerInstances").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> INCLUDE_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("include")
.getter(getter(DescribeContainerInstancesRequest::includeAsStrings))
.setter(setter(Builder::includeWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("include").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLUSTER_FIELD,
CONTAINER_INSTANCES_FIELD, INCLUDE_FIELD));
private final String cluster;
private final List containerInstances;
private final List include;
private DescribeContainerInstancesRequest(BuilderImpl builder) {
super(builder);
this.cluster = builder.cluster;
this.containerInstances = builder.containerInstances;
this.include = builder.include;
}
/**
*
* The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe.
* If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container
* instance or container instances you are describing were launched in any cluster other than the default cluster.
*
*
* @return The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to
* describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if
* the container instance or container instances you are describing were launched in any cluster other than
* the default cluster.
*/
public final String cluster() {
return cluster;
}
/**
* For responses, this returns true if the service returned a value for the ContainerInstances 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 hasContainerInstances() {
return containerInstances != null && !(containerInstances instanceof SdkAutoConstructList);
}
/**
*
* A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
*
*
* 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 #hasContainerInstances} method.
*
*
* @return A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
*/
public final List containerInstances() {
return containerInstances;
}
/**
*
* Specifies whether you want to see the resource tags for the container instance. If TAGS is
* specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the
* container instance health is included in the response. If this field is omitted, tags and container instance
* health status aren't included in the response.
*
*
* 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 #hasInclude} method.
*
*
* @return Specifies whether you want to see the resource tags for the container instance. If TAGS is
* specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified,
* the container instance health is included in the response. If this field is omitted, tags and container
* instance health status aren't included in the response.
*/
public final List include() {
return ContainerInstanceFieldListCopier.copyStringToEnum(include);
}
/**
* For responses, this returns true if the service returned a value for the Include 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 hasInclude() {
return include != null && !(include instanceof SdkAutoConstructList);
}
/**
*
* Specifies whether you want to see the resource tags for the container instance. If TAGS is
* specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the
* container instance health is included in the response. If this field is omitted, tags and container instance
* health status aren't included in the response.
*
*
* 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 #hasInclude} method.
*
*
* @return Specifies whether you want to see the resource tags for the container instance. If TAGS is
* specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified,
* the container instance health is included in the response. If this field is omitted, tags and container
* instance health status aren't included in the response.
*/
public final List includeAsStrings() {
return include;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(cluster());
hashCode = 31 * hashCode + Objects.hashCode(hasContainerInstances() ? containerInstances() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasInclude() ? includeAsStrings() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeContainerInstancesRequest)) {
return false;
}
DescribeContainerInstancesRequest other = (DescribeContainerInstancesRequest) obj;
return Objects.equals(cluster(), other.cluster()) && hasContainerInstances() == other.hasContainerInstances()
&& Objects.equals(containerInstances(), other.containerInstances()) && hasInclude() == other.hasInclude()
&& Objects.equals(includeAsStrings(), other.includeAsStrings());
}
/**
* 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("DescribeContainerInstancesRequest").add("Cluster", cluster())
.add("ContainerInstances", hasContainerInstances() ? containerInstances() : null)
.add("Include", hasInclude() ? includeAsStrings() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "cluster":
return Optional.ofNullable(clazz.cast(cluster()));
case "containerInstances":
return Optional.ofNullable(clazz.cast(containerInstances()));
case "include":
return Optional.ofNullable(clazz.cast(includeAsStrings()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeContainerInstancesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends EcsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to
* describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the
* container instance or container instances you are describing were launched in any cluster other than the
* default cluster.
*
*
* @param cluster
* The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to
* describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required
* if the container instance or container instances you are describing were launched in any cluster other
* than the default cluster.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder cluster(String cluster);
/**
*
* A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
*
*
* @param containerInstances
* A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder containerInstances(Collection containerInstances);
/**
*
* A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
*
*
* @param containerInstances
* A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder containerInstances(String... containerInstances);
/**
*
* Specifies whether you want to see the resource tags for the container instance. If TAGS is
* specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the
* container instance health is included in the response. If this field is omitted, tags and container instance
* health status aren't included in the response.
*
*
* @param include
* Specifies whether you want to see the resource tags for the container instance. If TAGS
* is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is
* specified, the container instance health is included in the response. If this field is omitted, tags
* and container instance health status aren't included in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder includeWithStrings(Collection include);
/**
*
* Specifies whether you want to see the resource tags for the container instance. If TAGS is
* specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the
* container instance health is included in the response. If this field is omitted, tags and container instance
* health status aren't included in the response.
*
*
* @param include
* Specifies whether you want to see the resource tags for the container instance. If TAGS
* is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is
* specified, the container instance health is included in the response. If this field is omitted, tags
* and container instance health status aren't included in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder includeWithStrings(String... include);
/**
*
* Specifies whether you want to see the resource tags for the container instance. If TAGS is
* specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the
* container instance health is included in the response. If this field is omitted, tags and container instance
* health status aren't included in the response.
*
*
* @param include
* Specifies whether you want to see the resource tags for the container instance. If TAGS
* is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is
* specified, the container instance health is included in the response. If this field is omitted, tags
* and container instance health status aren't included in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder include(Collection include);
/**
*
* Specifies whether you want to see the resource tags for the container instance. If TAGS is
* specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the
* container instance health is included in the response. If this field is omitted, tags and container instance
* health status aren't included in the response.
*
*
* @param include
* Specifies whether you want to see the resource tags for the container instance. If TAGS
* is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is
* specified, the container instance health is included in the response. If this field is omitted, tags
* and container instance health status aren't included in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder include(ContainerInstanceField... include);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends EcsRequest.BuilderImpl implements Builder {
private String cluster;
private List containerInstances = DefaultSdkAutoConstructList.getInstance();
private List include = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeContainerInstancesRequest model) {
super(model);
cluster(model.cluster);
containerInstances(model.containerInstances);
includeWithStrings(model.include);
}
public final String getCluster() {
return cluster;
}
public final void setCluster(String cluster) {
this.cluster = cluster;
}
@Override
public final Builder cluster(String cluster) {
this.cluster = cluster;
return this;
}
public final Collection getContainerInstances() {
if (containerInstances instanceof SdkAutoConstructList) {
return null;
}
return containerInstances;
}
public final void setContainerInstances(Collection containerInstances) {
this.containerInstances = StringListCopier.copy(containerInstances);
}
@Override
public final Builder containerInstances(Collection containerInstances) {
this.containerInstances = StringListCopier.copy(containerInstances);
return this;
}
@Override
@SafeVarargs
public final Builder containerInstances(String... containerInstances) {
containerInstances(Arrays.asList(containerInstances));
return this;
}
public final Collection getInclude() {
if (include instanceof SdkAutoConstructList) {
return null;
}
return include;
}
public final void setInclude(Collection include) {
this.include = ContainerInstanceFieldListCopier.copy(include);
}
@Override
public final Builder includeWithStrings(Collection include) {
this.include = ContainerInstanceFieldListCopier.copy(include);
return this;
}
@Override
@SafeVarargs
public final Builder includeWithStrings(String... include) {
includeWithStrings(Arrays.asList(include));
return this;
}
@Override
public final Builder include(Collection include) {
this.include = ContainerInstanceFieldListCopier.copyEnumToString(include);
return this;
}
@Override
@SafeVarargs
public final Builder include(ContainerInstanceField... include) {
include(Arrays.asList(include));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeContainerInstancesRequest build() {
return new DescribeContainerInstancesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}