Interface GetTraceSummariesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetTraceSummariesRequest.Builder,
,GetTraceSummariesRequest> SdkBuilder<GetTraceSummariesRequest.Builder,
,GetTraceSummariesRequest> SdkPojo
,SdkRequest.Builder
,XRayRequest.Builder
- Enclosing class:
GetTraceSummariesRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe end of the time frame for which to retrieve traces.filterExpression
(String filterExpression) Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.Specify the pagination token returned by a previous request to retrieve the next page of results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Set totrue
to get summaries for only a subset of available traces.default GetTraceSummariesRequest.Builder
samplingStrategy
(Consumer<SamplingStrategy.Builder> samplingStrategy) A parameter to indicate whether to enable sampling on trace summaries.samplingStrategy
(SamplingStrategy samplingStrategy) A parameter to indicate whether to enable sampling on trace summaries.The start of the time frame for which to retrieve traces.timeRangeType
(String timeRangeType) Query trace summaries by TraceId (trace start time), Event (trace update time), or Service (trace segment end time).timeRangeType
(TimeRangeType timeRangeType) Query trace summaries by TraceId (trace start time), Event (trace update time), or Service (trace segment end time).Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
Methods inherited from interface software.amazon.awssdk.services.xray.model.XRayRequest.Builder
build
-
Method Details
-
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
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
Query trace summaries by TraceId (trace start time), Event (trace update time), or Service (trace segment end time).
- Parameters:
timeRangeType
- Query trace summaries by TraceId (trace start time), Event (trace update time), or Service (trace segment end time).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
timeRangeType
Query trace summaries by TraceId (trace start time), Event (trace update time), or Service (trace segment end time).
- Parameters:
timeRangeType
- Query trace summaries by TraceId (trace start time), Event (trace update time), or Service (trace segment end time).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sampling
Set to
true
to get summaries for only a subset of available traces.- Parameters:
sampling
- Set totrue
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
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 theSamplingStrategy.Builder
avoiding the need to create one manually viaSamplingStrategy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosamplingStrategy(SamplingStrategy)
.- Parameters:
samplingStrategy
- a consumer that will call methods onSamplingStrategy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-