software.amazon.awssdk.services.ecs.model

Class UpdateTaskProtectionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ecs.model.EcsRequest

software.amazon.awssdk.services.ecs.model.UpdateTaskProtectionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateTaskProtectionRequest.Builder,UpdateTaskProtectionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateTaskProtectionRequest
extends EcsRequest
implements ToCopyableBuilder<UpdateTaskProtectionRequest.Builder,UpdateTaskProtectionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateTaskProtectionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateTaskProtectionRequest.Builder	builder()
String	cluster() The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	expiresInMinutes() If you set protectionEnabled to true, you can specify the duration for task protection in minutes.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTasks() For responses, this returns true if the service returned a value for the Tasks property.
Boolean	protectionEnabled() Specify true to mark a task for protection and false to unset protection, making it eligible for termination.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateTaskProtectionRequest.Builder>	serializableBuilderClass()
List<String>	tasks() A list of up to 10 task IDs or full ARN entries.
UpdateTaskProtectionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

cluster

public final String cluster()

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

Returns:

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

hasTasks

public final boolean hasTasks()

For responses, this returns true if the service returned a value for the Tasks property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

tasks

public final List<String> tasks()

A list of up to 10 task IDs or full 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 hasTasks() method.

Returns:

A list of up to 10 task IDs or full ARN entries.

protectionEnabled

public final Boolean protectionEnabled()

Specify true to mark a task for protection and false to unset protection, making it eligible for termination.

Returns:

Specify true to mark a task for protection and false to unset protection, making it eligible for termination.

expiresInMinutes

public final Integer expiresInMinutes()

If you set protectionEnabled to true, you can specify the duration for task protection in minutes. You can specify a value from 1 minute to up to 2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in events from Service Auto Scaling or deployments. After this time period lapses, protectionEnabled will be reset to false.

If you don’t specify the time, then the task is automatically protected for 120 minutes (2 hours).

Returns:

If you set protectionEnabled to true, you can specify the duration for task protection in minutes. You can specify a value from 1 minute to up to 2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in events from Service Auto Scaling or deployments. After this time period lapses, protectionEnabled will be reset to false.

If you don’t specify the time, then the task is automatically protected for 120 minutes (2 hours).

toBuilder

public UpdateTaskProtectionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateTaskProtectionRequest.Builder,UpdateTaskProtectionRequest>

Specified by:

toBuilder in class EcsRequest

builder

public static UpdateTaskProtectionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateTaskProtectionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo