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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WorkGroup.Builder

Method Summary

Modifier and Type	Method	Description
static WorkGroup.Builder	builder()
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.
Instant	creationTime()	The date and time the workgroup was created.
String	description()	The workgroup description.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identityCenterApplicationArn()	The ARN of the IAM Identity Center enabled application associated with the workgroup.
String	name()	The workgroup name.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends WorkGroup.Builder>	serializableBuilderClass()
WorkGroupState	state()	The state of the workgroup: ENABLED or DISABLED.
String	stateAsString()	The state of the workgroup: ENABLED or DISABLED.
WorkGroup.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

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:

WorkGroupState

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:

WorkGroupState

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

Specified by:

toBuilder in interface ToCopyableBuilder<WorkGroup.Builder,WorkGroup>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo