com.amazonaws.services.codeguruprofiler.model

Class ListProfileTimesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codeguruprofiler.model.ListProfileTimesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

The structure representing the listProfileTimesRequest.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListProfileTimesRequest()

Method Summary

Modifier and Type	Method and Description
ListProfileTimesRequest	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 range from which to list the profiles.
Integer	getMaxResults() The maximum number of profile time results returned by ListProfileTimes in paginated output.
String	getNextToken() The nextToken value returned from a previous paginated ListProfileTimes request where maxResults was used and the results exceeded the value of that parameter.
String	getOrderBy() The order (ascending or descending by start time of the profile) to use when listing profiles.
String	getPeriod() The aggregation period.
String	getProfilingGroupName() The name of the profiling group.
Date	getStartTime() The start time of the time range from which to list the profiles.
int	hashCode()
void	setEndTime(Date endTime) The end time of the time range from which to list the profiles.
void	setMaxResults(Integer maxResults) The maximum number of profile time results returned by ListProfileTimes in paginated output.
void	setNextToken(String nextToken) The nextToken value returned from a previous paginated ListProfileTimes request where maxResults was used and the results exceeded the value of that parameter.
void	setOrderBy(String orderBy) The order (ascending or descending by start time of the profile) to use when listing profiles.
void	setPeriod(String period) The aggregation period.
void	setProfilingGroupName(String profilingGroupName) The name of the profiling group.
void	setStartTime(Date startTime) The start time of the time range from which to list the profiles.
String	toString() Returns a string representation of this object.
ListProfileTimesRequest	withEndTime(Date endTime) The end time of the time range from which to list the profiles.
ListProfileTimesRequest	withMaxResults(Integer maxResults) The maximum number of profile time results returned by ListProfileTimes in paginated output.
ListProfileTimesRequest	withNextToken(String nextToken) The nextToken value returned from a previous paginated ListProfileTimes request where maxResults was used and the results exceeded the value of that parameter.
ListProfileTimesRequest	withOrderBy(OrderBy orderBy) The order (ascending or descending by start time of the profile) to use when listing profiles.
ListProfileTimesRequest	withOrderBy(String orderBy) The order (ascending or descending by start time of the profile) to use when listing profiles.
ListProfileTimesRequest	withPeriod(AggregationPeriod period) The aggregation period.
ListProfileTimesRequest	withPeriod(String period) The aggregation period.
ListProfileTimesRequest	withProfilingGroupName(String profilingGroupName) The name of the profiling group.
ListProfileTimesRequest	withStartTime(Date startTime) The start time of the time range from which to list the profiles.

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

ListProfileTimesRequest

public ListProfileTimesRequest()

Method Detail

setEndTime

public void setEndTime(Date endTime)

The end time of the time range from which to list the profiles.

Parameters:

endTime - The end time of the time range from which to list the profiles.

getEndTime

public Date getEndTime()

The end time of the time range from which to list the profiles.

Returns:

The end time of the time range from which to list the profiles.

withEndTime

public ListProfileTimesRequest withEndTime(Date endTime)

The end time of the time range from which to list the profiles.

Parameters:

endTime - The end time of the time range from which to list the profiles.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of profile time results returned by ListProfileTimes in paginated output. When this parameter is used, ListProfileTimes only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfileTimes request with the returned nextToken value.

Parameters:

maxResults - The maximum number of profile time results returned by ListProfileTimes in paginated output. When this parameter is used, ListProfileTimes only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfileTimes request with the returned nextToken value.

getMaxResults

public Integer getMaxResults()

The maximum number of profile time results returned by ListProfileTimes in paginated output. When this parameter is used, ListProfileTimes only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfileTimes request with the returned nextToken value.

Returns:

The maximum number of profile time results returned by ListProfileTimes in paginated output. When this parameter is used, ListProfileTimes only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfileTimes request with the returned nextToken value.

withMaxResults

public ListProfileTimesRequest withMaxResults(Integer maxResults)

The maximum number of profile time results returned by ListProfileTimes in paginated output. When this parameter is used, ListProfileTimes only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfileTimes request with the returned nextToken value.

Parameters:

maxResults - The maximum number of profile time results returned by ListProfileTimes in paginated output. When this parameter is used, ListProfileTimes only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfileTimes request with the returned nextToken value.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The nextToken value returned from a previous paginated ListProfileTimes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Parameters:

nextToken - The nextToken value returned from a previous paginated ListProfileTimes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

getNextToken

public String getNextToken()

The nextToken value returned from a previous paginated ListProfileTimes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

The nextToken value returned from a previous paginated ListProfileTimes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

withNextToken

public ListProfileTimesRequest withNextToken(String nextToken)

The nextToken value returned from a previous paginated ListProfileTimes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Parameters:

nextToken - The nextToken value returned from a previous paginated ListProfileTimes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

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

setOrderBy

public void setOrderBy(String orderBy)

The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to TIMESTAMP_DESCENDING.

Parameters:

orderBy - The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to TIMESTAMP_DESCENDING.

See Also:

OrderBy

getOrderBy

public String getOrderBy()

The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to TIMESTAMP_DESCENDING.

Returns:

The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to TIMESTAMP_DESCENDING.

See Also:

OrderBy

withOrderBy

public ListProfileTimesRequest withOrderBy(String orderBy)

The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to TIMESTAMP_DESCENDING.

Parameters:

orderBy - The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to TIMESTAMP_DESCENDING.

Returns:

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

See Also:

OrderBy

withOrderBy

public ListProfileTimesRequest withOrderBy(OrderBy orderBy)

The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to TIMESTAMP_DESCENDING.

Parameters:

orderBy - The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to TIMESTAMP_DESCENDING.

Returns:

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

See Also:

OrderBy

setPeriod

public void setPeriod(String period)

The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. There are 3 valid values.

• P1D — 1 day

• PT1H — 1 hour

• PT5M — 5 minutes

Parameters:

period - The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. There are 3 valid values.

• P1D — 1 day

• PT1H — 1 hour

• PT5M — 5 minutes

See Also:

AggregationPeriod

getPeriod

public String getPeriod()

The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. There are 3 valid values.

• P1D — 1 day

• PT1H — 1 hour

• PT5M — 5 minutes

Returns:

The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. There are 3 valid values.

• P1D — 1 day

• PT1H — 1 hour

• PT5M — 5 minutes

See Also:

AggregationPeriod

withPeriod

public ListProfileTimesRequest withPeriod(String period)

The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. There are 3 valid values.

• P1D — 1 day

• PT1H — 1 hour

• PT5M — 5 minutes

Parameters:

period - The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. 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

withPeriod

public ListProfileTimesRequest withPeriod(AggregationPeriod period)

The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. There are 3 valid values.

• P1D — 1 day

• PT1H — 1 hour

• PT5M — 5 minutes

Parameters:

period - The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. 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

setProfilingGroupName

public void setProfilingGroupName(String profilingGroupName)

The name of the profiling group.

Parameters:

profilingGroupName - The name of the profiling group.

getProfilingGroupName

public String getProfilingGroupName()

The name of the profiling group.

Returns:

The name of the profiling group.

withProfilingGroupName

public ListProfileTimesRequest withProfilingGroupName(String profilingGroupName)

The name of the profiling group.

Parameters:

profilingGroupName - The name of the profiling group.

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 range from which to list the profiles.

Parameters:

startTime - The start time of the time range from which to list the profiles.

getStartTime

public Date getStartTime()

The start time of the time range from which to list the profiles.

Returns:

The start time of the time range from which to list the profiles.

withStartTime

public ListProfileTimesRequest withStartTime(Date startTime)

The start time of the time range from which to list the profiles.

Parameters:

startTime - The start time of the time range from which to list the profiles.

Returns:

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

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 ListProfileTimesRequest 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()