Interface CreateInstrumentationConfigurationRequest.Builder

All Superinterfaces:

ApplicationSignalsRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateInstrumentationConfigurationRequest.Builder,CreateInstrumentationConfigurationRequest>, SdkBuilder<CreateInstrumentationConfigurationRequest.Builder,CreateInstrumentationConfigurationRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateInstrumentationConfigurationRequest

@Mutable
@NotThreadSafe
public static interface CreateInstrumentationConfigurationRequest.Builder
extends ApplicationSignalsRequest.Builder, SdkPojo, CopyableBuilder<CreateInstrumentationConfigurationRequest.Builder,CreateInstrumentationConfigurationRequest>

Method Summary

Modifier and Type	Method	Description
CreateInstrumentationConfigurationRequest.Builder	attributeFilters(Collection<? extends Map<String,String>> attributeFilters)	Client-side filters that target specific instances.
CreateInstrumentationConfigurationRequest.Builder	attributeFilters(Map<String,String>... attributeFilters)	Client-side filters that target specific instances.
default CreateInstrumentationConfigurationRequest.Builder	captureConfiguration(Consumer<CaptureConfiguration.Builder> captureConfiguration)	Specifies what to capture when the instrumentation point is hit.
CreateInstrumentationConfigurationRequest.Builder	captureConfiguration(CaptureConfiguration captureConfiguration)	Specifies what to capture when the instrumentation point is hit.
CreateInstrumentationConfigurationRequest.Builder	description(String description)	An optional short description (up to 50 characters) that explains the purpose of this instrumentation.
CreateInstrumentationConfigurationRequest.Builder	environment(String environment)	The environment that the service is running in, such as eks:cluster-prod/namespace or ec2:production.
CreateInstrumentationConfigurationRequest.Builder	expiresAt(Instant expiresAt)	For BREAKPOINT: optional, defaults to 24 hours, must be between 5 min and 24 hours.
CreateInstrumentationConfigurationRequest.Builder	instrumentationType(String instrumentationType)	Type of instrumentation: BREAKPOINT (temporary) or PROBE (permanent)
CreateInstrumentationConfigurationRequest.Builder	instrumentationType(InstrumentationType instrumentationType)	Type of instrumentation: BREAKPOINT (temporary) or PROBE (permanent)
default CreateInstrumentationConfigurationRequest.Builder	location(Consumer<Location.Builder> location)	The location where instrumentation should be applied.
CreateInstrumentationConfigurationRequest.Builder	location(Location location)	The location where instrumentation should be applied.
CreateInstrumentationConfigurationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateInstrumentationConfigurationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateInstrumentationConfigurationRequest.Builder	service(String service)	The name of the service to instrument.
CreateInstrumentationConfigurationRequest.Builder	signalType(String signalType)	The telemetry signal type to emit for this instrumentation.
CreateInstrumentationConfigurationRequest.Builder	signalType(DynamicInstrumentationSignalType signalType)	The telemetry signal type to emit for this instrumentation.
CreateInstrumentationConfigurationRequest.Builder	tags(Collection<Tag> tags)	An optional list of key-value pairs to associate with the instrumentation configuration.
CreateInstrumentationConfigurationRequest.Builder	tags(Consumer<Tag.Builder>... tags)	An optional list of key-value pairs to associate with the instrumentation configuration.
CreateInstrumentationConfigurationRequest.Builder	tags(Tag... tags)	An optional list of key-value pairs to associate with the instrumentation configuration.

Methods inherited from interface software.amazon.awssdk.services.applicationsignals.model.ApplicationSignalsRequest.Builder

build

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

Method Details

instrumentationType

CreateInstrumentationConfigurationRequest.Builder instrumentationType(String instrumentationType)

Type of instrumentation: BREAKPOINT (temporary) or PROBE (permanent)

Parameters:

instrumentationType - Type of instrumentation: BREAKPOINT (temporary) or PROBE (permanent)

Returns:

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

See Also:

• InstrumentationType
• InstrumentationType

instrumentationType

CreateInstrumentationConfigurationRequest.Builder instrumentationType(InstrumentationType instrumentationType)

Type of instrumentation: BREAKPOINT (temporary) or PROBE (permanent)

Parameters:

instrumentationType - Type of instrumentation: BREAKPOINT (temporary) or PROBE (permanent)

Returns:

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

See Also:

• InstrumentationType
• InstrumentationType

service

CreateInstrumentationConfigurationRequest.Builder service(String service)

The name of the service to instrument. This should match the service.name resource attribute reported by the application.

Parameters:

service - The name of the service to instrument. This should match the service.name resource attribute reported by the application.

Returns:

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

environment

CreateInstrumentationConfigurationRequest.Builder environment(String environment)

The environment that the service is running in, such as eks:cluster-prod/namespace or ec2:production.

Parameters:

environment - The environment that the service is running in, such as eks:cluster-prod/namespace or ec2:production.

Returns:

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

signalType

CreateInstrumentationConfigurationRequest.Builder signalType(String signalType)

The telemetry signal type to emit for this instrumentation. The supported value is SNAPSHOT.

Parameters:

signalType - The telemetry signal type to emit for this instrumentation. The supported value is SNAPSHOT.

Returns:

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

See Also:

• DynamicInstrumentationSignalType
• DynamicInstrumentationSignalType

signalType

CreateInstrumentationConfigurationRequest.Builder signalType(DynamicInstrumentationSignalType signalType)

The telemetry signal type to emit for this instrumentation. The supported value is SNAPSHOT.

Parameters:

signalType - The telemetry signal type to emit for this instrumentation. The supported value is SNAPSHOT.

Returns:

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

See Also:

• DynamicInstrumentationSignalType
• DynamicInstrumentationSignalType

location

CreateInstrumentationConfigurationRequest.Builder location(Location location)

The location where instrumentation should be applied. Specify a CodeLocation for code-level instrumentation.

Parameters:

location - The location where instrumentation should be applied. Specify a CodeLocation for code-level instrumentation.

Returns:

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

location

default CreateInstrumentationConfigurationRequest.Builder location(Consumer<Location.Builder> location)

The location where instrumentation should be applied. Specify a CodeLocation for code-level instrumentation.

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

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

Parameters:

location - a consumer that will call methods on Location.Builder

Returns:

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

See Also:

• location(Location)

description

CreateInstrumentationConfigurationRequest.Builder description(String description)

An optional short description (up to 50 characters) that explains the purpose of this instrumentation.

Parameters:

description - An optional short description (up to 50 characters) that explains the purpose of this instrumentation.

Returns:

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

expiresAt

CreateInstrumentationConfigurationRequest.Builder expiresAt(Instant expiresAt)

For BREAKPOINT: optional, defaults to 24 hours, must be between 5 min and 24 hours. For PROBE: not supported. PROBE configurations are permanent and persist until explicitly deleted.

Parameters:

expiresAt - For BREAKPOINT: optional, defaults to 24 hours, must be between 5 min and 24 hours. For PROBE: not supported. PROBE configurations are permanent and persist until explicitly deleted.

Returns:

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

attributeFilters

CreateInstrumentationConfigurationRequest.Builder attributeFilters(Collection<? extends Map<String,String>> attributeFilters)

Client-side filters that target specific instances. Each object in the array is AND-matched on its keys, and multiple objects are OR-matched to decide where to apply the instrumentation.

Parameters:

attributeFilters - Client-side filters that target specific instances. Each object in the array is AND-matched on its keys, and multiple objects are OR-matched to decide where to apply the instrumentation.

Returns:

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

attributeFilters

CreateInstrumentationConfigurationRequest.Builder attributeFilters(Map<String,String>... attributeFilters)

Client-side filters that target specific instances. Each object in the array is AND-matched on its keys, and multiple objects are OR-matched to decide where to apply the instrumentation.

Parameters:

attributeFilters - Client-side filters that target specific instances. Each object in the array is AND-matched on its keys, and multiple objects are OR-matched to decide where to apply the instrumentation.

Returns:

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

captureConfiguration

CreateInstrumentationConfigurationRequest.Builder captureConfiguration(CaptureConfiguration captureConfiguration)

Specifies what to capture when the instrumentation point is hit. Specify CodeCapture for code-level capture settings.

Parameters:

captureConfiguration - Specifies what to capture when the instrumentation point is hit. Specify CodeCapture for code-level capture settings.

Returns:

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

captureConfiguration

default CreateInstrumentationConfigurationRequest.Builder captureConfiguration(Consumer<CaptureConfiguration.Builder> captureConfiguration)

Specifies what to capture when the instrumentation point is hit. Specify CodeCapture for code-level capture settings.

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

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

Parameters:

captureConfiguration - a consumer that will call methods on CaptureConfiguration.Builder

Returns:

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

See Also:

• captureConfiguration(CaptureConfiguration)

tags

CreateInstrumentationConfigurationRequest.Builder tags(Collection<Tag> tags)

An optional list of key-value pairs to associate with the instrumentation configuration. Tags can help you organize and categorize your resources.

Parameters:

tags - An optional list of key-value pairs to associate with the instrumentation configuration. Tags can help you organize and categorize your resources.

Returns:

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

tags

CreateInstrumentationConfigurationRequest.Builder tags(Tag... tags)

An optional list of key-value pairs to associate with the instrumentation configuration. Tags can help you organize and categorize your resources.

Parameters:

tags - An optional list of key-value pairs to associate with the instrumentation configuration. Tags can help you organize and categorize your resources.

Returns:

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

tags

CreateInstrumentationConfigurationRequest.Builder tags(Consumer<Tag.Builder>... tags)

An optional list of key-value pairs to associate with the instrumentation configuration. Tags can help you organize and categorize your resources.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

overrideConfiguration

CreateInstrumentationConfigurationRequest.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

CreateInstrumentationConfigurationRequest.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.