Package software.amazon.awssdk.services.iotwireless.model

Class SummaryMetricQuery

java.lang.Object

software.amazon.awssdk.services.iotwireless.model.SummaryMetricQuery

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SummaryMetricQuery.Builder,SummaryMetricQuery>

@Generated("software.amazon.awssdk:codegen")
public final class SummaryMetricQuery
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SummaryMetricQuery.Builder,SummaryMetricQuery>

The metric query object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SummaryMetricQuery.Builder

Method Summary

Modifier and Type	Method	Description
AggregationPeriod	aggregationPeriod()	The aggregation period of the metric.
String	aggregationPeriodAsString()	The aggregation period of the metric.
static SummaryMetricQuery.Builder	builder()
List<Dimension>	dimensions()	The dimensions of the metric.
Instant	endTimestamp()	The end timestamp for summary metric query.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDimensions()	For responses, this returns true if the service returned a value for the Dimensions property.
int	hashCode()
MetricName	metricName()	The name of the metric.
String	metricNameAsString()	The name of the metric.
String	queryId()	The id of the query.
List<SdkField<?>>	sdkFields()
static Class<? extends SummaryMetricQuery.Builder>	serializableBuilderClass()
Instant	startTimestamp()	The start timestamp for summary metric query.
SummaryMetricQuery.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

queryId

public final String queryId()

The id of the query.

Returns:

The id of the query.

metricName

public final MetricName metricName()

The name of the metric.

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

Returns:

The name of the metric.

See Also:

MetricName

metricNameAsString

public final String metricNameAsString()

The name of the metric.

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

Returns:

The name of the metric.

See Also:

MetricName

hasDimensions

public final boolean hasDimensions()

For responses, this returns true if the service returned a value for the Dimensions 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.

dimensions

public final List<Dimension> dimensions()

The dimensions of the metric.

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

Returns:

The dimensions of the metric.

aggregationPeriod

public final AggregationPeriod aggregationPeriod()

The aggregation period of the metric.

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

Returns:

The aggregation period of the metric.

See Also:

AggregationPeriod

aggregationPeriodAsString

public final String aggregationPeriodAsString()

The aggregation period of the metric.

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

Returns:

The aggregation period of the metric.

See Also:

AggregationPeriod

startTimestamp

public final Instant startTimestamp()

The start timestamp for summary metric query.

Returns:

The start timestamp for summary metric query.

endTimestamp

public final Instant endTimestamp()

The end timestamp for summary metric query.

Returns:

The end timestamp for summary metric query.

toBuilder

public SummaryMetricQuery.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SummaryMetricQuery.Builder,SummaryMetricQuery>

builder

public static SummaryMetricQuery.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo