DescribeFleetMetricResponse (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class DescribeFleetMetricResponse
extends IotResponse
implements ToCopyableBuilder<DescribeFleetMetricResponse.Builder,DescribeFleetMetricResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeFleetMetricResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeFleetMetricResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`aggregationField()` The field to aggregate.
`AggregationType`	`aggregationType()` The type of the aggregation query.
`static DescribeFleetMetricResponse.Builder`	`builder()`
`Instant`	`creationDate()` The date when the fleet metric is created.
`String`	`description()` The fleet metric description.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`indexName()` The name of the index to search.
`Instant`	`lastModifiedDate()` The date when the fleet metric is last modified.
`String`	`metricArn()` The ARN of the fleet metric to describe.
`String`	`metricName()` The name of the fleet metric to describe.
`Integer`	`period()` The time in seconds between fleet metric emissions.
`String`	`queryString()` The search query string.
`String`	`queryVersion()` The query version.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeFleetMetricResponse.Builder>`	`serializableBuilderClass()`
`DescribeFleetMetricResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`FleetMetricUnit`	`unit()` Used to support unit transformation such as milliseconds to seconds.
`String`	`unitAsString()` Used to support unit transformation such as milliseconds to seconds.
`Long`	`version()` The version of the fleet metric.

Methods inherited from class software.amazon.awssdk.services.iot.model.IotResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    FleetMetricUnit
  - 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:
    
    FleetMetricUnit
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeFleetMetricResponse.Builder,DescribeFleetMetricResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - 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)
```
    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

Class DescribeFleetMetricResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.iot.model.IotResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

metricName

queryString

aggregationType

period

aggregationField

description

queryVersion

indexName

creationDate

lastModifiedDate

unit

unitAsString

version

metricArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields