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

Interface DescribeSessionsRequest.Builder

All Superinterfaces:
AppStreamRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<DescribeSessionsRequest.Builder,DescribeSessionsRequest>, SdkBuilder<DescribeSessionsRequest.Builder,DescribeSessionsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeSessionsRequest
public static interface DescribeSessionsRequest.Builder extends AppStreamRequest.Builder, SdkPojo, CopyableBuilder<DescribeSessionsRequest.Builder,DescribeSessionsRequest>

  • Method Details

    • stackName

      DescribeSessionsRequest.Builder stackName(String stackName)

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

      Parameters:
      stackName - The name of the stack. This value is case-sensitive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fleetName

      DescribeSessionsRequest.Builder fleetName(String fleetName)

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

      Parameters:
      fleetName - The name of the fleet. This value is case-sensitive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      DescribeSessionsRequest.Builder userId(String userId)

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

      Parameters:
      userId - The user identifier (ID). If you specify a user ID, you must also specify the authentication type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      DescribeSessionsRequest.Builder nextToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • limit

      DescribeSessionsRequest.Builder limit(Integer limit)

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

      Parameters:
      limit - The size of each page of results. The default value is 20 and the maximum value is 50.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authenticationType

      DescribeSessionsRequest.Builder authenticationType(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authenticationType

      DescribeSessionsRequest.Builder authenticationType(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceId

      DescribeSessionsRequest.Builder instanceId(String instanceId)

      The identifier for the instance hosting the session.

      Parameters:
      instanceId - The identifier for the instance hosting the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DescribeSessionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeSessionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.