software.amazon.awssdk.services.xray.model

Interface CreateGroupRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateGroupRequest.Builder,CreateGroupRequest>, SdkBuilder<CreateGroupRequest.Builder,CreateGroupRequest>, SdkPojo, SdkRequest.Builder, XRayRequest.Builder

Enclosing class:

CreateGroupRequest

public static interface CreateGroupRequest.Builder
extends XRayRequest.Builder, SdkPojo, CopyableBuilder<CreateGroupRequest.Builder,CreateGroupRequest>

Method Summary

Modifier and Type	Method and Description
CreateGroupRequest.Builder	filterExpression(String filterExpression) The filter expression defining criteria by which to group traces.
CreateGroupRequest.Builder	groupName(String groupName) The case-sensitive name of the new group.
default CreateGroupRequest.Builder	insightsConfiguration(Consumer<InsightsConfiguration.Builder> insightsConfiguration) The structure containing configurations related to insights.
CreateGroupRequest.Builder	insightsConfiguration(InsightsConfiguration insightsConfiguration) The structure containing configurations related to insights.
CreateGroupRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateGroupRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateGroupRequest.Builder	tags(Collection<Tag> tags) A map that contains one or more tag keys and tag values to attach to an X-Ray group.
CreateGroupRequest.Builder	tags(Consumer<Tag.Builder>... tags) A map that contains one or more tag keys and tag values to attach to an X-Ray group.
CreateGroupRequest.Builder	tags(Tag... tags) A map that contains one or more tag keys and tag values to attach to an X-Ray group.

Methods inherited from interface software.amazon.awssdk.services.xray.model.XRayRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

groupName

CreateGroupRequest.Builder groupName(String groupName)

The case-sensitive name of the new group. Default is a reserved name and names must be unique.

Parameters:

groupName - The case-sensitive name of the new group. Default is a reserved name and names must be unique.

Returns:

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

filterExpression

CreateGroupRequest.Builder filterExpression(String filterExpression)

The filter expression defining criteria by which to group traces.

Parameters:

filterExpression - The filter expression defining criteria by which to group traces.

Returns:

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

insightsConfiguration

CreateGroupRequest.Builder insightsConfiguration(InsightsConfiguration insightsConfiguration)

The structure containing configurations related to insights.

• The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.

• The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.

Parameters:

insightsConfiguration - The structure containing configurations related to insights.

• The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.

• The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.

Returns:

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

insightsConfiguration

default CreateGroupRequest.Builder insightsConfiguration(Consumer<InsightsConfiguration.Builder> insightsConfiguration)

The structure containing configurations related to insights.

• The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.

• The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.

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

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

Parameters:

insightsConfiguration - a consumer that will call methods on InsightsConfiguration.Builder

Returns:

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

See Also:

insightsConfiguration(InsightsConfiguration)

tags

CreateGroupRequest.Builder tags(Collection<Tag> tags)

A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

• Maximum number of user-applied tags per resource: 50

• Maximum tag key length: 128 Unicode characters

• Maximum tag value length: 256 Unicode characters

• Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

• Tag keys and values are case sensitive.

• Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

Parameters:

tags - A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

• Maximum number of user-applied tags per resource: 50

• Maximum tag key length: 128 Unicode characters

• Maximum tag value length: 256 Unicode characters

• Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

• Tag keys and values are case sensitive.

• Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

Returns:

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

tags

CreateGroupRequest.Builder tags(Tag... tags)

A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

• Maximum number of user-applied tags per resource: 50

• Maximum tag key length: 128 Unicode characters

• Maximum tag value length: 256 Unicode characters

• Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

• Tag keys and values are case sensitive.

• Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

Parameters:

tags - A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

• Maximum number of user-applied tags per resource: 50

• Maximum tag key length: 128 Unicode characters

• Maximum tag value length: 256 Unicode characters

• Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

• Tag keys and values are case sensitive.

• Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

Returns:

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

tags

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

A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

• Maximum number of user-applied tags per resource: 50

• Maximum tag key length: 128 Unicode characters

• Maximum tag value length: 256 Unicode characters

• Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

• Tag keys and values are case sensitive.

• Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

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

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)

overrideConfiguration

CreateGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder