Class DataQuery
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.DataQuery
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DataQuery.Builder,DataQuery>
@Generated("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 Description static interface
DataQuery.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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 thedataResponse
identifying the query.MetricType
metric()
The metric,aggregation-latency
, indicating that network latency is aggregated for the query.String
metricAsString()
The metric,aggregation-latency
, indicating that network latency is aggregated for the 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()
The metric data aggregation period,p50
, between the specifiedstartDate
andendDate
.String
statisticAsString()
The metric data aggregation period,p50
, between the specifiedstartDate
andendDate
.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 toMyQuery01
in the query, thedataResponse
identifies the query asMyQuery01
.- 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 toMyQuery01
in the query, thedataResponse
identifies the query asMyQuery01
.
-
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 metric,
aggregation-latency
, indicating that network latency is aggregated for the query. This is the only supported metric.If the service returns an enum value that is not available in the current SDK version,
metric
will returnMetricType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricAsString()
.- Returns:
- The metric,
aggregation-latency
, indicating that network latency is aggregated for the query. This is the only supported metric. - See Also:
MetricType
-
metricAsString
public final String metricAsString()
The metric,
aggregation-latency
, indicating that network latency is aggregated for the query. This is the only supported metric.If the service returns an enum value that is not available in the current SDK version,
metric
will returnMetricType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricAsString()
.- Returns:
- The metric,
aggregation-latency
, indicating that network latency is aggregated for the query. This is the only supported metric. - See Also:
MetricType
-
statistic
public final StatisticType statistic()
The metric data aggregation period,
p50
, between the specifiedstartDate
andendDate
. For example, a metric offive_minutes
is the median of all the data points gathered within those five minutes.p50
is the only supported metric.If the service returns an enum value that is not available in the current SDK version,
statistic
will returnStatisticType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatisticAsString()
.- Returns:
- The metric data aggregation period,
p50
, between the specifiedstartDate
andendDate
. For example, a metric offive_minutes
is the median of all the data points gathered within those five minutes.p50
is the only supported metric. - See Also:
StatisticType
-
statisticAsString
public final String statisticAsString()
The metric data aggregation period,
p50
, between the specifiedstartDate
andendDate
. For example, a metric offive_minutes
is the median of all the data points gathered within those five minutes.p50
is the only supported metric.If the service returns an enum value that is not available in the current SDK version,
statistic
will returnStatisticType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatisticAsString()
.- Returns:
- The metric data aggregation period,
p50
, between the specifiedstartDate
andendDate
. For example, a metric offive_minutes
is the median of all the data points gathered within those five minutes.p50
is the only supported metric. - 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 returnPeriodType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromperiodAsString()
.- 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 returnPeriodType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromperiodAsString()
.- Returns:
- The aggregation period used for the data query.
- See Also:
PeriodType
-
toBuilder
public DataQuery.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DataQuery.Builder,DataQuery>
-
builder
public static DataQuery.Builder builder()
-
serializableBuilderClass
public static Class<? extends DataQuery.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-