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:

ToCopyableBuilder<DescribeSessionsRequest.Builder,DescribeSessionsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeSessionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
AuthenticationType	authenticationType() The authentication method.
String	authenticationTypeAsString() The authentication method.
static DescribeSessionsRequest.Builder	builder()
boolean	equals(Object obj)
String	fleetName() The name of the fleet.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
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.
static Class<? extends DescribeSessionsRequest.Builder>	serializableBuilderClass()
String	stackName() The name of the stack.
DescribeSessionsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userId() The user ID.

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

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

stackName

public String stackName()

The name of the stack.

Returns:

The name of the stack.

fleetName

public String fleetName()

The name of the fleet.

Returns:

The name of the fleet.

userId

public String userId()

The user ID.

Returns:

The user ID.

nextToken

public 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 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 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 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

toBuilder

public DescribeSessionsRequest.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<DescribeSessionsRequest.Builder,DescribeSessionsRequest>

Specified by:

toBuilder in class AppStreamRequest

Returns:

a builder for type T

builder

public static DescribeSessionsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <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