Class ListProfileTimesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListProfileTimesRequest.Builder,
ListProfileTimesRequest>
The structure representing the listProfileTimesRequest.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
endTime()
The end time of the time range from which to list the profiles.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
The maximum number of profile time results returned byListProfileTimes
in paginated output.final String
ThenextToken
value returned from a previous paginatedListProfileTimes
request wheremaxResults
was used and the results exceeded the value of that parameter.final OrderBy
orderBy()
The order (ascending or descending by start time of the profile) to use when listing profiles.final String
The order (ascending or descending by start time of the profile) to use when listing profiles.final AggregationPeriod
period()
The aggregation period.final String
The aggregation period.final String
The name of the profiling group.static Class
<? extends ListProfileTimesRequest.Builder> final Instant
The start time of the time range from which to list the profiles.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 range from which to list the profiles.
- Returns:
- The end time of the time range from which to list the profiles.
-
maxResults
The maximum number of profile time results returned by
ListProfileTimes
in paginated output. When this parameter is used,ListProfileTimes
only returnsmaxResults
results in a single page with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListProfileTimes
request with the returnednextToken
value.- Returns:
- The maximum number of profile time results returned by
ListProfileTimes
in paginated output. When this parameter is used,ListProfileTimes
only returnsmaxResults
results in a single page with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListProfileTimes
request with the returnednextToken
value.
-
nextToken
The
nextToken
value returned from a previous paginatedListProfileTimes
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
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 paginatedListProfileTimes
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
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.
-
orderBy
The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to
TIMESTAMP_DESCENDING
.If the service returns an enum value that is not available in the current SDK version,
orderBy
will returnOrderBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromorderByAsString()
.- Returns:
- The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults
to
TIMESTAMP_DESCENDING
. - See Also:
-
orderByAsString
The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to
TIMESTAMP_DESCENDING
.If the service returns an enum value that is not available in the current SDK version,
orderBy
will returnOrderBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromorderByAsString()
.- Returns:
- The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults
to
TIMESTAMP_DESCENDING
. - See Also:
-
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
If the service returns an enum value that is not available in the current SDK version,
period
will returnAggregationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromperiodAsString()
.- 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:
-
-
periodAsString
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
If the service returns an enum value that is not available in the current SDK version,
period
will returnAggregationPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromperiodAsString()
.- 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:
-
-
profilingGroupName
The name of the profiling group.
- Returns:
- The name of the profiling group.
-
startTime
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.
-
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<ListProfileTimesRequest.Builder,
ListProfileTimesRequest> - 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
-