java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.codeguruprofiler.model.CodeGuruProfilerRequest
    - - software.amazon.awssdk.services.codeguruprofiler.model.BatchGetFrameMetricDataRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<BatchGetFrameMetricDataRequest.Builder,BatchGetFrameMetricDataRequest>

@Generated("software.amazon.awssdk:codegen")
public final class BatchGetFrameMetricDataRequest
extends CodeGuruProfilerRequest
implements ToCopyableBuilder<BatchGetFrameMetricDataRequest.Builder,BatchGetFrameMetricDataRequest>

The structure representing the BatchGetFrameMetricDataRequest.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface BatchGetFrameMetricDataRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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)`
`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)`
`boolean`	`hasFrameMetrics()`	For responses, this returns true if the service returned a value for the FrameMetrics property.
`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()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - endTime
```
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.
    
    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 the isEmpty() 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
```
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.
    
    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
```
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).
    
    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 or P1D).
  - profilingGroupName
```
public final String 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
```
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.
    
    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
```
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().
    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:
    
    AggregationPeriod
  - targetResolutionAsString
```
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().
    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:
    
    AggregationPeriod
  - toBuilder
```
public BatchGetFrameMetricDataRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<BatchGetFrameMetricDataRequest.Builder,BatchGetFrameMetricDataRequest>
    
    Specified by:
    
    toBuilder in class CodeGuruProfilerRequest
  - builder
```
public static BatchGetFrameMetricDataRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends BatchGetFrameMetricDataRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class BatchGetFrameMetricDataRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

endTime

hasFrameMetrics

frameMetrics

period

profilingGroupName

startTime

targetResolution

targetResolutionAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields