com.amazonaws.services.iot.model

Class CreateCustomMetricRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.CreateCustomMetricRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreateCustomMetricRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Use this API to define a Custom Metric published by your devices to Device Defender.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateCustomMetricRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getClientRequestToken() Each custom metric must have a unique client request token.
java.lang.String	getDisplayName() Field represents a friendly name in the console for the custom metric; it doesn't have to be unique.
java.lang.String	getMetricName() The name of the custom metric.
java.lang.String	getMetricType() The type of the custom metric.
java.util.List<Tag>	getTags() Metadata that can be used to manage the custom metric.
int	hashCode()
void	setClientRequestToken(java.lang.String clientRequestToken) Each custom metric must have a unique client request token.
void	setDisplayName(java.lang.String displayName) Field represents a friendly name in the console for the custom metric; it doesn't have to be unique.
void	setMetricName(java.lang.String metricName) The name of the custom metric.
void	setMetricType(CustomMetricType metricType) The type of the custom metric.
void	setMetricType(java.lang.String metricType) The type of the custom metric.
void	setTags(java.util.Collection<Tag> tags) Metadata that can be used to manage the custom metric.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateCustomMetricRequest	withClientRequestToken(java.lang.String clientRequestToken) Each custom metric must have a unique client request token.
CreateCustomMetricRequest	withDisplayName(java.lang.String displayName) Field represents a friendly name in the console for the custom metric; it doesn't have to be unique.
CreateCustomMetricRequest	withMetricName(java.lang.String metricName) The name of the custom metric.
CreateCustomMetricRequest	withMetricType(CustomMetricType metricType) The type of the custom metric.
CreateCustomMetricRequest	withMetricType(java.lang.String metricType) The type of the custom metric.
CreateCustomMetricRequest	withTags(java.util.Collection<Tag> tags) Metadata that can be used to manage the custom metric.
CreateCustomMetricRequest	withTags(Tag... tags) Metadata that can be used to manage the custom metric.

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

CreateCustomMetricRequest

public CreateCustomMetricRequest()

Method Detail

getMetricName

public java.lang.String getMetricName()

The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws:. Cannot be updated once defined.

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

Returns:

The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws:. Cannot be updated once defined.

setMetricName

public void setMetricName(java.lang.String metricName)

The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws:. Cannot be updated once defined.

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

Parameters:

metricName -

The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws:. Cannot be updated once defined.

withMetricName

public CreateCustomMetricRequest withMetricName(java.lang.String metricName)

The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws:. Cannot be updated once defined.

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

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

Parameters:

metricName -

The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws:. Cannot be updated once defined.

Returns:

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

getDisplayName

public java.lang.String getDisplayName()

Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.

Constraints:
Length: - 128
Pattern: [\p{Graph}\x20]*

Returns:

Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.

setDisplayName

public void setDisplayName(java.lang.String displayName)

Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.

Constraints:
Length: - 128
Pattern: [\p{Graph}\x20]*

Parameters:

displayName -

Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.

withDisplayName

public CreateCustomMetricRequest withDisplayName(java.lang.String displayName)

Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.

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

Constraints:
Length: - 128
Pattern: [\p{Graph}\x20]*

Parameters:

displayName -

Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.

Returns:

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

getMetricType

public java.lang.String getMetricType()

The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

Constraints:
Allowed Values: string-list, ip-address-list, number-list, number

Returns:

The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

See Also:

CustomMetricType

setMetricType

public void setMetricType(java.lang.String metricType)

The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

Constraints:
Allowed Values: string-list, ip-address-list, number-list, number

Parameters:

metricType -

The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

See Also:

CustomMetricType

withMetricType

public CreateCustomMetricRequest withMetricType(java.lang.String metricType)

The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

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

Constraints:
Allowed Values: string-list, ip-address-list, number-list, number

Parameters:

metricType -

The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

Returns:

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

See Also:

CustomMetricType

setMetricType

public void setMetricType(CustomMetricType metricType)

The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

Constraints:
Allowed Values: string-list, ip-address-list, number-list, number

Parameters:

metricType -

The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

See Also:

CustomMetricType

withMetricType

public CreateCustomMetricRequest withMetricType(CustomMetricType metricType)

The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

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

Constraints:
Allowed Values: string-list, ip-address-list, number-list, number

Parameters:

metricType -

The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

Returns:

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

See Also:

CustomMetricType

getTags

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

Metadata that can be used to manage the custom metric.

Returns:

Metadata that can be used to manage the custom metric.

setTags

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

Metadata that can be used to manage the custom metric.

Parameters:

tags -

Metadata that can be used to manage the custom metric.

withTags

public CreateCustomMetricRequest withTags(Tag... tags)

Metadata that can be used to manage the custom metric.

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

Parameters:

tags -

Metadata that can be used to manage the custom metric.

Returns:

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

withTags

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

Metadata that can be used to manage the custom metric.

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

Parameters:

tags -

Metadata that can be used to manage the custom metric.

Returns:

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

getClientRequestToken

public java.lang.String getClientRequestToken()

Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, 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 custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, 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 custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, 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 custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

withClientRequestToken

public CreateCustomMetricRequest withClientRequestToken(java.lang.String clientRequestToken)

Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, 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 custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, 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