Class ListSessionsRequest

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

  • Method Details

    • nextToken

      public final String nextToken()

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

      Returns:
      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    • maxResults

      public final Integer maxResults()

      The maximum number of sessions to return in the response. If more sessions exist than fit in one response, the operation returns NextToken to paginate the results.

      Returns:
      The maximum number of sessions to return in the response. If more sessions exist than fit in one response, the operation returns NextToken to paginate the results.

    • sessionId

      public final String sessionId()

      The identifier of a specific session to return metadata for. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. When you provide SessionId, you can't specify Status, ClusterIdentifier, WorkgroupName, or Database.

      Returns:
      The identifier of a specific session to return metadata for. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. When you provide SessionId, you can't specify Status, ClusterIdentifier, WorkgroupName, or Database.

    • status

      public final SessionStatusString status()

      The status of the sessions to list. If no status is specified, sessions with a status of AVAILABLE or BUSY are returned. Status values are defined as follows:

      • AVAILABLE – The session is open and ready to run a SQL statement.

      • BUSY – The session is currently running a SQL statement.

      • CLOSED – The session is closed and can no longer run SQL statements.

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

      Returns:
      The status of the sessions to list. If no status is specified, sessions with a status of AVAILABLE or BUSY are returned. Status values are defined as follows:

      • AVAILABLE – The session is open and ready to run a SQL statement.

      • BUSY – The session is currently running a SQL statement.

      • CLOSED – The session is closed and can no longer run SQL statements.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the sessions to list. If no status is specified, sessions with a status of AVAILABLE or BUSY are returned. Status values are defined as follows:

      • AVAILABLE – The session is open and ready to run a SQL statement.

      • BUSY – The session is currently running a SQL statement.

      • CLOSED – The session is closed and can no longer run SQL statements.

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

      Returns:
      The status of the sessions to list. If no status is specified, sessions with a status of AVAILABLE or BUSY are returned. Status values are defined as follows:

      • AVAILABLE – The session is open and ready to run a SQL statement.

      • BUSY – The session is currently running a SQL statement.

      • CLOSED – The session is closed and can no longer run SQL statements.

      See Also:

    • roleLevel

      public final Boolean roleLevel()

      Specifies whether to return all sessions created by the caller's IAM role, including sessions from previous IAM sessions. If false, only sessions created in the current IAM session are returned. The default is true.

      Returns:
      Specifies whether to return all sessions created by the caller's IAM role, including sessions from previous IAM sessions. If false, only sessions created in the current IAM session are returned. The default is true.

    • clusterIdentifier

      public final String clusterIdentifier()

      The cluster identifier. Only sessions on this cluster are returned. When providing ClusterIdentifier , then WorkgroupName can't be specified.

      Returns:
      The cluster identifier. Only sessions on this cluster are returned. When providing ClusterIdentifier, then WorkgroupName can't be specified.

    • workgroupName

      public final String workgroupName()

      The serverless workgroup name or Amazon Resource Name (ARN). Only sessions on this workgroup are returned. When providing WorkgroupName, then ClusterIdentifier can't be specified.

      Returns:
      The serverless workgroup name or Amazon Resource Name (ARN). Only sessions on this workgroup are returned. When providing WorkgroupName, then ClusterIdentifier can't be specified.

    • database

      public final String database()

      The name of the database. Only sessions connected to this database are returned.

      Returns:
      The name of the database. Only sessions connected to this database are returned.

    • toBuilder

      public ListSessionsRequest.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<ListSessionsRequest.Builder,ListSessionsRequest>
      Specified by:
      toBuilder in class RedshiftDataRequest
      Returns:
      a builder for type T

    • 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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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