Interface GetStreamGroupResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetStreamGroupResponse.Builder,GetStreamGroupResponse>, GameLiftStreamsResponse.Builder, SdkBuilder<GetStreamGroupResponse.Builder,GetStreamGroupResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetStreamGroupResponse
@Mutable @NotThreadSafe public static interface GetStreamGroupResponse.Builder extends GameLiftStreamsResponse.Builder, SdkPojo, CopyableBuilder<GetStreamGroupResponse.Builder,GetStreamGroupResponse>

  • Method Details

    • arn

      GetStreamGroupResponse.Builder arn(String arn)

      The Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID].

      Parameters:
      arn - The Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID].
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • associatedApplications

      GetStreamGroupResponse.Builder associatedApplications(Collection<String> associatedApplications)

      A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group.

      This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.

      Parameters:
      associatedApplications - A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group.

      This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • associatedApplications

      GetStreamGroupResponse.Builder associatedApplications(String... associatedApplications)

      A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group.

      This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.

      Parameters:
      associatedApplications - A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group.

      This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      GetStreamGroupResponse.Builder createdAt(Instant createdAt)

      A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

      Parameters:
      createdAt - A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultApplication

      GetStreamGroupResponse.Builder defaultApplication(DefaultApplication defaultApplication)

      The default Amazon GameLift Streams application that is associated with this stream group.

      Parameters:
      defaultApplication - The default Amazon GameLift Streams application that is associated with this stream group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultApplication

      default GetStreamGroupResponse.Builder defaultApplication(Consumer<DefaultApplication.Builder> defaultApplication)

      The default Amazon GameLift Streams application that is associated with this stream group.

      This is a convenience method that creates an instance of the DefaultApplication.Builder avoiding the need to create one manually via DefaultApplication.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultApplication(DefaultApplication).

      Parameters:
      defaultApplication - a consumer that will call methods on DefaultApplication.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      GetStreamGroupResponse.Builder description(String description)

      A descriptive label for the stream group.

      Parameters:
      description - A descriptive label for the stream group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • id

      GetStreamGroupResponse.Builder id(String id)

      A unique ID value that is assigned to the resource when it's created. Format example: sg-1AB2C3De4.

      Parameters:
      id - A unique ID value that is assigned to the resource when it's created. Format example: sg-1AB2C3De4.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdatedAt

      GetStreamGroupResponse.Builder lastUpdatedAt(Instant lastUpdatedAt)

      A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

      Parameters:
      lastUpdatedAt - A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locationStates

      GetStreamGroupResponse.Builder locationStates(Collection<LocationState> locationStates)

      This value is the set of locations, including their name, current status, and capacities.

      A location can be in one of the following states:

      • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

      • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

      • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

      • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

      Parameters:
      locationStates - This value is the set of locations, including their name, current status, and capacities.

      A location can be in one of the following states:

      • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

      • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

      • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

      • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locationStates

      GetStreamGroupResponse.Builder locationStates(LocationState... locationStates)

      This value is the set of locations, including their name, current status, and capacities.

      A location can be in one of the following states:

      • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

      • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

      • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

      • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

      Parameters:
      locationStates - This value is the set of locations, including their name, current status, and capacities.

      A location can be in one of the following states:

      • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

      • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

      • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

      • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locationStates

      GetStreamGroupResponse.Builder locationStates(Consumer<LocationState.Builder>... locationStates)

      This value is the set of locations, including their name, current status, and capacities.

      A location can be in one of the following states:

      • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

      • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

      • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

      • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

      This is a convenience method that creates an instance of the LocationState.Builder avoiding the need to create one manually via LocationState.builder() .

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to locationStates(List<LocationState>).

      Parameters:
      locationStates - a consumer that will call methods on LocationState.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetStreamGroupResponse.Builder status(String status)

      The current status of the stream group resource. Possible statuses include the following:

      • ACTIVATING: The stream group is deploying and isn't ready to host streams.

      • ACTIVE: The stream group is ready to host streams.

      • ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.

      • ERROR: An error occurred when the stream group deployed. See StatusReason for more information.

      • DELETING: Amazon GameLift Streams is in the process of deleting the stream group.

      • UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).

      Parameters:
      status - The current status of the stream group resource. Possible statuses include the following:

      • ACTIVATING: The stream group is deploying and isn't ready to host streams.

      • ACTIVE: The stream group is ready to host streams.

      • ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.

      • ERROR: An error occurred when the stream group deployed. See StatusReason for more information.

      • DELETING: Amazon GameLift Streams is in the process of deleting the stream group.

      • UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetStreamGroupResponse.Builder status(StreamGroupStatus status)

      The current status of the stream group resource. Possible statuses include the following:

      • ACTIVATING: The stream group is deploying and isn't ready to host streams.

      • ACTIVE: The stream group is ready to host streams.

      • ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.

      • ERROR: An error occurred when the stream group deployed. See StatusReason for more information.

      • DELETING: Amazon GameLift Streams is in the process of deleting the stream group.

      • UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).

      Parameters:
      status - The current status of the stream group resource. Possible statuses include the following:

      • ACTIVATING: The stream group is deploying and isn't ready to host streams.

      • ACTIVE: The stream group is ready to host streams.

      • ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.

      • ERROR: An error occurred when the stream group deployed. See StatusReason for more information.

      • DELETING: Amazon GameLift Streams is in the process of deleting the stream group.

      • UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusReason

      GetStreamGroupResponse.Builder statusReason(String statusReason)

      A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:

      • internalError: The request can't process right now bcause of an issue with the server. Try again later. Reach out to the Amazon GameLift Streams team for more help.

      • noAvailableInstances: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.

      Parameters:
      statusReason - A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:

      • internalError: The request can't process right now bcause of an issue with the server. Try again later. Reach out to the Amazon GameLift Streams team for more help.

      • noAvailableInstances: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusReason

      GetStreamGroupResponse.Builder statusReason(StreamGroupStatusReason statusReason)

      A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:

      • internalError: The request can't process right now bcause of an issue with the server. Try again later. Reach out to the Amazon GameLift Streams team for more help.

      • noAvailableInstances: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.

      Parameters:
      statusReason - A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:

      • internalError: The request can't process right now bcause of an issue with the server. Try again later. Reach out to the Amazon GameLift Streams team for more help.

      • noAvailableInstances: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streamClass

      GetStreamGroupResponse.Builder streamClass(String streamClass)

      The target stream quality for the stream group.

      A stream class can be one of the following:

      • gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM

        • Tenancy: Supports up to 2 concurrent stream sessions

      • gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM

        • Tenancy: Supports up to 2 concurrent stream sessions

      • gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      Parameters:
      streamClass - The target stream quality for the stream group.

      A stream class can be one of the following:

      • gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM

        • Tenancy: Supports up to 2 concurrent stream sessions

      • gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM

        • Tenancy: Supports up to 2 concurrent stream sessions

      • gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streamClass

      GetStreamGroupResponse.Builder streamClass(StreamClass streamClass)

      The target stream quality for the stream group.

      A stream class can be one of the following:

      • gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM

        • Tenancy: Supports up to 2 concurrent stream sessions

      • gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM

        • Tenancy: Supports up to 2 concurrent stream sessions

      • gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      Parameters:
      streamClass - The target stream quality for the stream group.

      A stream class can be one of the following:

      • gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM

        • Tenancy: Supports up to 2 concurrent stream sessions

      • gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM

        • Tenancy: Supports up to 2 concurrent stream sessions

      • gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: