software.amazon.awssdk.services.codeguruprofiler.model

Class BatchGetFrameMetricDataResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.codeguruprofiler.model.CodeGuruProfilerResponse

software.amazon.awssdk.services.codeguruprofiler.model.BatchGetFrameMetricDataResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchGetFrameMetricDataResponse.Builder,BatchGetFrameMetricDataResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class BatchGetFrameMetricDataResponse
extends CodeGuruProfilerResponse
implements ToCopyableBuilder<BatchGetFrameMetricDataResponse.Builder,BatchGetFrameMetricDataResponse>

The structure representing the BatchGetFrameMetricDataResponse.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchGetFrameMetricDataResponse.Builder

Method Summary

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.

Methods inherited from class software.amazon.awssdk.services.codeguruprofiler.model.CodeGuruProfilerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

endTime

public 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.

hasEndTimes

public 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). For responses returned by the SDK, the sender is the AWS service.

endTimes

public 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.

Returns:

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.

hasFrameMetricData

public 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). For responses returned by the SDK, the sender is the AWS service.

frameMetricData

public 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.

Returns:

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.

resolution

public 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().

Returns:

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

See Also:

AggregationPeriod

resolutionAsString

public 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().

Returns:

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

See Also:

AggregationPeriod

startTime

public 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.

Returns:

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.

hasUnprocessedEndTimes

public 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). For responses returned by the SDK, the sender is the AWS service.

unprocessedEndTimes

public 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.

Returns:

List of instances which remained unprocessed. This will create a missing time step in the list of end times.

toBuilder

public BatchGetFrameMetricDataResponse.Builder 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 interface ToCopyableBuilder<BatchGetFrameMetricDataResponse.Builder,BatchGetFrameMetricDataResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static BatchGetFrameMetricDataResponse.Builder builder()

serializableBuilderClass

public static Class<? extends BatchGetFrameMetricDataResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

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 an 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkResponse

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

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.