Entity (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudwatch.model.Entity

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Entity
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Entity()

Constructors
Constructor and Description
`Entity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Entity`	`addAttributesEntry(String key, String value)` Add a single Attributes entry
`Entity`	`addKeyAttributesEntry(String key, String value)` Add a single KeyAttributes entry
`Entity`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`Entity`	`clearKeyAttributesEntries()` Removes all the entries added into KeyAttributes.
`Entity`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAttributes()` Additional attributes of the entity that are not used to specify the identity of the entity.
`Map<String,String>`	`getKeyAttributes()` The attributes of the entity which identify the specific entity, as a list of key-value pairs.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAttributes(Map<String,String> attributes)` Additional attributes of the entity that are not used to specify the identity of the entity.
`void`	`setKeyAttributes(Map<String,String> keyAttributes)` The attributes of the entity which identify the specific entity, as a list of key-value pairs.
`String`	`toString()` Returns a string representation of this object.
`Entity`	`withAttributes(Map<String,String> attributes)` Additional attributes of the entity that are not used to specify the identity of the entity.
`Entity`	`withKeyAttributes(Map<String,String> keyAttributes)` The attributes of the entity which identify the specific entity, as a list of key-value pairs.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Entity
```
public Entity()
```
- Method Detail
  - getKeyAttributes
```
public Map<String,String> getKeyAttributes()
```
    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.
    
    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.
  - setKeyAttributes
```
public void setKeyAttributes(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.
    
    Parameters:
    
    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.
  - withKeyAttributes
```
public Entity withKeyAttributes(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addKeyAttributesEntry
```
public Entity addKeyAttributesEntry(String key,
                                    String value)
```
    Add a single KeyAttributes entry
    
    See Also:
    
    withKeyAttributes(java.util.Map<java.lang.String, java.lang.String>)
  - clearKeyAttributesEntries
```
public Entity clearKeyAttributesEntries()
```
    Removes all the entries added into KeyAttributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttributes
```
public Map<String,String> getAttributes()
```
    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.
    
    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.
  - setAttributes
```
public void setAttributes(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.
    
    Parameters:
    
    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.
  - withAttributes
```
public Entity withAttributes(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributesEntry
```
public Entity addAttributesEntry(String key,
                                 String value)
```
    Add a single Attributes entry
    
    See Also:
    
    withAttributes(java.util.Map<java.lang.String, java.lang.String>)
  - clearAttributesEntries
```
public Entity clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Entity clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.795

Class Entity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Entity

Method Detail

getKeyAttributes

setKeyAttributes

withKeyAttributes

addKeyAttributesEntry

clearKeyAttributesEntries

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

toString

equals

hashCode

clone

marshall