@Generated(value="software.amazon.awssdk:codegen") public final class BatchGetFrameMetricDataRequest extends CodeGuruProfilerRequest implements ToCopyableBuilder<BatchGetFrameMetricDataRequest.Builder,BatchGetFrameMetricDataRequest>
The structure representing the BatchGetFrameMetricDataRequest.
Modifier and Type | Class and Description |
---|---|
static interface |
BatchGetFrameMetricDataRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static BatchGetFrameMetricDataRequest.Builder |
builder() |
Instant |
endTime()
The end time of the time period for the returned time series values.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
List<FrameMetric> |
frameMetrics()
The details of the metrics that are used 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
SdkRequest . |
boolean |
hasFrameMetrics()
Returns true if the FrameMetrics 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() |
String |
period()
The duration of the frame metrics used to return the time series values.
|
String |
profilingGroupName()
The name of the profiling group associated with the the frame metrics used to return the time series values.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends BatchGetFrameMetricDataRequest.Builder> |
serializableBuilderClass() |
Instant |
startTime()
The start time of the time period for the frame metrics used to return the time series values.
|
AggregationPeriod |
targetResolution()
The requested resolution of time steps for the returned time series of values.
|
String |
targetResolutionAsString()
The requested resolution of time steps for the returned time series of values.
|
BatchGetFrameMetricDataRequest.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.
|
overrideConfiguration
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 hasFrameMetrics()
public final List<FrameMetric> frameMetrics()
The details of the metrics that are used 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 hasFrameMetrics()
to see if a value was sent in this field.
public final String period()
The duration of the frame metrics used to return the time series values. Specify using the ISO 8601 format. The
maximum period duration is one day (PT24H
or P1D
).
PT24H
or P1D
).public final String profilingGroupName()
The name of the profiling group associated with the the frame metrics used to return the time series values.
public final Instant startTime()
The start time of the time period for the frame metrics used to return the 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 AggregationPeriod targetResolution()
The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. 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, targetResolution
will return AggregationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from targetResolutionAsString()
.
P1D
— 1 day
PT1H
— 1 hour
PT5M
— 5 minutes
AggregationPeriod
public final String targetResolutionAsString()
The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. 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, targetResolution
will return AggregationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from targetResolutionAsString()
.
P1D
— 1 day
PT1H
— 1 hour
PT5M
— 5 minutes
AggregationPeriod
public BatchGetFrameMetricDataRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<BatchGetFrameMetricDataRequest.Builder,BatchGetFrameMetricDataRequest>
toBuilder
in class CodeGuruProfilerRequest
public static BatchGetFrameMetricDataRequest.Builder builder()
public static Class<? extends BatchGetFrameMetricDataRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
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)
SdkRequest
SdkRequest
. 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 SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.