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

Class ListSessionsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.athena.model.AthenaRequest
software.amazon.awssdk.services.athena.model.ListSessionsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListSessionsRequest.Builder,ListSessionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListSessionsRequest extends AthenaRequest implements ToCopyableBuilder<ListSessionsRequest.Builder,ListSessionsRequest>

  • Method Details

    • workGroup

      public final String workGroup()

      The workgroup to which the session belongs.

      Returns:
      The workgroup to which the session belongs.

    • stateFilter

      public final SessionState stateFilter()

      A filter for a specific session state. A description of each state follows.

      CREATING - The session is being started, including acquiring resources.

      CREATED - The session has been started.

      IDLE - The session is able to accept a calculation.

      BUSY - The session is processing another task and is unable to accept a calculation.

      TERMINATING - The session is in the process of shutting down.

      TERMINATED - The session and its resources are no longer running.

      DEGRADED - The session has no healthy coordinators.

      FAILED - Due to a failure, the session and its resources are no longer running.

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

      Returns:
      A filter for a specific session state. A description of each state follows.

      CREATING - The session is being started, including acquiring resources.

      CREATED - The session has been started.

      IDLE - The session is able to accept a calculation.

      BUSY - The session is processing another task and is unable to accept a calculation.

      TERMINATING - The session is in the process of shutting down.

      TERMINATED - The session and its resources are no longer running.

      DEGRADED - The session has no healthy coordinators.

      FAILED - Due to a failure, the session and its resources are no longer running.

      See Also:

    • stateFilterAsString

      public final String stateFilterAsString()

      A filter for a specific session state. A description of each state follows.

      CREATING - The session is being started, including acquiring resources.

      CREATED - The session has been started.

      IDLE - The session is able to accept a calculation.

      BUSY - The session is processing another task and is unable to accept a calculation.

      TERMINATING - The session is in the process of shutting down.

      TERMINATED - The session and its resources are no longer running.

      DEGRADED - The session has no healthy coordinators.

      FAILED - Due to a failure, the session and its resources are no longer running.

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

      Returns:
      A filter for a specific session state. A description of each state follows.

      CREATING - The session is being started, including acquiring resources.

      CREATED - The session has been started.

      IDLE - The session is able to accept a calculation.

      BUSY - The session is processing another task and is unable to accept a calculation.

      TERMINATING - The session is in the process of shutting down.

      TERMINATED - The session and its resources are no longer running.

      DEGRADED - The session has no healthy coordinators.

      FAILED - Due to a failure, the session and its resources are no longer running.

      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of sessions to return.

      Returns:
      The maximum number of sessions to return.

    • nextToken

      public final String nextToken()

      A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

      Returns:
      A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

    • toBuilder

      public ListSessionsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListSessionsRequest.Builder,ListSessionsRequest>
      Specified by:
      toBuilder in class AthenaRequest

    • builder

      public static ListSessionsRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • 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