Interface WorkspacesPool.Builder

All Superinterfaces:

Buildable, CopyableBuilder<WorkspacesPool.Builder,WorkspacesPool>, SdkBuilder<WorkspacesPool.Builder,WorkspacesPool>, SdkPojo

Enclosing class:

WorkspacesPool

@Mutable
@NotThreadSafe
public static interface WorkspacesPool.Builder
extends SdkPojo, CopyableBuilder<WorkspacesPool.Builder,WorkspacesPool>

Method Summary

Modifier and Type	Method	Description
default WorkspacesPool.Builder	applicationSettings(Consumer<ApplicationSettingsResponse.Builder> applicationSettings)	The persistent application settings for users of the pool.
WorkspacesPool.Builder	applicationSettings(ApplicationSettingsResponse applicationSettings)	The persistent application settings for users of the pool.
WorkspacesPool.Builder	bundleId(String bundleId)	The identifier of the bundle used by the pool.
default WorkspacesPool.Builder	capacityStatus(Consumer<CapacityStatus.Builder> capacityStatus)	The capacity status for the pool
WorkspacesPool.Builder	capacityStatus(CapacityStatus capacityStatus)	The capacity status for the pool
WorkspacesPool.Builder	createdAt(Instant createdAt)	The time the pool was created.
WorkspacesPool.Builder	description(String description)	The description of the pool.
WorkspacesPool.Builder	directoryId(String directoryId)	The identifier of the directory used by the pool.
WorkspacesPool.Builder	errors(Collection<WorkspacesPoolError> errors)	The pool errors.
WorkspacesPool.Builder	errors(Consumer<WorkspacesPoolError.Builder>... errors)	The pool errors.
WorkspacesPool.Builder	errors(WorkspacesPoolError... errors)	The pool errors.
WorkspacesPool.Builder	poolArn(String poolArn)	The Amazon Resource Name (ARN) for the pool.
WorkspacesPool.Builder	poolId(String poolId)	The identifier of a pool.
WorkspacesPool.Builder	poolName(String poolName)	The name of the pool.
WorkspacesPool.Builder	runningMode(String runningMode)	The running mode of the pool.
WorkspacesPool.Builder	runningMode(PoolsRunningMode runningMode)	The running mode of the pool.
WorkspacesPool.Builder	state(String state)	The current state of the pool.
WorkspacesPool.Builder	state(WorkspacesPoolState state)	The current state of the pool.
default WorkspacesPool.Builder	timeoutSettings(Consumer<TimeoutSettings.Builder> timeoutSettings)	The amount of time that a pool session remains active after users disconnect.
WorkspacesPool.Builder	timeoutSettings(TimeoutSettings timeoutSettings)	The amount of time that a pool session remains active after users disconnect.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

poolId

WorkspacesPool.Builder poolId(String poolId)

The identifier of a pool.

Parameters:

poolId - The identifier of a pool.

Returns:

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

poolArn

WorkspacesPool.Builder poolArn(String poolArn)

The Amazon Resource Name (ARN) for the pool.

Parameters:

poolArn - The Amazon Resource Name (ARN) for the pool.

Returns:

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

capacityStatus

WorkspacesPool.Builder capacityStatus(CapacityStatus capacityStatus)

The capacity status for the pool

Parameters:

capacityStatus - The capacity status for the pool

Returns:

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

capacityStatus

default WorkspacesPool.Builder capacityStatus(Consumer<CapacityStatus.Builder> capacityStatus)

The capacity status for the pool

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

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

Parameters:

capacityStatus - a consumer that will call methods on CapacityStatus.Builder

Returns:

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

See Also:

• capacityStatus(CapacityStatus)

poolName

WorkspacesPool.Builder poolName(String poolName)

The name of the pool.

Parameters:

poolName - The name of the pool.

Returns:

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

description

WorkspacesPool.Builder description(String description)

The description of the pool.

Parameters:

description - The description of the pool.

Returns:

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

state

WorkspacesPool.Builder state(String state)

The current state of the pool.

Parameters:

state - The current state of the pool.

Returns:

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

See Also:

• WorkspacesPoolState
• WorkspacesPoolState

state

WorkspacesPool.Builder state(WorkspacesPoolState state)

The current state of the pool.

Parameters:

state - The current state of the pool.

Returns:

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

See Also:

• WorkspacesPoolState
• WorkspacesPoolState

createdAt

WorkspacesPool.Builder createdAt(Instant createdAt)

The time the pool was created.

Parameters:

createdAt - The time the pool was created.

Returns:

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

bundleId

WorkspacesPool.Builder bundleId(String bundleId)

The identifier of the bundle used by the pool.

Parameters:

bundleId - The identifier of the bundle used by the pool.

Returns:

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

directoryId

WorkspacesPool.Builder directoryId(String directoryId)

The identifier of the directory used by the pool.

Parameters:

directoryId - The identifier of the directory used by the pool.

Returns:

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

errors

WorkspacesPool.Builder errors(Collection<WorkspacesPoolError> errors)

The pool errors.

Parameters:

errors - The pool errors.

Returns:

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

errors

WorkspacesPool.Builder errors(WorkspacesPoolError... errors)

The pool errors.

Parameters:

errors - The pool errors.

Returns:

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

errors

WorkspacesPool.Builder errors(Consumer<WorkspacesPoolError.Builder>... errors)

The pool errors.

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

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

Parameters:

errors - a consumer that will call methods on WorkspacesPoolError.Builder

Returns:

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

See Also:

• errors(java.util.Collection<WorkspacesPoolError>)

applicationSettings

WorkspacesPool.Builder applicationSettings(ApplicationSettingsResponse applicationSettings)

The persistent application settings for users of the pool.

Parameters:

applicationSettings - The persistent application settings for users of the pool.

Returns:

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

applicationSettings

default WorkspacesPool.Builder applicationSettings(Consumer<ApplicationSettingsResponse.Builder> applicationSettings)

The persistent application settings for users of the pool.

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

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

Parameters:

applicationSettings - a consumer that will call methods on ApplicationSettingsResponse.Builder

Returns:

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

See Also:

• applicationSettings(ApplicationSettingsResponse)

timeoutSettings

WorkspacesPool.Builder timeoutSettings(TimeoutSettings timeoutSettings)

The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.

Parameters:

timeoutSettings - The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.

Returns:

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

timeoutSettings

default WorkspacesPool.Builder timeoutSettings(Consumer<TimeoutSettings.Builder> timeoutSettings)

The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.

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

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

Parameters:

timeoutSettings - a consumer that will call methods on TimeoutSettings.Builder

Returns:

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

See Also:

• timeoutSettings(TimeoutSettings)

runningMode

WorkspacesPool.Builder runningMode(String runningMode)

The running mode of the pool.

Parameters:

runningMode - The running mode of the pool.

Returns:

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

See Also:

• PoolsRunningMode
• PoolsRunningMode

runningMode

WorkspacesPool.Builder runningMode(PoolsRunningMode runningMode)

The running mode of the pool.

Parameters:

runningMode - The running mode of the pool.

Returns:

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

See Also:

• PoolsRunningMode
• PoolsRunningMode