Class BatchGetFrameMetricDataRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<BatchGetFrameMetricDataRequest.Builder,
BatchGetFrameMetricDataRequest>
The structure representing the BatchGetFrameMetricDataRequest.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
endTime()
The end time of the time period for the returned time series values.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<FrameMetric> The details of the metrics that are used to request a time series of values.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the FrameMetrics property.final int
hashCode()
final String
period()
The duration of the frame metrics used to return the time series values.final String
The name of the profiling group associated with the the frame metrics used to return the time series values.static Class
<? extends BatchGetFrameMetricDataRequest.Builder> final Instant
The start time of the time period for the frame metrics used to return the time series values.final AggregationPeriod
The requested resolution of time steps for the returned time series of values.final String
The requested resolution of time steps for the returned time series of values.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
- Returns:
- 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.
-
hasFrameMetrics
public final boolean hasFrameMetrics()For responses, this returns true if the service returned a value for the FrameMetrics 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. -
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.
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
hasFrameMetrics()
method.- Returns:
- 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.
-
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
orP1D
).- Returns:
- 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
orP1D
).
-
profilingGroupName
The name of the profiling group associated with the the frame metrics used to return the time series values.
- Returns:
- The name of the profiling group associated with the the frame metrics used to return the time series values.
-
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.
- Returns:
- 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.
-
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 returnAggregationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetResolutionAsString()
.- Returns:
- 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
-
- See Also:
-
-
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 returnAggregationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetResolutionAsString()
.- Returns:
- 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
-
- See Also:
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<BatchGetFrameMetricDataRequest.Builder,
BatchGetFrameMetricDataRequest> - Specified by:
toBuilder
in classCodeGuruProfilerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-