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>

  • Method Details

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

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

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