@Generated(value="software.amazon.awssdk:codegen") public final class BatchGetFrameMetricDataResponse extends CodeGuruProfilerResponse implements ToCopyableBuilder<BatchGetFrameMetricDataResponse.Builder,BatchGetFrameMetricDataResponse>
The structure representing the BatchGetFrameMetricDataResponse.
Modifier and Type | Class and Description |
---|---|
static interface |
BatchGetFrameMetricDataResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static BatchGetFrameMetricDataResponse.Builder |
builder() |
Instant |
endTime()
The end time of the time period for the returned time series values.
|
List<TimestampStructure> |
endTimes()
List of instances, or time steps, in the time series.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
List<FrameMetricDatum> |
frameMetricData()
Details of the metrics to request a time series of values.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
boolean |
hasEndTimes()
Returns true if the EndTimes property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasFrameMetricData()
Returns true if the FrameMetricData property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasUnprocessedEndTimes()
Returns true if the UnprocessedEndTimes property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
AggregationPeriod |
resolution()
Resolution or granularity of the profile data used to generate the time series.
|
String |
resolutionAsString()
Resolution or granularity of the profile data used to generate the time series.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends BatchGetFrameMetricDataResponse.Builder> |
serializableBuilderClass() |
Instant |
startTime()
The start time of the time period for the returned time series values.
|
BatchGetFrameMetricDataResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
Map<String,List<TimestampStructure>> |
unprocessedEndTimes()
List of instances which remained unprocessed.
|
responseMetadata
sdkHttpResponse
copy
public final Instant endTime()
The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
public final boolean hasEndTimes()
public final List<TimestampStructure> endTimes()
List of instances, or time steps, in the time series. For example, if the period
is one day (
PT24H)
), and the resolution
is five minutes (PT5M
), then there are 288
endTimes
in the list that are each five minutes appart.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasEndTimes()
to see if a value was sent in this field.
period
is one day
(PT24H)
), and the resolution
is five minutes (PT5M
), then there
are 288 endTimes
in the list that are each five minutes appart.public final boolean hasFrameMetricData()
public final List<FrameMetricDatum> frameMetricData()
Details of the metrics to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasFrameMetricData()
to see if a value was sent in this field.
public final AggregationPeriod resolution()
Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values.
P1D
— 1 day
PT1H
— 1 hour
PT5M
— 5 minutes
If the service returns an enum value that is not available in the current SDK version, resolution
will
return AggregationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
resolutionAsString()
.
P1D
— 1 day
PT1H
— 1 hour
PT5M
— 5 minutes
AggregationPeriod
public final String resolutionAsString()
Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values.
P1D
— 1 day
PT1H
— 1 hour
PT5M
— 5 minutes
If the service returns an enum value that is not available in the current SDK version, resolution
will
return AggregationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
resolutionAsString()
.
P1D
— 1 day
PT1H
— 1 hour
PT5M
— 5 minutes
AggregationPeriod
public final Instant startTime()
The start time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
public final boolean hasUnprocessedEndTimes()
public final Map<String,List<TimestampStructure>> unprocessedEndTimes()
List of instances which remained unprocessed. This will create a missing time step in the list of end times.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasUnprocessedEndTimes()
to see if a value was sent in this field.
public BatchGetFrameMetricDataResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<BatchGetFrameMetricDataResponse.Builder,BatchGetFrameMetricDataResponse>
toBuilder
in class AwsResponse
public static BatchGetFrameMetricDataResponse.Builder builder()
public static Class<? extends BatchGetFrameMetricDataResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.