Package software.amazon.awssdk.services.cloudwatch.model

Class TagResourceRequest

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.TagResourceRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<TagResourceRequest.Builder,TagResourceRequest>
@Generated("software.amazon.awssdk:codegen") public final class TagResourceRequest extends CloudWatchRequest implements ToCopyableBuilder<TagResourceRequest.Builder,TagResourceRequest>

  • Method Details

    • resourceARN

      public final String resourceARN()

      The ARN of the CloudWatch resource that you're adding tags to.

      The ARN format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name

      The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name

      The ARN format of a dashboard is arn:aws:cloudwatch::account-id:dashboard/dashboard-name

      The ARN format of a metric stream is arn:aws:cloudwatch:Region:account-id:metric-stream/metric-stream-name

      For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

      Returns:
      The ARN of the CloudWatch resource that you're adding tags to.

      The ARN format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name

      The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name

      The ARN format of a dashboard is arn:aws:cloudwatch::account-id:dashboard/dashboard-name

      The ARN format of a metric stream is arn:aws:cloudwatch:Region:account-id:metric-stream/metric-stream-name

      For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      The list of key-value pairs to associate with the alarm.

      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 hasTags() method.

      Returns:
      The list of key-value pairs to associate with the alarm.

    • toBuilder

      public TagResourceRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<TagResourceRequest.Builder,TagResourceRequest>
      Specified by:
      toBuilder in class CloudWatchRequest

    • builder

      public static TagResourceRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TagResourceRequest.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo