Class ListSessionsRequest

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

  • Method Details

    • maxResults

      public final Integer maxResults()

      The maximum number of results to be included in the next page.

      Returns:
      The maximum number of results to be included in the next page.

    • nextToken

      public final String nextToken()

      The pagination token used to retrieve the next page of results for this operation.

      Returns:
      The pagination token used to retrieve the next page of results for this operation.

    • portalId

      public final String portalId()

      The ID of the web portal for the sessions.

      Returns:
      The ID of the web portal for the sessions.

    • sessionId

      public final String sessionId()

      The ID of the session.

      Returns:
      The ID of the session.

    • sortBy

      public final SessionSortBy sortBy()

      The method in which the returned sessions should be sorted.

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

      Returns:
      The method in which the returned sessions should be sorted.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      The method in which the returned sessions should be sorted.

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

      Returns:
      The method in which the returned sessions should be sorted.
      See Also:

    • status

      public final SessionStatus status()

      The status of the session.

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

      Returns:
      The status of the session.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the session.

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

      Returns:
      The status of the session.
      See Also:

    • username

      public final String username()

      The username of the session.

      Returns:
      The username of the session.

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