java.lang.Object
- software.amazon.awssdk.services.cloudwatch.model.Entity

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Entity.Builder,Entity>
```
@Generated("software.amazon.awssdk:codegen")
public final class Entity
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Entity.Builder,Entity>
```
An entity associated with metrics, to allow for finding related telemetry. An entity is typically a resource or service within your system. For example, metrics from an Amazon EC2 instance could be associated with that instance as the entity. Similarly, metrics from a service that you own could be associated with that service as the entity.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Entity.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,String>`	`attributes()`	Additional attributes of the entity that are not used to specify the identity of the entity.
`static Entity.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()`	For responses, this returns true if the service returned a value for the Attributes property.
`int`	`hashCode()`
`boolean`	`hasKeyAttributes()`	For responses, this returns true if the service returned a value for the KeyAttributes property.
`Map<String,String>`	`keyAttributes()`	The attributes of the entity which identify the specific entity, as a list of key-value pairs.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Entity.Builder>`	`serializableBuilderClass()`
`Entity.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - hasKeyAttributes
```
public final boolean hasKeyAttributes()
```
    For responses, this returns true if the service returned a value for the KeyAttributes 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.
  - keyAttributes
```
public final Map<String,String> keyAttributes()
```
    The attributes of the entity which identify the specific entity, as a list of key-value pairs. Entities with the same KeyAttributes are considered to be the same entity. For an entity to be valid, the KeyAttributes must exist and be formatted correctly.
    
    There are five allowed attributes (key names): Type, ResourceType, Identifier, Name, and Environment.
    
    For details about how to use the key attributes to specify an entity, see How to add related information to telemetry in the CloudWatch User Guide.
    
    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 hasKeyAttributes() method.
    
    Returns:
    
    The attributes of the entity which identify the specific entity, as a list of key-value pairs. Entities with the same KeyAttributes are considered to be the same entity. For an entity to be valid, the KeyAttributes must exist and be formatted correctly.
    
    There are five allowed attributes (key names): Type, ResourceType, Identifier, Name, and Environment.
    
    For details about how to use the key attributes to specify an entity, see How to add related information to telemetry in the CloudWatch User Guide.
  - hasAttributes
```
public final boolean hasAttributes()
```
    For responses, this returns true if the service returned a value for the Attributes 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.
  - attributes
```
public final Map<String,String> attributes()
```
    Additional attributes of the entity that are not used to specify the identity of the entity. A list of key-value pairs.
    
    For details about how to use the attributes, see How to add related information to telemetry in the CloudWatch User Guide.
    
    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 hasAttributes() method.
    
    Returns:
    
    Additional attributes of the entity that are not used to specify the identity of the entity. A list of key-value pairs.
    
    For details about how to use the attributes, see How to add related information to telemetry in the CloudWatch User Guide.
  - toBuilder
```
public Entity.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Entity.Builder,Entity>
  - builder
```
public static Entity.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Entity.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class Entity

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasKeyAttributes

keyAttributes

hasAttributes

attributes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField