Class DescribeFleetMetricResponse

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

  • Method Details

    • metricName

      public final String metricName()

      The name of the fleet metric to describe.

      Returns:
      The name of the fleet metric to describe.

    • queryString

      public final String queryString()

      The search query string.

      Returns:
      The search query string.

    • aggregationType

      public final AggregationType aggregationType()

      The type of the aggregation query.

      Returns:
      The type of the aggregation query.

    • period

      public final Integer period()

      The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

      Returns:
      The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

    • aggregationField

      public final String aggregationField()

      The field to aggregate.

      Returns:
      The field to aggregate.

    • description

      public final String description()

      The fleet metric description.

      Returns:
      The fleet metric description.

    • queryVersion

      public final String queryVersion()

      The query version.

      Returns:
      The query version.

    • indexName

      public final String indexName()

      The name of the index to search.

      Returns:
      The name of the index to search.

    • creationDate

      public final Instant creationDate()

      The date when the fleet metric is created.

      Returns:
      The date when the fleet metric is created.

    • lastModifiedDate

      public final Instant lastModifiedDate()

      The date when the fleet metric is last modified.

      Returns:
      The date when the fleet metric is last modified.

    • unit

      public final FleetMetricUnit unit()

      Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

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

      Returns:
      Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.
      See Also:

    • unitAsString

      public final String unitAsString()

      Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

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

      Returns:
      Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.
      See Also:

    • version

      public final Long version()

      The version of the fleet metric.

      Returns:
      The version of the fleet metric.

    • metricArn

      public final String metricArn()

      The ARN of the fleet metric to describe.

      Returns:
      The ARN of the fleet metric to describe.

    • toBuilder

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

    • builder

      public static DescribeFleetMetricResponse.Builder builder()

    • serializableBuilderClass

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