@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PutMetricDataRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
PutMetricDataRequest() |
| Modifier and Type | Method and Description |
|---|---|
PutMetricDataRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<EntityMetricData> |
getEntityMetricData()
Data for metrics that contain associated entity information.
|
List<MetricDatum> |
getMetricData()
The data for the metrics.
|
String |
getNamespace()
The namespace for the metric data.
|
Boolean |
getStrictEntityValidation()
Whether to accept valid metric data when an invalid entity is sent.
|
int |
hashCode() |
Boolean |
isStrictEntityValidation()
Whether to accept valid metric data when an invalid entity is sent.
|
void |
setEntityMetricData(Collection<EntityMetricData> entityMetricData)
Data for metrics that contain associated entity information.
|
void |
setMetricData(Collection<MetricDatum> metricData)
The data for the metrics.
|
void |
setNamespace(String namespace)
The namespace for the metric data.
|
void |
setStrictEntityValidation(Boolean strictEntityValidation)
Whether to accept valid metric data when an invalid entity is sent.
|
String |
toString()
Returns a string representation of this object.
|
PutMetricDataRequest |
withEntityMetricData(Collection<EntityMetricData> entityMetricData)
Data for metrics that contain associated entity information.
|
PutMetricDataRequest |
withEntityMetricData(EntityMetricData... entityMetricData)
Data for metrics that contain associated entity information.
|
PutMetricDataRequest |
withMetricData(Collection<MetricDatum> metricData)
The data for the metrics.
|
PutMetricDataRequest |
withMetricData(MetricDatum... metricData)
The data for the metrics.
|
PutMetricDataRequest |
withNamespace(String namespace)
The namespace for the metric data.
|
PutMetricDataRequest |
withStrictEntityValidation(Boolean strictEntityValidation)
Whether to accept valid metric data when an invalid entity is sent.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setNamespace(String namespace)
The namespace for the metric data. You can use ASCII characters for the namespace, except for control characters which are not supported.
To avoid conflicts with Amazon Web Services service namespaces, you should not specify a namespace that begins
with AWS/
namespace - The namespace for the metric data. You can use ASCII characters for the namespace, except for control
characters which are not supported.
To avoid conflicts with Amazon Web Services service namespaces, you should not specify a namespace that
begins with AWS/
public String getNamespace()
The namespace for the metric data. You can use ASCII characters for the namespace, except for control characters which are not supported.
To avoid conflicts with Amazon Web Services service namespaces, you should not specify a namespace that begins
with AWS/
To avoid conflicts with Amazon Web Services service namespaces, you should not specify a namespace that
begins with AWS/
public PutMetricDataRequest withNamespace(String namespace)
The namespace for the metric data. You can use ASCII characters for the namespace, except for control characters which are not supported.
To avoid conflicts with Amazon Web Services service namespaces, you should not specify a namespace that begins
with AWS/
namespace - The namespace for the metric data. You can use ASCII characters for the namespace, except for control
characters which are not supported.
To avoid conflicts with Amazon Web Services service namespaces, you should not specify a namespace that
begins with AWS/
public List<MetricDatum> getMetricData()
The data for the metrics. Use this parameter if your metrics do not contain associated entities. The array can include no more than 1000 metrics per call.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and MetricData
metrics.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and
MetricData metrics.
public void setMetricData(Collection<MetricDatum> metricData)
The data for the metrics. Use this parameter if your metrics do not contain associated entities. The array can include no more than 1000 metrics per call.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and MetricData
metrics.
metricData - The data for the metrics. Use this parameter if your metrics do not contain associated entities. The array
can include no more than 1000 metrics per call.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and
MetricData metrics.
public PutMetricDataRequest withMetricData(MetricDatum... metricData)
The data for the metrics. Use this parameter if your metrics do not contain associated entities. The array can include no more than 1000 metrics per call.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and MetricData
metrics.
NOTE: This method appends the values to the existing list (if any). Use
setMetricData(java.util.Collection) or withMetricData(java.util.Collection) if you want to
override the existing values.
metricData - The data for the metrics. Use this parameter if your metrics do not contain associated entities. The array
can include no more than 1000 metrics per call.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and
MetricData metrics.
public PutMetricDataRequest withMetricData(Collection<MetricDatum> metricData)
The data for the metrics. Use this parameter if your metrics do not contain associated entities. The array can include no more than 1000 metrics per call.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and MetricData
metrics.
metricData - The data for the metrics. Use this parameter if your metrics do not contain associated entities. The array
can include no more than 1000 metrics per call.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and
MetricData metrics.
public List<EntityMetricData> getEntityMetricData()
Data for metrics that contain associated entity information. You can include up to two
EntityMetricData objects, each of which can contain a single Entity and associated
metrics.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and MetricData
metrics.
EntityMetricData objects, each of which can contain a single Entity and
associated metrics.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and
MetricData metrics.
public void setEntityMetricData(Collection<EntityMetricData> entityMetricData)
Data for metrics that contain associated entity information. You can include up to two
EntityMetricData objects, each of which can contain a single Entity and associated
metrics.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and MetricData
metrics.
entityMetricData - Data for metrics that contain associated entity information. You can include up to two
EntityMetricData objects, each of which can contain a single Entity and
associated metrics.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and
MetricData metrics.
public PutMetricDataRequest withEntityMetricData(EntityMetricData... entityMetricData)
Data for metrics that contain associated entity information. You can include up to two
EntityMetricData objects, each of which can contain a single Entity and associated
metrics.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and MetricData
metrics.
NOTE: This method appends the values to the existing list (if any). Use
setEntityMetricData(java.util.Collection) or withEntityMetricData(java.util.Collection) if you
want to override the existing values.
entityMetricData - Data for metrics that contain associated entity information. You can include up to two
EntityMetricData objects, each of which can contain a single Entity and
associated metrics.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and
MetricData metrics.
public PutMetricDataRequest withEntityMetricData(Collection<EntityMetricData> entityMetricData)
Data for metrics that contain associated entity information. You can include up to two
EntityMetricData objects, each of which can contain a single Entity and associated
metrics.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and MetricData
metrics.
entityMetricData - Data for metrics that contain associated entity information. You can include up to two
EntityMetricData objects, each of which can contain a single Entity and
associated metrics.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData and
MetricData metrics.
public void setStrictEntityValidation(Boolean strictEntityValidation)
Whether to accept valid metric data when an invalid entity is sent.
When set to true: Any validation error (for entity or metric data) will fail the entire request, and
no data will be ingested. The failed operation will return a 400 result with the error.
When set to false: Validation errors in the entity will not associate the metric with the entity,
but the metric data will still be accepted and ingested. Validation errors in the metric data will fail the
entire request, and no data will be ingested.
In the case of an invalid entity, the operation will return a 200 status, but an additional response
header will contain information about the validation errors. The new header, X-Amzn-Failure-Message
is an enumeration of the following values:
InvalidEntity - The provided entity is invalid.
InvalidKeyAttributes - The provided KeyAttributes of an entity is invalid.
InvalidAttributes - The provided Attributes of an entity is invalid.
InvalidTypeValue - The provided Type in the KeyAttributes of an entity is
invalid.
EntitySizeTooLarge - The number of EntityMetricData objects allowed is 2.
MissingRequiredFields - There are missing required fields in the KeyAttributes for the
provided Type.
For details of the requirements for specifying an entity, see How to add related information to telemetry in the CloudWatch User Guide.
This parameter is required when EntityMetricData is included.
strictEntityValidation - Whether to accept valid metric data when an invalid entity is sent.
When set to true: Any validation error (for entity or metric data) will fail the entire
request, and no data will be ingested. The failed operation will return a 400 result with the error.
When set to false: Validation errors in the entity will not associate the metric with the
entity, but the metric data will still be accepted and ingested. Validation errors in the metric data will
fail the entire request, and no data will be ingested.
In the case of an invalid entity, the operation will return a 200 status, but an additional
response header will contain information about the validation errors. The new header,
X-Amzn-Failure-Message is an enumeration of the following values:
InvalidEntity - The provided entity is invalid.
InvalidKeyAttributes - The provided KeyAttributes of an entity is invalid.
InvalidAttributes - The provided Attributes of an entity is invalid.
InvalidTypeValue - The provided Type in the KeyAttributes of an
entity is invalid.
EntitySizeTooLarge - The number of EntityMetricData objects allowed is 2.
MissingRequiredFields - There are missing required fields in the KeyAttributes
for the provided Type.
For details of the requirements for specifying an entity, see How to add related information to telemetry in the CloudWatch User Guide.
This parameter is required when EntityMetricData is included.
public Boolean getStrictEntityValidation()
Whether to accept valid metric data when an invalid entity is sent.
When set to true: Any validation error (for entity or metric data) will fail the entire request, and
no data will be ingested. The failed operation will return a 400 result with the error.
When set to false: Validation errors in the entity will not associate the metric with the entity,
but the metric data will still be accepted and ingested. Validation errors in the metric data will fail the
entire request, and no data will be ingested.
In the case of an invalid entity, the operation will return a 200 status, but an additional response
header will contain information about the validation errors. The new header, X-Amzn-Failure-Message
is an enumeration of the following values:
InvalidEntity - The provided entity is invalid.
InvalidKeyAttributes - The provided KeyAttributes of an entity is invalid.
InvalidAttributes - The provided Attributes of an entity is invalid.
InvalidTypeValue - The provided Type in the KeyAttributes of an entity is
invalid.
EntitySizeTooLarge - The number of EntityMetricData objects allowed is 2.
MissingRequiredFields - There are missing required fields in the KeyAttributes for the
provided Type.
For details of the requirements for specifying an entity, see How to add related information to telemetry in the CloudWatch User Guide.
This parameter is required when EntityMetricData is included.
When set to true: Any validation error (for entity or metric data) will fail the entire
request, and no data will be ingested. The failed operation will return a 400 result with the error.
When set to false: Validation errors in the entity will not associate the metric with the
entity, but the metric data will still be accepted and ingested. Validation errors in the metric data
will fail the entire request, and no data will be ingested.
In the case of an invalid entity, the operation will return a 200 status, but an additional
response header will contain information about the validation errors. The new header,
X-Amzn-Failure-Message is an enumeration of the following values:
InvalidEntity - The provided entity is invalid.
InvalidKeyAttributes - The provided KeyAttributes of an entity is invalid.
InvalidAttributes - The provided Attributes of an entity is invalid.
InvalidTypeValue - The provided Type in the KeyAttributes of an
entity is invalid.
EntitySizeTooLarge - The number of EntityMetricData objects allowed is 2.
MissingRequiredFields - There are missing required fields in the KeyAttributes
for the provided Type.
For details of the requirements for specifying an entity, see How to add related information to telemetry in the CloudWatch User Guide.
This parameter is required when EntityMetricData is included.
public PutMetricDataRequest withStrictEntityValidation(Boolean strictEntityValidation)
Whether to accept valid metric data when an invalid entity is sent.
When set to true: Any validation error (for entity or metric data) will fail the entire request, and
no data will be ingested. The failed operation will return a 400 result with the error.
When set to false: Validation errors in the entity will not associate the metric with the entity,
but the metric data will still be accepted and ingested. Validation errors in the metric data will fail the
entire request, and no data will be ingested.
In the case of an invalid entity, the operation will return a 200 status, but an additional response
header will contain information about the validation errors. The new header, X-Amzn-Failure-Message
is an enumeration of the following values:
InvalidEntity - The provided entity is invalid.
InvalidKeyAttributes - The provided KeyAttributes of an entity is invalid.
InvalidAttributes - The provided Attributes of an entity is invalid.
InvalidTypeValue - The provided Type in the KeyAttributes of an entity is
invalid.
EntitySizeTooLarge - The number of EntityMetricData objects allowed is 2.
MissingRequiredFields - There are missing required fields in the KeyAttributes for the
provided Type.
For details of the requirements for specifying an entity, see How to add related information to telemetry in the CloudWatch User Guide.
This parameter is required when EntityMetricData is included.
strictEntityValidation - Whether to accept valid metric data when an invalid entity is sent.
When set to true: Any validation error (for entity or metric data) will fail the entire
request, and no data will be ingested. The failed operation will return a 400 result with the error.
When set to false: Validation errors in the entity will not associate the metric with the
entity, but the metric data will still be accepted and ingested. Validation errors in the metric data will
fail the entire request, and no data will be ingested.
In the case of an invalid entity, the operation will return a 200 status, but an additional
response header will contain information about the validation errors. The new header,
X-Amzn-Failure-Message is an enumeration of the following values:
InvalidEntity - The provided entity is invalid.
InvalidKeyAttributes - The provided KeyAttributes of an entity is invalid.
InvalidAttributes - The provided Attributes of an entity is invalid.
InvalidTypeValue - The provided Type in the KeyAttributes of an
entity is invalid.
EntitySizeTooLarge - The number of EntityMetricData objects allowed is 2.
MissingRequiredFields - There are missing required fields in the KeyAttributes
for the provided Type.
For details of the requirements for specifying an entity, see How to add related information to telemetry in the CloudWatch User Guide.
This parameter is required when EntityMetricData is included.
public Boolean isStrictEntityValidation()
Whether to accept valid metric data when an invalid entity is sent.
When set to true: Any validation error (for entity or metric data) will fail the entire request, and
no data will be ingested. The failed operation will return a 400 result with the error.
When set to false: Validation errors in the entity will not associate the metric with the entity,
but the metric data will still be accepted and ingested. Validation errors in the metric data will fail the
entire request, and no data will be ingested.
In the case of an invalid entity, the operation will return a 200 status, but an additional response
header will contain information about the validation errors. The new header, X-Amzn-Failure-Message
is an enumeration of the following values:
InvalidEntity - The provided entity is invalid.
InvalidKeyAttributes - The provided KeyAttributes of an entity is invalid.
InvalidAttributes - The provided Attributes of an entity is invalid.
InvalidTypeValue - The provided Type in the KeyAttributes of an entity is
invalid.
EntitySizeTooLarge - The number of EntityMetricData objects allowed is 2.
MissingRequiredFields - There are missing required fields in the KeyAttributes for the
provided Type.
For details of the requirements for specifying an entity, see How to add related information to telemetry in the CloudWatch User Guide.
This parameter is required when EntityMetricData is included.
When set to true: Any validation error (for entity or metric data) will fail the entire
request, and no data will be ingested. The failed operation will return a 400 result with the error.
When set to false: Validation errors in the entity will not associate the metric with the
entity, but the metric data will still be accepted and ingested. Validation errors in the metric data
will fail the entire request, and no data will be ingested.
In the case of an invalid entity, the operation will return a 200 status, but an additional
response header will contain information about the validation errors. The new header,
X-Amzn-Failure-Message is an enumeration of the following values:
InvalidEntity - The provided entity is invalid.
InvalidKeyAttributes - The provided KeyAttributes of an entity is invalid.
InvalidAttributes - The provided Attributes of an entity is invalid.
InvalidTypeValue - The provided Type in the KeyAttributes of an
entity is invalid.
EntitySizeTooLarge - The number of EntityMetricData objects allowed is 2.
MissingRequiredFields - There are missing required fields in the KeyAttributes
for the provided Type.
For details of the requirements for specifying an entity, see How to add related information to telemetry in the CloudWatch User Guide.
This parameter is required when EntityMetricData is included.
public String toString()
toString in class ObjectObject.toString()public PutMetricDataRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()