com.amazonaws.services.iot.model

Class MetricDimension

java.lang.Object

com.amazonaws.services.iot.model.MetricDimension

All Implemented Interfaces:

Serializable

public class MetricDimension
extends Object
implements Serializable

The dimension of a metric.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MetricDimension()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDimensionName() A unique identifier for the dimension.
String	getOperator() Defines how the dimensionValues of a dimension are interpreted.
int	hashCode()
void	setDimensionName(String dimensionName) A unique identifier for the dimension.
void	setOperator(DimensionValueOperator operator) Defines how the dimensionValues of a dimension are interpreted.
void	setOperator(String operator) Defines how the dimensionValues of a dimension are interpreted.
String	toString() Returns a string representation of this object; useful for testing and debugging.
MetricDimension	withDimensionName(String dimensionName) A unique identifier for the dimension.
MetricDimension	withOperator(DimensionValueOperator operator) Defines how the dimensionValues of a dimension are interpreted.
MetricDimension	withOperator(String operator) Defines how the dimensionValues of a dimension are interpreted.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricDimension

public MetricDimension()

Method Detail

getDimensionName

public String getDimensionName()

A unique identifier for the dimension.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Returns:

A unique identifier for the dimension.

setDimensionName

public void setDimensionName(String dimensionName)

A unique identifier for the dimension.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Parameters:

dimensionName -

A unique identifier for the dimension.

withDimensionName

public MetricDimension withDimensionName(String dimensionName)

A unique identifier for the dimension.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Parameters:

dimensionName -

A unique identifier for the dimension.

Returns:

A reference to this updated object so that method calls can be chained together.

getOperator

public String getOperator()

Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.

Constraints:
Allowed Values: IN, NOT_IN

Returns:

Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.

See Also:

DimensionValueOperator

setOperator

public void setOperator(String operator)

Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.

Constraints:
Allowed Values: IN, NOT_IN

Parameters:

operator -

Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.

See Also:

DimensionValueOperator

withOperator

public MetricDimension withOperator(String operator)

Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: IN, NOT_IN

Parameters:

operator -

Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

DimensionValueOperator

setOperator

public void setOperator(DimensionValueOperator operator)

Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.

Constraints:
Allowed Values: IN, NOT_IN

Parameters:

operator -

Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.

See Also:

DimensionValueOperator

withOperator

public MetricDimension withOperator(DimensionValueOperator operator)

Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: IN, NOT_IN

Parameters:

operator -

Defines how the dimensionValues of a dimension are interpreted. For example, for DimensionType TOPIC_FILTER, with IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN Operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

DimensionValueOperator

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object