software.amazon.awssdk.services.xray.model

Interface Service.Builder

All Superinterfaces:

CopyableBuilder<Service.Builder,Service>, SdkBuilder<Service.Builder,Service>

Enclosing class:

Service

public static interface Service.Builder
extends CopyableBuilder<Service.Builder,Service>

Method Summary

Modifier and Type	Method and Description
Service.Builder	accountId(String accountId) Identifier of the AWS account in which the service runs.
Service.Builder	durationHistogram(Collection<HistogramEntry> durationHistogram) A histogram that maps the spread of service durations.
Service.Builder	durationHistogram(Consumer<HistogramEntry.Builder>... durationHistogram) A histogram that maps the spread of service durations.
Service.Builder	durationHistogram(HistogramEntry... durationHistogram) A histogram that maps the spread of service durations.
Service.Builder	edges(Collection<Edge> edges) Connections to downstream services.
Service.Builder	edges(Consumer<Edge.Builder>... edges) Connections to downstream services.
Service.Builder	edges(Edge... edges) Connections to downstream services.
Service.Builder	endTime(Instant endTime) The end time of the last segment that the service generated.
Service.Builder	name(String name) The canonical name of the service.
Service.Builder	names(Collection<String> names) A list of names for the service, including the canonical name.
Service.Builder	names(String... names) A list of names for the service, including the canonical name.
Service.Builder	referenceId(Integer referenceId) Identifier for the service.
Service.Builder	responseTimeHistogram(Collection<HistogramEntry> responseTimeHistogram) A histogram that maps the spread of service response times.
Service.Builder	responseTimeHistogram(Consumer<HistogramEntry.Builder>... responseTimeHistogram) A histogram that maps the spread of service response times.
Service.Builder	responseTimeHistogram(HistogramEntry... responseTimeHistogram) A histogram that maps the spread of service response times.
Service.Builder	root(Boolean root) Indicates that the service was the first service to process a request.
Service.Builder	startTime(Instant startTime) The start time of the first segment that the service generated.
Service.Builder	state(String state) The service's state.
default Service.Builder	summaryStatistics(Consumer<ServiceStatistics.Builder> summaryStatistics) Aggregated statistics for the service.
Service.Builder	summaryStatistics(ServiceStatistics summaryStatistics) Aggregated statistics for the service.
Service.Builder	type(String type) The type of service.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

referenceId

Service.Builder referenceId(Integer referenceId)

Identifier for the service. Unique within the service map.

Parameters:

referenceId - Identifier for the service. Unique within the service map.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

Service.Builder name(String name)

The canonical name of the service.

Parameters:

name - The canonical name of the service.

Returns:

Returns a reference to this object so that method calls can be chained together.

names

Service.Builder names(Collection<String> names)

A list of names for the service, including the canonical name.

Parameters:

names - A list of names for the service, including the canonical name.

Returns:

Returns a reference to this object so that method calls can be chained together.

names

Service.Builder names(String... names)

A list of names for the service, including the canonical name.

Parameters:

names - A list of names for the service, including the canonical name.

Returns:

Returns a reference to this object so that method calls can be chained together.

root

Service.Builder root(Boolean root)

Indicates that the service was the first service to process a request.

Parameters:

root - Indicates that the service was the first service to process a request.

Returns:

Returns a reference to this object so that method calls can be chained together.

accountId

Service.Builder accountId(String accountId)

Identifier of the AWS account in which the service runs.

Parameters:

accountId - Identifier of the AWS account in which the service runs.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

Service.Builder type(String type)

The type of service.

• AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance for a application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.

• AWS Service - The type of an AWS service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.

• client - Represents the clients that sent requests to a root service.

• remote - A downstream service of indeterminate type.

Parameters:

type - The type of service.

• AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance for a application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.

• AWS Service - The type of an AWS service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.

• client - Represents the clients that sent requests to a root service.

• remote - A downstream service of indeterminate type.

Returns:

Returns a reference to this object so that method calls can be chained together.

state

Service.Builder state(String state)

The service's state.

Parameters:

state - The service's state.

Returns:

Returns a reference to this object so that method calls can be chained together.

startTime

Service.Builder startTime(Instant startTime)

The start time of the first segment that the service generated.

Parameters:

startTime - The start time of the first segment that the service generated.

Returns:

Returns a reference to this object so that method calls can be chained together.

endTime

Service.Builder endTime(Instant endTime)

The end time of the last segment that the service generated.

Parameters:

endTime - The end time of the last segment that the service generated.

Returns:

Returns a reference to this object so that method calls can be chained together.

edges

Service.Builder edges(Collection<Edge> edges)

Connections to downstream services.

Parameters:

edges - Connections to downstream services.

Returns:

Returns a reference to this object so that method calls can be chained together.

edges

Service.Builder edges(Edge... edges)

Connections to downstream services.

Parameters:

edges - Connections to downstream services.

Returns:

Returns a reference to this object so that method calls can be chained together.

edges

Service.Builder edges(Consumer<Edge.Builder>... edges)

Connections to downstream services.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #edges(List).

Parameters:

edges - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#edges(List)

summaryStatistics

Service.Builder summaryStatistics(ServiceStatistics summaryStatistics)

Aggregated statistics for the service.

Parameters:

summaryStatistics - Aggregated statistics for the service.

Returns:

Returns a reference to this object so that method calls can be chained together.

summaryStatistics

default Service.Builder summaryStatistics(Consumer<ServiceStatistics.Builder> summaryStatistics)

Aggregated statistics for the service.

This is a convenience that creates an instance of the ServiceStatistics.Builder avoiding the need to create one manually via ServiceStatistics.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to summaryStatistics(ServiceStatistics).

Parameters:

summaryStatistics - a consumer that will call methods on ServiceStatistics.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

summaryStatistics(ServiceStatistics)

durationHistogram

Service.Builder durationHistogram(Collection<HistogramEntry> durationHistogram)

A histogram that maps the spread of service durations.

Parameters:

durationHistogram - A histogram that maps the spread of service durations.

Returns:

Returns a reference to this object so that method calls can be chained together.

durationHistogram

Service.Builder durationHistogram(HistogramEntry... durationHistogram)

A histogram that maps the spread of service durations.

Parameters:

durationHistogram - A histogram that maps the spread of service durations.

Returns:

Returns a reference to this object so that method calls can be chained together.

durationHistogram

Service.Builder durationHistogram(Consumer<HistogramEntry.Builder>... durationHistogram)

A histogram that maps the spread of service durations.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #durationHistogram(List).

Parameters:

durationHistogram - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#durationHistogram(List)

responseTimeHistogram

Service.Builder responseTimeHistogram(Collection<HistogramEntry> responseTimeHistogram)

A histogram that maps the spread of service response times.

Parameters:

responseTimeHistogram - A histogram that maps the spread of service response times.

Returns:

Returns a reference to this object so that method calls can be chained together.

responseTimeHistogram

Service.Builder responseTimeHistogram(HistogramEntry... responseTimeHistogram)

A histogram that maps the spread of service response times.

Parameters:

responseTimeHistogram - A histogram that maps the spread of service response times.

Returns:

Returns a reference to this object so that method calls can be chained together.

responseTimeHistogram

Service.Builder responseTimeHistogram(Consumer<HistogramEntry.Builder>... responseTimeHistogram)

A histogram that maps the spread of service response times.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #responseTimeHistogram(List).

Parameters:

responseTimeHistogram - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#responseTimeHistogram(List)