Package software.amazon.awssdk.services.appstream.model

Class DescribeSessionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.appstream.model.AppStreamRequest

software.amazon.awssdk.services.appstream.model.DescribeSessionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeSessionsRequest.Builder,DescribeSessionsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeSessionsRequest
extends AppStreamRequest
implements ToCopyableBuilder<DescribeSessionsRequest.Builder,DescribeSessionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeSessionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
AuthenticationType	authenticationType()	The authentication method.
String	authenticationTypeAsString()	The authentication method.
static DescribeSessionsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fleetName()	The name of the fleet.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	instanceId()	The identifier for the instance hosting the session.
Integer	limit()	The size of each page of results.
String	nextToken()	The pagination token to use to retrieve the next page of results for this operation.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeSessionsRequest.Builder>	serializableBuilderClass()
String	stackName()	The name of the stack.
DescribeSessionsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userId()	The user identifier (ID).

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

stackName

public final String stackName()

The name of the stack. This value is case-sensitive.

Returns:

The name of the stack. This value is case-sensitive.

fleetName

public final String fleetName()

The name of the fleet. This value is case-sensitive.

Returns:

The name of the fleet. This value is case-sensitive.

userId

public final String userId()

The user identifier (ID). If you specify a user ID, you must also specify the authentication type.

Returns:

The user identifier (ID). If you specify a user ID, you must also specify the authentication type.

nextToken

public final String nextToken()

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

limit

public final Integer limit()

The size of each page of results. The default value is 20 and the maximum value is 50.

Returns:

The size of each page of results. The default value is 20 and the maximum value is 50.

authenticationType

public final AuthenticationType authenticationType()

The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.

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

Returns:

The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.

See Also:

AuthenticationType

authenticationTypeAsString

public final String authenticationTypeAsString()

The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.

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

Returns:

The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.

See Also:

AuthenticationType

instanceId

public final String instanceId()

The identifier for the instance hosting the session.

Returns:

The identifier for the instance hosting the session.

toBuilder

public DescribeSessionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeSessionsRequest.Builder,DescribeSessionsRequest>

Specified by:

toBuilder in class AppStreamRequest

builder

public static DescribeSessionsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeSessionsRequest.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