Class PutMetricDataRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest
software.amazon.awssdk.services.cloudwatch.model.PutMetricDataRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutMetricDataRequest.Builder,PutMetricDataRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutMetricDataRequest extends CloudWatchRequest implements ToCopyableBuilder<PutMetricDataRequest.Builder,PutMetricDataRequest>

  • Method Details

    • namespace

      public final 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/

      Returns:
      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/

    • hasMetricData

      public final boolean hasMetricData()
      For responses, this returns true if the service returned a value for the MetricData property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • metricData

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetricData() method.

      Returns:
      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.

    • hasEntityMetricData

      public final boolean hasEntityMetricData()
      For responses, this returns true if the service returned a value for the EntityMetricData property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • entityMetricData

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEntityMetricData() method.

      Returns:
      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.

    • strictEntityValidation

      public final 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.

      Returns:
      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.

    • toBuilder

      public PutMetricDataRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutMetricDataRequest.Builder,PutMetricDataRequest>
      Specified by:
      toBuilder in class CloudWatchRequest
      Returns:
      a builder for type T

    • builder

      public static PutMetricDataRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutMetricDataRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.