com.amazonaws.services.iot.model

Class CreateDimensionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CreateDimensionRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreateDimensionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Create a dimension that you can use to limit the scope of a metric used in a security profile for AWS IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateDimensionRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getClientRequestToken() Each dimension must have a unique client request token.
java.lang.String	getName() A unique identifier for the dimension.
java.util.List<java.lang.String>	getStringValues() Specifies the value or list of values for the dimension.
java.util.List<Tag>	getTags() Metadata that can be used to manage the dimension.
java.lang.String	getType() Specifies the type of dimension.
int	hashCode()
void	setClientRequestToken(java.lang.String clientRequestToken) Each dimension must have a unique client request token.
void	setName(java.lang.String name) A unique identifier for the dimension.
void	setStringValues(java.util.Collection<java.lang.String> stringValues) Specifies the value or list of values for the dimension.
void	setTags(java.util.Collection<Tag> tags) Metadata that can be used to manage the dimension.
void	setType(DimensionType type) Specifies the type of dimension.
void	setType(java.lang.String type) Specifies the type of dimension.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateDimensionRequest	withClientRequestToken(java.lang.String clientRequestToken) Each dimension must have a unique client request token.
CreateDimensionRequest	withName(java.lang.String name) A unique identifier for the dimension.
CreateDimensionRequest	withStringValues(java.util.Collection<java.lang.String> stringValues) Specifies the value or list of values for the dimension.
CreateDimensionRequest	withStringValues(java.lang.String... stringValues) Specifies the value or list of values for the dimension.
CreateDimensionRequest	withTags(java.util.Collection<Tag> tags) Metadata that can be used to manage the dimension.
CreateDimensionRequest	withTags(Tag... tags) Metadata that can be used to manage the dimension.
CreateDimensionRequest	withType(DimensionType type) Specifies the type of dimension.
CreateDimensionRequest	withType(java.lang.String type) Specifies the type of dimension.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDimensionRequest

public CreateDimensionRequest()

Method Detail

getName

public java.lang.String getName()

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

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

Returns:

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

setName

public void setName(java.lang.String name)

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

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

Parameters:

name -

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

withName

public CreateDimensionRequest withName(java.lang.String name)

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

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

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

Parameters:

name -

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

Returns:

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

getType

public java.lang.String getType()

Specifies the type of dimension. Supported types: TOPIC_FILTER.

Constraints:
Allowed Values: TOPIC_FILTER

Returns:

Specifies the type of dimension. Supported types: TOPIC_FILTER.

See Also:

DimensionType

setType

public void setType(java.lang.String type)

Specifies the type of dimension. Supported types: TOPIC_FILTER.

Constraints:
Allowed Values: TOPIC_FILTER

Parameters:

type -

Specifies the type of dimension. Supported types: TOPIC_FILTER.

See Also:

DimensionType

withType

public CreateDimensionRequest withType(java.lang.String type)

Specifies the type of dimension. Supported types: TOPIC_FILTER.

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

Constraints:
Allowed Values: TOPIC_FILTER

Parameters:

type -

Specifies the type of dimension. Supported types: TOPIC_FILTER.

Returns:

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

See Also:

DimensionType

setType

public void setType(DimensionType type)

Specifies the type of dimension. Supported types: TOPIC_FILTER.

Constraints:
Allowed Values: TOPIC_FILTER

Parameters:

type -

Specifies the type of dimension. Supported types: TOPIC_FILTER.

See Also:

DimensionType

withType

public CreateDimensionRequest withType(DimensionType type)

Specifies the type of dimension. Supported types: TOPIC_FILTER.

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

Constraints:
Allowed Values: TOPIC_FILTER

Parameters:

type -

Specifies the type of dimension. Supported types: TOPIC_FILTER.

Returns:

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

See Also:

DimensionType

getStringValues

public java.util.List<java.lang.String> getStringValues()

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

Returns:

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

setStringValues

public void setStringValues(java.util.Collection<java.lang.String> stringValues)

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

Parameters:

stringValues -

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

withStringValues

public CreateDimensionRequest withStringValues(java.lang.String... stringValues)

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

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

Parameters:

stringValues -

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

Returns:

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

withStringValues

public CreateDimensionRequest withStringValues(java.util.Collection<java.lang.String> stringValues)

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

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

Parameters:

stringValues -

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

Returns:

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

getTags

public java.util.List<Tag> getTags()

Metadata that can be used to manage the dimension.

Returns:

Metadata that can be used to manage the dimension.

setTags

public void setTags(java.util.Collection<Tag> tags)

Metadata that can be used to manage the dimension.

Parameters:

tags -

Metadata that can be used to manage the dimension.

withTags

public CreateDimensionRequest withTags(Tag... tags)

Metadata that can be used to manage the dimension.

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

Parameters:

tags -

Metadata that can be used to manage the dimension.

Returns:

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

withTags

public CreateDimensionRequest withTags(java.util.Collection<Tag> tags)

Metadata that can be used to manage the dimension.

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

Parameters:

tags -

Metadata that can be used to manage the dimension.

Returns:

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

getClientRequestToken

public java.lang.String getClientRequestToken()

Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Returns:

Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

setClientRequestToken

public void setClientRequestToken(java.lang.String clientRequestToken)

Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Parameters:

clientRequestToken -

Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

withClientRequestToken

public CreateDimensionRequest withClientRequestToken(java.lang.String clientRequestToken)

Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

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

Constraints:
Length: 1 - 64
Pattern: ^[a-zA-Z0-9-_]+$

Parameters:

clientRequestToken -

Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object