Class GetTraceSummariesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.xray.model.XRayRequest
software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetTraceSummariesRequest.Builder,GetTraceSummariesRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetTraceSummariesRequest extends XRayRequest implements ToCopyableBuilder<GetTraceSummariesRequest.Builder,GetTraceSummariesRequest>

  • Method Details

    • startTime

      public final Instant startTime()

      The start of the time frame for which to retrieve traces.

      Returns:
      The start of the time frame for which to retrieve traces.

    • endTime

      public final Instant endTime()

      The end of the time frame for which to retrieve traces.

      Returns:
      The end of the time frame for which to retrieve traces.

    • timeRangeType

      public final TimeRangeType timeRangeType()

      A parameter to indicate whether to query trace summaries by TraceId, Event (trace update time), or Service (segment end time).

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

      Returns:
      A parameter to indicate whether to query trace summaries by TraceId, Event (trace update time), or Service (segment end time).
      See Also:

    • timeRangeTypeAsString

      public final String timeRangeTypeAsString()

      A parameter to indicate whether to query trace summaries by TraceId, Event (trace update time), or Service (segment end time).

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

      Returns:
      A parameter to indicate whether to query trace summaries by TraceId, Event (trace update time), or Service (segment end time).
      See Also:

    • sampling

      public final Boolean sampling()

      Set to true to get summaries for only a subset of available traces.

      Returns:
      Set to true to get summaries for only a subset of available traces.

    • samplingStrategy

      public final SamplingStrategy samplingStrategy()

      A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.

      Returns:
      A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.

    • filterExpression

      public final String filterExpression()

      Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.

      Returns:
      Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.

    • nextToken

      public final String nextToken()

      Specify the pagination token returned by a previous request to retrieve the next page of results.

      Returns:
      Specify the pagination token returned by a previous request to retrieve the next page of results.

    • toBuilder

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

    • builder

      public static GetTraceSummariesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetTraceSummariesRequest.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.