software.amazon.awssdk.services.codeguruprofiler.model

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(value="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 and Description
static interface	GetProfileRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	accept() The format of the returned profiling data.
static GetProfileRequest.Builder	builder()
Instant	endTime() The end time of the requested profile.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxDepth() The maximum depth of the stacks in the code that is represented in the aggregated profile.
String	period() Used with startTime or endTime to specify the time range for the returned aggregated profile.
String	profilingGroupName() The name of the profiling group to get.
List<SdkField<?>>	sdkFields()
static Class<? extends GetProfileRequest.Builder>	serializableBuilderClass()
Instant	startTime() The start time of the profile to get.
GetProfileRequest.Builder	toBuilder()
String	toString() 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 Accept and Content-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 and Content-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

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 specify period or startTime, 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 specify period or startTime, 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 method B, which calls method C, which calls method D, then the depth is 4. If the maxDepth is set to 2, then the aggregated profile contains representations of methods A and B.

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 method B, which calls method C, which calls method D, then the depth is 4. If the maxDepth is set to 2, then the aggregated profile contains representations of methods A and B.

period

public final String period()

Used with startTime or endTime 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 or endTime 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

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:

toBuilder in interface ToCopyableBuilder<GetProfileRequest.Builder,GetProfileRequest>

Specified by:

toBuilder in class CodeGuruProfilerRequest

builder

public static GetProfileRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetProfileRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo