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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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<WorkGroupSummary.Builder,WorkGroupSummary>
      Returns:
      a builder for type T

    • 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)
      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.