software.amazon.awssdk.services.ecs.model.DescribeTasksRequest Maven / Gradle / Ivy
/*
* Copyright 2014-2019 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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeTasksRequest extends EcsRequest implements
ToCopyableBuilder {
private static final SdkField CLUSTER_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(DescribeTasksRequest::cluster)).setter(setter(Builder::cluster))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("cluster").build()).build();
private static final SdkField> TASKS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(DescribeTasksRequest::tasks))
.setter(setter(Builder::tasks))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tasks").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)
.getter(getter(DescribeTasksRequest::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, TASKS_FIELD,
INCLUDE_FIELD));
private final String cluster;
private final List tasks;
private final List include;
private DescribeTasksRequest(BuilderImpl builder) {
super(builder);
this.cluster = builder.cluster;
this.tasks = builder.tasks;
this.include = builder.include;
}
/**
*
* The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you
* do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks 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 task or tasks to
* describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if
* the task or tasks you are describing were launched in any cluster other than the default cluster.
*/
public String cluster() {
return cluster;
}
/**
*
* A list of up to 100 task IDs or full ARN entries.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return A list of up to 100 task IDs or full ARN entries.
*/
public List tasks() {
return tasks;
}
/**
*
* Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are
* included in the response. If this field is omitted, tags are not included in the response.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return Specifies whether you want to see the resource tags for the task. If TAGS is specified, the
* tags are included in the response. If this field is omitted, tags are not included in the response.
*/
public List include() {
return TaskFieldListCopier.copyStringToEnum(include);
}
/**
*
* Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are
* included in the response. If this field is omitted, tags are not included in the response.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* @return Specifies whether you want to see the resource tags for the task. If TAGS is specified, the
* tags are included in the response. If this field is omitted, tags are not included in the response.
*/
public 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 int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(cluster());
hashCode = 31 * hashCode + Objects.hashCode(tasks());
hashCode = 31 * hashCode + Objects.hashCode(includeAsStrings());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeTasksRequest)) {
return false;
}
DescribeTasksRequest other = (DescribeTasksRequest) obj;
return Objects.equals(cluster(), other.cluster()) && Objects.equals(tasks(), other.tasks())
&& 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 String toString() {
return ToString.builder("DescribeTasksRequest").add("Cluster", cluster()).add("Tasks", tasks())
.add("Include", includeAsStrings()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "cluster":
return Optional.ofNullable(clazz.cast(cluster()));
case "tasks":
return Optional.ofNullable(clazz.cast(tasks()));
case "include":
return Optional.ofNullable(clazz.cast(includeAsStrings()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeTasksRequest) 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 task or tasks to describe. If
* you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks
* 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 task or tasks to
* describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required
* if the task or tasks 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 task IDs or full ARN entries.
*
*
* @param tasks
* A list of up to 100 task IDs or full ARN entries.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tasks(Collection tasks);
/**
*
* A list of up to 100 task IDs or full ARN entries.
*
*
* @param tasks
* A list of up to 100 task IDs or full ARN entries.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tasks(String... tasks);
/**
*
* Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags
* are included in the response. If this field is omitted, tags are not included in the response.
*
*
* @param include
* Specifies whether you want to see the resource tags for the task. If TAGS is specified,
* the tags are included in the response. If this field is omitted, tags are not 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 task. If TAGS is specified, the tags
* are included in the response. If this field is omitted, tags are not included in the response.
*
*
* @param include
* Specifies whether you want to see the resource tags for the task. If TAGS is specified,
* the tags are included in the response. If this field is omitted, tags are not 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 task. If TAGS is specified, the tags
* are included in the response. If this field is omitted, tags are not included in the response.
*
*
* @param include
* Specifies whether you want to see the resource tags for the task. If TAGS is specified,
* the tags are included in the response. If this field is omitted, tags are not 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 task. If TAGS is specified, the tags
* are included in the response. If this field is omitted, tags are not included in the response.
*
*
* @param include
* Specifies whether you want to see the resource tags for the task. If TAGS is specified,
* the tags are included in the response. If this field is omitted, tags are not included in the
* response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder include(TaskField... 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 tasks = DefaultSdkAutoConstructList.getInstance();
private List include = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeTasksRequest model) {
super(model);
cluster(model.cluster);
tasks(model.tasks);
includeWithStrings(model.include);
}
public final String getCluster() {
return cluster;
}
@Override
public final Builder cluster(String cluster) {
this.cluster = cluster;
return this;
}
public final void setCluster(String cluster) {
this.cluster = cluster;
}
public final Collection getTasks() {
return tasks;
}
@Override
public final Builder tasks(Collection tasks) {
this.tasks = StringListCopier.copy(tasks);
return this;
}
@Override
@SafeVarargs
public final Builder tasks(String... tasks) {
tasks(Arrays.asList(tasks));
return this;
}
public final void setTasks(Collection tasks) {
this.tasks = StringListCopier.copy(tasks);
}
public final Collection getIncludeAsStrings() {
return include;
}
@Override
public final Builder includeWithStrings(Collection include) {
this.include = TaskFieldListCopier.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 = TaskFieldListCopier.copyEnumToString(include);
return this;
}
@Override
@SafeVarargs
public final Builder include(TaskField... include) {
include(Arrays.asList(include));
return this;
}
public final void setIncludeWithStrings(Collection include) {
this.include = TaskFieldListCopier.copy(include);
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeTasksRequest build() {
return new DescribeTasksRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy