Class GetProfileRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.codeguruprofiler.model.CodeGuruProfilerRequest
-
- software.amazon.awssdk.services.codeguruprofiler.model.GetProfileRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetProfileRequest.Builder,GetProfileRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetProfileRequest extends CodeGuruProfilerRequest implements ToCopyableBuilder<GetProfileRequest.Builder,GetProfileRequest>
The structure representing the getProfileRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetProfileRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringaccept()The format of the returned profiling data.static GetProfileRequest.Builderbuilder()InstantendTime()The end time of the requested profile.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()IntegermaxDepth()The maximum depth of the stacks in the code that is represented in the aggregated profile.Stringperiod()Used withstartTimeorendTimeto specify the time range for the returned aggregated profile.StringprofilingGroupName()The name of the profiling group to get.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends GetProfileRequest.Builder>serializableBuilderClass()InstantstartTime()The start time of the profile to get.GetProfileRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
accept
public final String accept()
The format of the returned profiling data. The format maps to the
AcceptandContent-Typeheaders 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
AcceptandContent-Typeheaders 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
public final Instant 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 specifyperiodorstartTime, 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 specifyperiodorstartTime, but not both.
-
maxDepth
public final Integer 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 themaxDepthis set to 2, then the aggregated profile contains representations of methodsAandB.- 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 themaxDepthis set to 2, then the aggregated profile contains representations of methodsAandB.
-
period
public final String period()
Used with
startTimeorendTimeto 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
startTimeorendTimeto 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
public final String profilingGroupName()
The name of the profiling group to get.
- Returns:
- The name of the profiling group to get.
-
startTime
public final Instant 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
public GetProfileRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetProfileRequest.Builder,GetProfileRequest>- Specified by:
toBuilderin classCodeGuruProfilerRequest
-
builder
public static GetProfileRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetProfileRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-