Package software.amazon.awssdk.services.workspacesweb.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListSessionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListSessionsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of results to be included in the next page.
String	nextToken()	The pagination token used to retrieve the next page of results for this operation.
String	portalId()	The ID of the web portal for the sessions.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListSessionsRequest.Builder>	serializableBuilderClass()
String	sessionId()	The ID of the session.
SessionSortBy	sortBy()	The method in which the returned sessions should be sorted.
String	sortByAsString()	The method in which the returned sessions should be sorted.
SessionStatus	status()	The status of the session.
String	statusAsString()	The status of the session.
ListSessionsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	username()	The username of the session.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

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:

SessionSortBy

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:

SessionSortBy

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:

SessionStatus

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:

SessionStatus

username

public final String username()

The username of the session.

Returns:

The username of the session.

toBuilder

public ListSessionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListSessionsRequest.Builder,ListSessionsRequest>

Specified by:

toBuilder in class WorkSpacesWebRequest

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