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

Class PutMetricStreamRequest

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

  • Method Details

    • name

      public final String name()

      If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region.

      If you are updating a metric stream, specify the name of that stream here.

      Valid characters are A-Z, a-z, 0-9, "-" and "_".

      Returns:
      If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region.

      If you are updating a metric stream, specify the name of that stream here.

      Valid characters are A-Z, a-z, 0-9, "-" and "_".

    • hasIncludeFilters

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

    • includeFilters

      public final List<MetricStreamFilter> includeFilters()

      If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.

      You cannot include IncludeFilters and ExcludeFilters in the same operation.

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

      Returns:
      If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.

      You cannot include IncludeFilters and ExcludeFilters in the same operation.

    • hasExcludeFilters

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

    • excludeFilters

      public final List<MetricStreamFilter> excludeFilters()

      If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.

      You cannot include ExcludeFilters and IncludeFilters in the same operation.

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

      Returns:
      If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.

      You cannot include ExcludeFilters and IncludeFilters in the same operation.

    • firehoseArn

      public final String firehoseArn()

      The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream. This Amazon Kinesis Data Firehose delivery stream must already exist and must be in the same account as the metric stream.

      Returns:
      The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream. This Amazon Kinesis Data Firehose delivery stream must already exist and must be in the same account as the metric stream.

    • roleArn

      public final String roleArn()

      The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the following permissions:

      • firehose:PutRecord

      • firehose:PutRecordBatch

      Returns:
      The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the following permissions:

      • firehose:PutRecord

      • firehose:PutRecordBatch

    • outputFormat

      public final MetricStreamOutputFormat outputFormat()

      The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.

      If the service returns an enum value that is not available in the current SDK version, outputFormat will return MetricStreamOutputFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputFormatAsString().

      Returns:
      The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.
      See Also:

    • outputFormatAsString

      public final String outputFormatAsString()

      The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.

      If the service returns an enum value that is not available in the current SDK version, outputFormat will return MetricStreamOutputFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputFormatAsString().

      Returns:
      The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.
      See Also:

    • 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()

      A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags you specify in this parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource.

      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:
      A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags you specify in this parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource.

    • hasStatisticsConfigurations

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

    • statisticsConfigurations

      public final List<MetricStreamStatisticsConfiguration> statisticsConfigurations()

      By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.

      For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's OutputFormat. If the OutputFormat is json, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If the OutputFormat is opentelemetry0.7, you can stream percentile statistics such as p95, p99.9, and so on.

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

      Returns:
      By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.

      For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's OutputFormat. If the OutputFormat is json, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch statistics definitions. If the OutputFormat is opentelemetry0.7, you can stream percentile statistics such as p95, p99.9, and so on.

    • includeLinkedAccountsMetrics

      public final Boolean includeLinkedAccountsMetrics()

      If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts in the metric stream.

      Returns:
      If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts in the metric stream.

    • toBuilder

      public PutMetricStreamRequest.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<PutMetricStreamRequest.Builder,PutMetricStreamRequest>
      Specified by:
      toBuilder in class CloudWatchRequest
      Returns:
      a builder for type T

    • builder

      public static PutMetricStreamRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutMetricStreamRequest.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.