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

Interface WorkGroup.Builder

All Superinterfaces:
Buildable, CopyableBuilder<WorkGroup.Builder,WorkGroup>, SdkBuilder<WorkGroup.Builder,WorkGroup>, SdkPojo
Enclosing class:
WorkGroup
public static interface WorkGroup.Builder extends SdkPojo, CopyableBuilder<WorkGroup.Builder,WorkGroup>

  • Method Summary

    Modifier and Type
    Method
    Description
    default WorkGroup.Builder
    configuration(Consumer<WorkGroupConfiguration.Builder> configuration)
    The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for query and calculation results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limits for the amount of data scanned per query or per workgroup.
    WorkGroup.Builder
    configuration(WorkGroupConfiguration configuration)
    The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for query and calculation results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limits for the amount of data scanned per query or per workgroup.
    WorkGroup.Builder
    creationTime(Instant creationTime)
    The date and time the workgroup was created.
    WorkGroup.Builder
    description(String description)
    The workgroup description.
    WorkGroup.Builder
    name(String name)
    The workgroup name.
    WorkGroup.Builder
    state(String state)
    The state of the workgroup: ENABLED or DISABLED.
    WorkGroup.Builder
    state(WorkGroupState state)
    The state of the workgroup: ENABLED or DISABLED.

    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, sdkFields

  • Method Details

    • name

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

    • state

      WorkGroup.Builder state(String state)

      The state of the workgroup: ENABLED or DISABLED.

      Parameters:
      state - The state of the workgroup: ENABLED or DISABLED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      WorkGroup.Builder state(WorkGroupState state)

      The state of the workgroup: ENABLED or DISABLED.

      Parameters:
      state - The state of the workgroup: ENABLED or DISABLED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • configuration

      WorkGroup.Builder configuration(WorkGroupConfiguration configuration)

      The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for query and calculation results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

      Parameters:
      configuration - The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for query and calculation results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

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

      The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for query and calculation results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. 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:

    • description

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

    • creationTime

      WorkGroup.Builder creationTime(Instant creationTime)

      The date and time the workgroup was created.

      Parameters:
      creationTime - The date and time the workgroup was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.