software.amazon.awssdk.services.ec2.model

Class DataQuery

java.lang.Object

software.amazon.awssdk.services.ec2.model.DataQuery

All Implemented Interfaces:

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

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

A query used for retrieving network health data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DataQuery.Builder

Method Summary

Modifier and Type	Method and Description
static DataQuery.Builder	builder()
String	destination() The Region or Availability Zone that's the target for the data query.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() A user-defined ID associated with a data query that's returned in the dataResponse identifying the query.
MetricType	metric() The aggregation metric used for the data query.
String	metricAsString() The aggregation metric used for the data query.
PeriodType	period() The aggregation period used for the data query.
String	periodAsString() The aggregation period used for the data query.
List<SdkField<?>>	sdkFields()
static Class<? extends DataQuery.Builder>	serializableBuilderClass()
String	source() The Region or Availability Zone that's the source for the data query.
StatisticType	statistic() Metric data aggregations over specified periods of time.
String	statisticAsString() Metric data aggregations over specified periods of time.
DataQuery.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

id

public final String id()

A user-defined ID associated with a data query that's returned in the dataResponse identifying the query. For example, if you set the Id to MyQuery01in the query, the dataResponse identifies the query as MyQuery01.

Returns:

A user-defined ID associated with a data query that's returned in the dataResponse identifying the query. For example, if you set the Id to MyQuery01in the query, the dataResponse identifies the query as MyQuery01.

source

public final String source()

The Region or Availability Zone that's the source for the data query. For example, us-east-1.

Returns:

The Region or Availability Zone that's the source for the data query. For example, us-east-1 .

destination

public final String destination()

The Region or Availability Zone that's the target for the data query. For example, eu-north-1.

Returns:

The Region or Availability Zone that's the target for the data query. For example, eu-north-1.

metric

public final MetricType metric()

The aggregation metric used for the data query. Currently only aggregation-latency is supported, indicating network latency.

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

Returns:

The aggregation metric used for the data query. Currently only aggregation-latency is supported, indicating network latency.

See Also:

MetricType

metricAsString

public final String metricAsString()

The aggregation metric used for the data query. Currently only aggregation-latency is supported, indicating network latency.

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

Returns:

The aggregation metric used for the data query. Currently only aggregation-latency is supported, indicating network latency.

See Also:

MetricType

statistic

public final StatisticType statistic()

Metric data aggregations over specified periods of time. The following are the supported Infrastructure Performance statistics:

• p50 - The median value of the metric aggregated over a specified start and end time. For example, a metric of five_minutes is the median of all the data points gathered within those five minutes.

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

Returns:

Metric data aggregations over specified periods of time. The following are the supported Infrastructure Performance statistics:

• p50 - The median value of the metric aggregated over a specified start and end time. For example, a metric of five_minutes is the median of all the data points gathered within those five minutes.

See Also:

StatisticType

statisticAsString

public final String statisticAsString()

Metric data aggregations over specified periods of time. The following are the supported Infrastructure Performance statistics:

• p50 - The median value of the metric aggregated over a specified start and end time. For example, a metric of five_minutes is the median of all the data points gathered within those five minutes.

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

Returns:

Metric data aggregations over specified periods of time. The following are the supported Infrastructure Performance statistics:

• p50 - The median value of the metric aggregated over a specified start and end time. For example, a metric of five_minutes is the median of all the data points gathered within those five minutes.

See Also:

StatisticType

period

public final PeriodType period()

The aggregation period used for the data query.

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

Returns:

The aggregation period used for the data query.

See Also:

PeriodType

periodAsString

public final String periodAsString()

The aggregation period used for the data query.

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

Returns:

The aggregation period used for the data query.

See Also:

PeriodType

toBuilder

public DataQuery.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DataQuery.Builder,DataQuery>

builder

public static DataQuery.Builder builder()

serializableBuilderClass

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