software.amazon.awssdk.services.ecs.model.GetTaskProtectionResponse 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.HashMap;
import java.util.List;
import java.util.Map;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetTaskProtectionResponse extends EcsResponse implements
ToCopyableBuilder {
private static final SdkField> PROTECTED_TASKS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("protectedTasks")
.getter(getter(GetTaskProtectionResponse::protectedTasks))
.setter(setter(Builder::protectedTasks))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("protectedTasks").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ProtectedTask::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> FAILURES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("failures")
.getter(getter(GetTaskProtectionResponse::failures))
.setter(setter(Builder::failures))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("failures").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Failure::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PROTECTED_TASKS_FIELD,
FAILURES_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("protectedTasks", PROTECTED_TASKS_FIELD);
put("failures", FAILURES_FIELD);
}
});
private final List protectedTasks;
private final List failures;
private GetTaskProtectionResponse(BuilderImpl builder) {
super(builder);
this.protectedTasks = builder.protectedTasks;
this.failures = builder.failures;
}
/**
* For responses, this returns true if the service returned a value for the ProtectedTasks 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 hasProtectedTasks() {
return protectedTasks != null && !(protectedTasks instanceof SdkAutoConstructList);
}
/**
*
* A list of tasks with the following information.
*
*
* -
*
* taskArn: The task ARN.
*
*
* -
*
* protectionEnabled: The protection status of the task. If scale-in protection is turned on for a
* task, the value is true. Otherwise, it is false.
*
*
* -
*
* expirationDate: The epoch time when protection for the task will expire.
*
*
*
*
* 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 #hasProtectedTasks} method.
*
*
* @return A list of tasks with the following information.
*
* -
*
* taskArn: The task ARN.
*
*
* -
*
* protectionEnabled: The protection status of the task. If scale-in protection is turned on
* for a task, the value is true. Otherwise, it is false.
*
*
* -
*
* expirationDate: The epoch time when protection for the task will expire.
*
*
*/
public final List protectedTasks() {
return protectedTasks;
}
/**
* For responses, this returns true if the service returned a value for the Failures 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 hasFailures() {
return failures != null && !(failures instanceof SdkAutoConstructList);
}
/**
*
* Any failures associated with the call.
*
*
* 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 #hasFailures} method.
*
*
* @return Any failures associated with the call.
*/
public final List failures() {
return failures;
}
@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(hasProtectedTasks() ? protectedTasks() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasFailures() ? failures() : 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 GetTaskProtectionResponse)) {
return false;
}
GetTaskProtectionResponse other = (GetTaskProtectionResponse) obj;
return hasProtectedTasks() == other.hasProtectedTasks() && Objects.equals(protectedTasks(), other.protectedTasks())
&& hasFailures() == other.hasFailures() && Objects.equals(failures(), other.failures());
}
/**
* 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("GetTaskProtectionResponse").add("ProtectedTasks", hasProtectedTasks() ? protectedTasks() : null)
.add("Failures", hasFailures() ? failures() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "protectedTasks":
return Optional.ofNullable(clazz.cast(protectedTasks()));
case "failures":
return Optional.ofNullable(clazz.cast(failures()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((GetTaskProtectionResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends EcsResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* A list of tasks with the following information.
*
*
* -
*
* taskArn: The task ARN.
*
*
* -
*
* protectionEnabled: The protection status of the task. If scale-in protection is turned on for a
* task, the value is true. Otherwise, it is false.
*
*
* -
*
* expirationDate: The epoch time when protection for the task will expire.
*
*
*
*
* @param protectedTasks
* A list of tasks with the following information.
*
* -
*
* taskArn: The task ARN.
*
*
* -
*
* protectionEnabled: The protection status of the task. If scale-in protection is turned on
* for a task, the value is true. Otherwise, it is false.
*
*
* -
*
* expirationDate: The epoch time when protection for the task will expire.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder protectedTasks(Collection protectedTasks);
/**
*
* A list of tasks with the following information.
*
*
* -
*
* taskArn: The task ARN.
*
*
* -
*
* protectionEnabled: The protection status of the task. If scale-in protection is turned on for a
* task, the value is true. Otherwise, it is false.
*
*
* -
*
* expirationDate: The epoch time when protection for the task will expire.
*
*
*
*
* @param protectedTasks
* A list of tasks with the following information.
*
* -
*
* taskArn: The task ARN.
*
*
* -
*
* protectionEnabled: The protection status of the task. If scale-in protection is turned on
* for a task, the value is true. Otherwise, it is false.
*
*
* -
*
* expirationDate: The epoch time when protection for the task will expire.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder protectedTasks(ProtectedTask... protectedTasks);
/**
*
* A list of tasks with the following information.
*
*
* -
*
* taskArn: The task ARN.
*
*
* -
*
* protectionEnabled: The protection status of the task. If scale-in protection is turned on for a
* task, the value is true. Otherwise, it is false.
*
*
* -
*
* expirationDate: The epoch time when protection for the task will expire.
*
*
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ecs.model.ProtectedTask.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.ecs.model.ProtectedTask#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.ecs.model.ProtectedTask.Builder#build()} is called immediately and its
* result is passed to {@link #protectedTasks(List)}.
*
* @param protectedTasks
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.ecs.model.ProtectedTask.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #protectedTasks(java.util.Collection)
*/
Builder protectedTasks(Consumer... protectedTasks);
/**
*
* Any failures associated with the call.
*
*
* @param failures
* Any failures associated with the call.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder failures(Collection failures);
/**
*
* Any failures associated with the call.
*
*
* @param failures
* Any failures associated with the call.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder failures(Failure... failures);
/**
*
* Any failures associated with the call.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ecs.model.Failure.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.ecs.model.Failure#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.ecs.model.Failure.Builder#build()} is called immediately and its
* result is passed to {@link #failures(List)}.
*
* @param failures
* a consumer that will call methods on {@link software.amazon.awssdk.services.ecs.model.Failure.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #failures(java.util.Collection)
*/
Builder failures(Consumer... failures);
}
static final class BuilderImpl extends EcsResponse.BuilderImpl implements Builder {
private List protectedTasks = DefaultSdkAutoConstructList.getInstance();
private List failures = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(GetTaskProtectionResponse model) {
super(model);
protectedTasks(model.protectedTasks);
failures(model.failures);
}
public final List getProtectedTasks() {
List result = ProtectedTasksCopier.copyToBuilder(this.protectedTasks);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setProtectedTasks(Collection protectedTasks) {
this.protectedTasks = ProtectedTasksCopier.copyFromBuilder(protectedTasks);
}
@Override
public final Builder protectedTasks(Collection protectedTasks) {
this.protectedTasks = ProtectedTasksCopier.copy(protectedTasks);
return this;
}
@Override
@SafeVarargs
public final Builder protectedTasks(ProtectedTask... protectedTasks) {
protectedTasks(Arrays.asList(protectedTasks));
return this;
}
@Override
@SafeVarargs
public final Builder protectedTasks(Consumer... protectedTasks) {
protectedTasks(Stream.of(protectedTasks).map(c -> ProtectedTask.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getFailures() {
List result = FailuresCopier.copyToBuilder(this.failures);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setFailures(Collection failures) {
this.failures = FailuresCopier.copyFromBuilder(failures);
}
@Override
public final Builder failures(Collection failures) {
this.failures = FailuresCopier.copy(failures);
return this;
}
@Override
@SafeVarargs
public final Builder failures(Failure... failures) {
failures(Arrays.asList(failures));
return this;
}
@Override
@SafeVarargs
public final Builder failures(Consumer... failures) {
failures(Stream.of(failures).map(c -> Failure.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public GetTaskProtectionResponse build() {
return new GetTaskProtectionResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}