Class ListProfileTimesRequest

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.ListProfileTimesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListProfileTimesRequest.Builder,ListProfileTimesRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListProfileTimesRequest extends CodeGuruProfilerRequest implements ToCopyableBuilder<ListProfileTimesRequest.Builder,ListProfileTimesRequest>

The structure representing the listProfileTimesRequest.

  • Method Details

    • endTime

      public final Instant 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

      public final 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.

      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.

    • nextToken

      public final 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.

      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.

    • orderBy

      public final OrderBy 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 return OrderBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderByAsString().

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

    • orderByAsString

      public final String 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 return OrderBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderByAsString().

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

    • period

      public final 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

      If the service returns an enum value that is not available in the current SDK version, period will return AggregationPeriod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from periodAsString().

      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

      public final String 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 return AggregationPeriod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from periodAsString().

      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

      public final String profilingGroupName()

      The name of the profiling group.

      Returns:
      The name of the profiling group.

    • startTime

      public final Instant 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

      public ListProfileTimesRequest.Builder 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 interface ToCopyableBuilder<ListProfileTimesRequest.Builder,ListProfileTimesRequest>
      Specified by:
      toBuilder in class CodeGuruProfilerRequest
      Returns:
      a builder for type T

    • builder

      public static ListProfileTimesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListProfileTimesRequest.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.