Class WorkGroup

java.lang.Object
software.amazon.awssdk.services.athena.model.WorkGroup
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WorkGroup.Builder,WorkGroup>
@Generated("software.amazon.awssdk:codegen") public final class WorkGroup extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WorkGroup.Builder,WorkGroup>

A workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroup$Configuration. Each workgroup enables you to isolate queries for you or your group of users from other queries in the same account, to configure the query results location and the encryption configuration (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and to establish per-query data usage control limits for all queries in a workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

See Also:

  • Method Details

    • name

      public final String name()

      The workgroup name.

      Returns:
      The workgroup name.

    • state

      public final WorkGroupState state()

      The state of the workgroup: ENABLED or DISABLED.

      If the service returns an enum value that is not available in the current SDK version, state will return WorkGroupState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the workgroup: ENABLED or DISABLED.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the workgroup: ENABLED or DISABLED.

      If the service returns an enum value that is not available in the current SDK version, state will return WorkGroupState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the workgroup: ENABLED or DISABLED.
      See Also:

    • configuration

      public final 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.

      Returns:
      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.

    • description

      public final String description()

      The workgroup description.

      Returns:
      The workgroup description.

    • creationTime

      public final Instant creationTime()

      The date and time the workgroup was created.

      Returns:
      The date and time the workgroup was created.

    • identityCenterApplicationArn

      public final String identityCenterApplicationArn()

      The ARN of the IAM Identity Center enabled application associated with the workgroup.

      Returns:
      The ARN of the IAM Identity Center enabled application associated with the workgroup.

    • toBuilder

      public WorkGroup.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<WorkGroup.Builder,WorkGroup>
      Returns:
      a builder for type T

    • builder

      public static WorkGroup.Builder builder()

    • serializableBuilderClass

      public static Class<? extends WorkGroup.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.