CreateCustomMetricRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.iot.model.CreateCustomMetricRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateCustomMetricRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateCustomMetricRequest()

Constructors
Constructor and Description
`CreateCustomMetricRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateCustomMetricRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getClientRequestToken()` Each custom metric must have a unique client request token.
`String`	`getDisplayName()` The friendly name in the console for the custom metric.
`String`	`getMetricName()` The name of the custom metric.
`String`	`getMetricType()` The type of the custom metric.
`List<Tag>`	`getTags()` Metadata that can be used to manage the custom metric.
`int`	`hashCode()`
`void`	`setClientRequestToken(String clientRequestToken)` Each custom metric must have a unique client request token.
`void`	`setDisplayName(String displayName)` The friendly name in the console for the custom metric.
`void`	`setMetricName(String metricName)` The name of the custom metric.
`void`	`setMetricType(String metricType)` The type of the custom metric.
`void`	`setTags(Collection<Tag> tags)` Metadata that can be used to manage the custom metric.
`String`	`toString()` Returns a string representation of this object.
`CreateCustomMetricRequest`	`withClientRequestToken(String clientRequestToken)` Each custom metric must have a unique client request token.
`CreateCustomMetricRequest`	`withDisplayName(String displayName)` The friendly name in the console for the custom metric.
`CreateCustomMetricRequest`	`withMetricName(String metricName)` The name of the custom metric.
`CreateCustomMetricRequest`	`withMetricType(CustomMetricType metricType)` The type of the custom metric.
`CreateCustomMetricRequest`	`withMetricType(String metricType)` The type of the custom metric.
`CreateCustomMetricRequest`	`withTags(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 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateCustomMetricRequest
```
public CreateCustomMetricRequest()
```
- Method Detail
  - setMetricName
```
public void setMetricName(String metricName)
```
    The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws:. You can't change the name after you define it.
    
    Parameters:
    
    metricName - The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws:. You can't change the name after you define it.
  - getMetricName
```
public String getMetricName()
```
    The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws:. You can't change the name after you define it.
    
    Returns:
    
    The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws:. You can't change the name after you define it.
  - withMetricName
```
public CreateCustomMetricRequest withMetricName(String metricName)
```
    The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws:. You can't change the name after you define it.
    
    Parameters:
    
    metricName - The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws:. You can't change the name after you define it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.
    
    Parameters:
    
    displayName - The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.
  - getDisplayName
```
public String getDisplayName()
```
    The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.
    
    Returns:
    
    The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.
  - withDisplayName
```
public CreateCustomMetricRequest withDisplayName(String displayName)
```
    The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.
    
    Parameters:
    
    displayName - The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricType
```
public void setMetricType(String metricType)
```
    The type of the custom metric.
    
    The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.
    
    Parameters:
    
    metricType - The type of the custom metric.
    
    The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.
    
    See Also:
    
    CustomMetricType
  - getMetricType
```
public String getMetricType()
```
    The type of the custom metric.
    
    The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.
    
    Returns:
    
    The type of the custom metric.
    
    The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.
    
    See Also:
    
    CustomMetricType
  - withMetricType
```
public CreateCustomMetricRequest withMetricType(String metricType)
```
    The type of the custom metric.
    
    The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.
    
    Parameters:
    
    metricType - The type of the custom metric.
    
    The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CustomMetricType
  - withMetricType
```
public CreateCustomMetricRequest withMetricType(CustomMetricType metricType)
```
    The type of the custom metric.
    
    The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.
    
    Parameters:
    
    metricType - The type of the custom metric.
    
    The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CustomMetricType
  - getTags
```
public 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(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - Metadata that can be used to manage the custom metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreateCustomMetricRequest withTags(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientRequestToken
```
public void setClientRequestToken(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, Amazon Web Services SDKs will automatically generate a unique client request.
    
    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, Amazon Web Services SDKs will automatically generate a unique client request.
  - getClientRequestToken
```
public 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, Amazon Web Services SDKs will automatically generate a unique client request.
    
    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, Amazon Web Services SDKs will automatically generate a unique client request.
  - withClientRequestToken
```
public CreateCustomMetricRequest withClientRequestToken(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, Amazon Web Services SDKs will automatically generate a unique client request.
    
    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, Amazon Web Services SDKs will automatically generate a unique client request.
    
    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 CreateCustomMetricRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.780

Class CreateCustomMetricRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateCustomMetricRequest

Method Detail

setMetricName

getMetricName

withMetricName

setDisplayName

getDisplayName

withDisplayName

setMetricType

getMetricType

withMetricType

withMetricType

getTags

setTags

withTags

withTags

setClientRequestToken

getClientRequestToken

withClientRequestToken

toString

equals

hashCode

clone