Class GetMetricStreamResponse

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

  • Method Details

    • arn

      public final String arn()

      The ARN of the metric stream.

      Returns:
      The ARN of the metric stream.

    • name

      public final String name()

      The name of the metric stream.

      Returns:
      The name of the metric stream.

    • 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 this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.

      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 this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.

    • 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 this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this metric stream.

      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 this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this metric stream.

    • firehoseArn

      public final String firehoseArn()

      The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.

      Returns:
      The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.

    • roleArn

      public final String roleArn()

      The ARN of the IAM role that is used by this metric stream.

      Returns:
      The ARN of the IAM role that is used by this metric stream.

    • state

      public final String state()

      The state of the metric stream. The possible values are running and stopped.

      Returns:
      The state of the metric stream. The possible values are running and stopped.

    • creationDate

      public final Instant creationDate()

      The date that the metric stream was created.

      Returns:
      The date that the metric stream was created.

    • lastUpdateDate

      public final Instant lastUpdateDate()

      The date of the most recent update to the metric stream's configuration.

      Returns:
      The date of the most recent update to the metric stream's configuration.

    • outputFormat

      public final MetricStreamOutputFormat outputFormat()

      The output format for the stream. Valid values are json, opentelemetry1.0, 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, opentelemetry1.0, 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, opentelemetry1.0, 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, opentelemetry1.0, and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.
      See Also:

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

      Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream. For more information about the additional statistics, see CloudWatch statistics definitions.

      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:
      Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream. For more information about the additional statistics, see CloudWatch statistics definitions.

    • includeLinkedAccountsMetrics

      public final Boolean includeLinkedAccountsMetrics()

      If this is true and this metric stream is in a monitoring account, then the stream includes metrics from source accounts that the monitoring account is linked to.

      Returns:
      If this is true and this metric stream is in a monitoring account, then the stream includes metrics from source accounts that the monitoring account is linked to.

    • toBuilder

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

    • builder

      public static GetMetricStreamResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.