Class GetProfileRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetProfileRequest.Builder,
GetProfileRequest>
The structure representing the getProfileRequest.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
accept()
The format of the returned profiling data.static GetProfileRequest.Builder
builder()
final Instant
endTime()
The end time of the requested profile.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
maxDepth()
The maximum depth of the stacks in the code that is represented in the aggregated profile.final String
period()
Used withstartTime
orendTime
to specify the time range for the returned aggregated profile.final String
The name of the profiling group to get.static Class
<? extends GetProfileRequest.Builder> final Instant
The start time of the profile to get.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
-
accept
The format of the returned profiling data. The format maps to the
Accept
andContent-Type
headers of the HTTP request. You can specify one of the following: or the default .<ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
- Returns:
- The format of the returned profiling data. The format maps to the
Accept
andContent-Type
headers of the HTTP request. You can specify one of the following: or the default .<ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
-
endTime
The end time of the requested profile. Specify 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.
If you specify
endTime
, then you must also specifyperiod
orstartTime
, but not both.- Returns:
- The end time of the requested profile. Specify 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.
If you specify
endTime
, then you must also specifyperiod
orstartTime
, but not both.
-
maxDepth
The maximum depth of the stacks in the code that is represented in the aggregated profile. For example, if CodeGuru Profiler finds a method
A
, which calls methodB
, which calls methodC
, which calls methodD
, then the depth is 4. If themaxDepth
is set to 2, then the aggregated profile contains representations of methodsA
andB
.- Returns:
- The maximum depth of the stacks in the code that is represented in the aggregated profile. For example,
if CodeGuru Profiler finds a method
A
, which calls methodB
, which calls methodC
, which calls methodD
, then the depth is 4. If themaxDepth
is set to 2, then the aggregated profile contains representations of methodsA
andB
.
-
period
Used with
startTime
orendTime
to specify the time range for the returned aggregated profile. Specify using the ISO 8601 format. For example,P1DT1H1M1S
.<p> To get the latest aggregated profile, specify only <code>period</code>. </p>
- Returns:
- Used with
startTime
orendTime
to specify the time range for the returned aggregated profile. Specify using the ISO 8601 format. For example,P1DT1H1M1S
.<p> To get the latest aggregated profile, specify only <code>period</code>. </p>
-
profilingGroupName
The name of the profiling group to get.
- Returns:
- The name of the profiling group to get.
-
startTime
The start time of the profile to get. Specify 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.
<p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p>
- Returns:
- The start time of the profile to get. Specify 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.
<p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p>
-
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<GetProfileRequest.Builder,
GetProfileRequest> - 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
-