Interface GetTraceSummariesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetTraceSummariesRequest.Builder,GetTraceSummariesRequest>, SdkBuilder<GetTraceSummariesRequest.Builder,GetTraceSummariesRequest>, SdkPojo, SdkRequest.Builder, XRayRequest.Builder
Enclosing class:
GetTraceSummariesRequest
public static interface GetTraceSummariesRequest.Builder extends XRayRequest.Builder, SdkPojo, CopyableBuilder<GetTraceSummariesRequest.Builder,GetTraceSummariesRequest>

  • Method Details

    • startTime

      GetTraceSummariesRequest.Builder startTime(Instant startTime)

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

      Parameters:
      startTime - The start of the time frame for which to retrieve traces.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      GetTraceSummariesRequest.Builder endTime(Instant endTime)

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

      Parameters:
      endTime - The end of the time frame for which to retrieve traces.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeRangeType

      GetTraceSummariesRequest.Builder timeRangeType(String timeRangeType)

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

      Parameters:
      timeRangeType - A parameter to indicate whether to query trace summaries by TraceId, Event (trace update time), or Service (segment end time).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timeRangeType

      GetTraceSummariesRequest.Builder timeRangeType(TimeRangeType timeRangeType)

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

      Parameters:
      timeRangeType - A parameter to indicate whether to query trace summaries by TraceId, Event (trace update time), or Service (segment end time).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sampling

      GetTraceSummariesRequest.Builder sampling(Boolean sampling)

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

      Parameters:
      sampling - Set to true to get summaries for only a subset of available traces.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • samplingStrategy

      GetTraceSummariesRequest.Builder samplingStrategy(SamplingStrategy samplingStrategy)

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

      Parameters:
      samplingStrategy - A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • samplingStrategy

      default GetTraceSummariesRequest.Builder samplingStrategy(Consumer<SamplingStrategy.Builder> samplingStrategy)

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

      This is a convenience method that creates an instance of the SamplingStrategy.Builder avoiding the need to create one manually via SamplingStrategy.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to samplingStrategy(SamplingStrategy).

      Parameters:
      samplingStrategy - a consumer that will call methods on SamplingStrategy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • filterExpression

      GetTraceSummariesRequest.Builder filterExpression(String filterExpression)

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

      Parameters:
      filterExpression - Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      GetTraceSummariesRequest.Builder nextToken(String nextToken)

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

      Parameters:
      nextToken - Specify the pagination token returned by a previous request to retrieve the next page of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetTraceSummariesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetTraceSummariesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.