Package software.amazon.awssdk.services.athena.model

Interface CreateWorkGroupRequest.Builder

All Superinterfaces:

AthenaRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateWorkGroupRequest.Builder,CreateWorkGroupRequest>, SdkBuilder<CreateWorkGroupRequest.Builder,CreateWorkGroupRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateWorkGroupRequest

@Mutable
@NotThreadSafe
public static interface CreateWorkGroupRequest.Builder
extends AthenaRequest.Builder, SdkPojo, CopyableBuilder<CreateWorkGroupRequest.Builder,CreateWorkGroupRequest>

Method Summary

Modifier and Type	Method	Description
default CreateWorkGroupRequest.Builder	configuration(Consumer<WorkGroupConfiguration.Builder> configuration)	Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup.
CreateWorkGroupRequest.Builder	configuration(WorkGroupConfiguration configuration)	Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup.
CreateWorkGroupRequest.Builder	description(String description)	The workgroup description.
CreateWorkGroupRequest.Builder	name(String name)	The workgroup name.
CreateWorkGroupRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateWorkGroupRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateWorkGroupRequest.Builder	tags(Collection<Tag> tags)	A list of comma separated tags to add to the workgroup that is created.
CreateWorkGroupRequest.Builder	tags(Consumer<Tag.Builder>... tags)	A list of comma separated tags to add to the workgroup that is created.
CreateWorkGroupRequest.Builder	tags(Tag... tags)	A list of comma separated tags to add to the workgroup that is created.

Methods inherited from interface software.amazon.awssdk.services.athena.model.AthenaRequest.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

name

CreateWorkGroupRequest.Builder name(String name)

The workgroup name.

Parameters:

name - The workgroup name.

Returns:

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

configuration

CreateWorkGroupRequest.Builder configuration(WorkGroupConfiguration configuration)

Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Parameters:

configuration - Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Returns:

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

configuration

default CreateWorkGroupRequest.Builder configuration(Consumer<WorkGroupConfiguration.Builder> configuration)

Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

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

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

Parameters:

configuration - a consumer that will call methods on WorkGroupConfiguration.Builder

Returns:

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

See Also:

• configuration(WorkGroupConfiguration)

description

CreateWorkGroupRequest.Builder description(String description)

The workgroup description.

Parameters:

description - The workgroup description.

Returns:

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

tags

CreateWorkGroupRequest.Builder tags(Collection<Tag> tags)

A list of comma separated tags to add to the workgroup that is created.

Parameters:

tags - A list of comma separated tags to add to the workgroup that is created.

Returns:

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

tags

CreateWorkGroupRequest.Builder tags(Tag... tags)

A list of comma separated tags to add to the workgroup that is created.

Parameters:

tags - A list of comma separated tags to add to the workgroup that is created.

Returns:

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

tags

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

A list of comma separated tags to add to the workgroup that is created.

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

CreateWorkGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder