com.amazonaws.services.codeguruprofiler.model

Class BatchGetFrameMetricDataRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codeguruprofiler.model.BatchGetFrameMetricDataRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchGetFrameMetricDataRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

The structure representing the BatchGetFrameMetricDataRequest.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
BatchGetFrameMetricDataRequest()

Method Summary

Modifier and Type	Method and Description
BatchGetFrameMetricDataRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Date	getEndTime() The end time of the time period for the returned time series values.
List<FrameMetric>	getFrameMetrics() The details of the metrics that are used to request a time series of values.
String	getPeriod() The duration of the frame metrics used to return the time series values.
String	getProfilingGroupName() The name of the profiling group associated with the the frame metrics used to return the time series values.
Date	getStartTime() The start time of the time period for the frame metrics used to return the time series values.
String	getTargetResolution() The requested resolution of time steps for the returned time series of values.
int	hashCode()
void	setEndTime(Date endTime) The end time of the time period for the returned time series values.
void	setFrameMetrics(Collection<FrameMetric> frameMetrics) The details of the metrics that are used to request a time series of values.
void	setPeriod(String period) The duration of the frame metrics used to return the time series values.
void	setProfilingGroupName(String profilingGroupName) The name of the profiling group associated with the the frame metrics used to return the time series values.
void	setStartTime(Date startTime) The start time of the time period for the frame metrics used to return the time series values.
void	setTargetResolution(String targetResolution) The requested resolution of time steps for the returned time series of values.
String	toString() Returns a string representation of this object.
BatchGetFrameMetricDataRequest	withEndTime(Date endTime) The end time of the time period for the returned time series values.
BatchGetFrameMetricDataRequest	withFrameMetrics(Collection<FrameMetric> frameMetrics) The details of the metrics that are used to request a time series of values.
BatchGetFrameMetricDataRequest	withFrameMetrics(FrameMetric... frameMetrics) The details of the metrics that are used to request a time series of values.
BatchGetFrameMetricDataRequest	withPeriod(String period) The duration of the frame metrics used to return the time series values.
BatchGetFrameMetricDataRequest	withProfilingGroupName(String profilingGroupName) The name of the profiling group associated with the the frame metrics used to return the time series values.
BatchGetFrameMetricDataRequest	withStartTime(Date startTime) The start time of the time period for the frame metrics used to return the time series values.
BatchGetFrameMetricDataRequest	withTargetResolution(AggregationPeriod targetResolution) The requested resolution of time steps for the returned time series of values.
BatchGetFrameMetricDataRequest	withTargetResolution(String targetResolution) The requested resolution of time steps for the returned time series of values.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BatchGetFrameMetricDataRequest

public BatchGetFrameMetricDataRequest()

Method Detail

setEndTime

public void setEndTime(Date 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.

Parameters:

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.

getEndTime

public Date getEndTime()

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.

withEndTime

public BatchGetFrameMetricDataRequest withEndTime(Date 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getFrameMetrics

public List<FrameMetric> getFrameMetrics()

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.

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.

setFrameMetrics

public void setFrameMetrics(Collection<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.

Parameters:

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.

withFrameMetrics

public BatchGetFrameMetricDataRequest withFrameMetrics(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.

NOTE: This method appends the values to the existing list (if any). Use setFrameMetrics(java.util.Collection) or withFrameMetrics(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withFrameMetrics

public BatchGetFrameMetricDataRequest withFrameMetrics(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPeriod

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

Parameters:

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

getPeriod

public String getPeriod()

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

withPeriod

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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setProfilingGroupName

public void setProfilingGroupName(String profilingGroupName)

The name of the profiling group associated with the the frame metrics used to return the time series values.

Parameters:

profilingGroupName - The name of the profiling group associated with the the frame metrics used to return the time series values.

getProfilingGroupName

public String getProfilingGroupName()

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.

withProfilingGroupName

public BatchGetFrameMetricDataRequest withProfilingGroupName(String profilingGroupName)

The name of the profiling group associated with the the frame metrics used to return the time series values.

Parameters:

profilingGroupName - The name of the profiling group associated with the the frame metrics used to return the time series values.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStartTime

public void setStartTime(Date 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.

Parameters:

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.

getStartTime

public Date getStartTime()

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.

withStartTime

public BatchGetFrameMetricDataRequest withStartTime(Date 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setTargetResolution

public void setTargetResolution(String 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

Parameters:

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

See Also:

AggregationPeriod

getTargetResolution

public String getTargetResolution()

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

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

withTargetResolution

public BatchGetFrameMetricDataRequest withTargetResolution(String 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AggregationPeriod

withTargetResolution

public BatchGetFrameMetricDataRequest withTargetResolution(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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AggregationPeriod

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public BatchGetFrameMetricDataRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()