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

Class WorkGroupSummary

java.lang.Object

software.amazon.awssdk.services.athena.model.WorkGroupSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WorkGroupSummary.Builder,WorkGroupSummary>

@Generated("software.amazon.awssdk:codegen")
public final class WorkGroupSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkGroupSummary.Builder,WorkGroupSummary>

The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WorkGroupSummary.Builder

Method Summary

Modifier and Type	Method	Description
static WorkGroupSummary.Builder	builder()
Instant	creationTime()	The workgroup creation date and time.
String	description()	The workgroup description.
EngineVersion	engineVersion()	The engine version setting for all queries on the workgroup.
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 name of the workgroup.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends WorkGroupSummary.Builder>	serializableBuilderClass()
WorkGroupState	state()	The state of the workgroup.
String	stateAsString()	The state of the workgroup.
WorkGroupSummary.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 name of the workgroup.

Returns:

The name of the workgroup.

state

public final WorkGroupState state()

The state of the workgroup.

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.

See Also:

WorkGroupState

stateAsString

public final String stateAsString()

The state of the workgroup.

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.

See Also:

WorkGroupState

description

public final String description()

The workgroup description.

Returns:

The workgroup description.

creationTime

public final Instant creationTime()

The workgroup creation date and time.

Returns:

The workgroup creation date and time.

engineVersion

public final EngineVersion engineVersion()

The engine version setting for all queries on the workgroup. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

Returns:

The engine version setting for all queries on the workgroup. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

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 WorkGroupSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WorkGroupSummary.Builder,WorkGroupSummary>

builder

public static WorkGroupSummary.Builder builder()

serializableBuilderClass

public static Class<? extends WorkGroupSummary.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