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

Class ListMetricsResponse

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

  • Method Details

    • hasMetrics

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

    • metrics

      public final List<Metric> metrics()

      The metrics that match your request.

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

      Returns:
      The metrics that match your request.

    • nextToken

      public final String nextToken()

      The token that marks the start of the next batch of returned results.

      Returns:
      The token that marks the start of the next batch of returned results.

    • hasOwningAccounts

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

    • owningAccounts

      public final List<String> owningAccounts()

      If you are using this operation in a monitoring account, this array contains the account IDs of the source accounts where the metrics in the returned data are from.

      This field is a 1:1 mapping between each metric that is returned and the ID of the owning account.

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

      Returns:
      If you are using this operation in a monitoring account, this array contains the account IDs of the source accounts where the metrics in the returned data are from.

      This field is a 1:1 mapping between each metric that is returned and the ID of the owning account.

    • toBuilder

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

    • builder

      public static ListMetricsResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListMetricsResponse.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)
      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 SdkResponse

    • 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