Class DataResponse
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.DataResponse
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<DataResponse.Builder,DataResponse>
@Generated("software.amazon.awssdk:codegen") public final class DataResponse extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DataResponse.Builder,DataResponse>
The response to a
DataQuery.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDataResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DataResponse.Builderbuilder()Stringdestination()The Region or Availability Zone that's the destination for the data query.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasMetricPoints()For responses, this returns true if the service returned a value for the MetricPoints property.Stringid()The ID passed in theDataQuery.MetricTypemetric()The metric used for the network performance request.StringmetricAsString()The metric used for the network performance request.List<MetricPoint>metricPoints()A list ofMetricPointobjects.PeriodTypeperiod()The period used for the network performance request.StringperiodAsString()The period used for the network performance request.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends DataResponse.Builder>serializableBuilderClass()Stringsource()The Region or Availability Zone that's the source for the data query.StatisticTypestatistic()The statistic used for the network performance request.StringstatisticAsString()The statistic used for the network performance request.DataResponse.BuildertoBuilder()StringtoString()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()
The ID passed in the
DataQuery.- Returns:
- The ID passed in the
DataQuery.
-
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 destination for the data query. For example,
eu-west-1.- Returns:
- The Region or Availability Zone that's the destination for the data query. For example,
eu-west-1.
-
metric
public final MetricType metric()
The metric used for the network performance request.
If the service returns an enum value that is not available in the current SDK version,
metricwill returnMetricType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommetricAsString().- Returns:
- The metric used for the network performance request.
- See Also:
MetricType
-
metricAsString
public final String metricAsString()
The metric used for the network performance request.
If the service returns an enum value that is not available in the current SDK version,
metricwill returnMetricType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommetricAsString().- Returns:
- The metric used for the network performance request.
- See Also:
MetricType
-
statistic
public final StatisticType statistic()
The statistic used for the network performance request.
If the service returns an enum value that is not available in the current SDK version,
statisticwill returnStatisticType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatisticAsString().- Returns:
- The statistic used for the network performance request.
- See Also:
StatisticType
-
statisticAsString
public final String statisticAsString()
The statistic used for the network performance request.
If the service returns an enum value that is not available in the current SDK version,
statisticwill returnStatisticType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatisticAsString().- Returns:
- The statistic used for the network performance request.
- See Also:
StatisticType
-
period
public final PeriodType period()
The period used for the network performance request.
If the service returns an enum value that is not available in the current SDK version,
periodwill returnPeriodType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromperiodAsString().- Returns:
- The period used for the network performance request.
- See Also:
PeriodType
-
periodAsString
public final String periodAsString()
The period used for the network performance request.
If the service returns an enum value that is not available in the current SDK version,
periodwill returnPeriodType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromperiodAsString().- Returns:
- The period used for the network performance request.
- See Also:
PeriodType
-
hasMetricPoints
public final boolean hasMetricPoints()
For responses, this returns true if the service returned a value for the MetricPoints property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
metricPoints
public final List<MetricPoint> metricPoints()
A list of
MetricPointobjects.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
hasMetricPoints()method.- Returns:
- A list of
MetricPointobjects.
-
toBuilder
public DataResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DataResponse.Builder,DataResponse>
-
builder
public static DataResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends DataResponse.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-