Package software.amazon.awssdk.services.ecs.model

Class Attribute

java.lang.Object

software.amazon.awssdk.services.ecs.model.Attribute

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Attribute.Builder,Attribute>

@Generated("software.amazon.awssdk:codegen")
public final class Attribute
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Attribute.Builder,Attribute>

An attribute is a name-value pair that's associated with an Amazon ECS object. Use attributes to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Attribute.Builder

Method Summary

Modifier and Type	Method	Description
static Attribute.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the attribute.
List<SdkField<?>>	sdkFields()
static Class<? extends Attribute.Builder>	serializableBuilderClass()
String	targetId()	The ID of the target.
TargetType	targetType()	The type of the target to attach the attribute with.
String	targetTypeAsString()	The type of the target to attach the attribute with.
Attribute.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	value()	The value of the attribute.

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

name

public final String name()

The name of the attribute. The name must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (\), or periods (.).

Returns:

The name of the attribute. The name must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (\), or periods (.).

value

public final String value()

The value of the attribute. The value must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\), colons (:), or spaces. The value can't start or end with a space.

Returns:

The value of the attribute. The value must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\), colons (:), or spaces. The value can't start or end with a space.

targetType

public final TargetType targetType()

The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.

If the service returns an enum value that is not available in the current SDK version, targetType will return TargetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().

Returns:

The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.

See Also:

TargetType

targetTypeAsString

public final String targetTypeAsString()

The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.

If the service returns an enum value that is not available in the current SDK version, targetType will return TargetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().

Returns:

The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.

See Also:

TargetType

targetId

public final String targetId()

The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

Returns:

The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

toBuilder

public Attribute.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Attribute.Builder,Attribute>

builder

public static Attribute.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo