Class ProvisionedWorkerPoolProperties.Builder

java.lang.Object

co.yellowdog.platform.model.builders.ValidatedBuilder<ProvisionedWorkerPoolProperties>

co.yellowdog.platform.model.ProvisionedWorkerPoolProperties.Builder

Enclosing class:

ProvisionedWorkerPoolProperties

public static class ProvisionedWorkerPoolProperties.Builder
extends ValidatedBuilder<ProvisionedWorkerPoolProperties>

A builder that can be used to build a new ProvisionedWorkerPoolProperties that is automatically validated on build.

Method Summary

Modifier and Type	Method	Description
ProvisionedWorkerPoolProperties	buildUnchecked()	Builds the object without enforcing validation constraints.
ProvisionedWorkerPoolProperties.Builder	createNodeWorkers(NodeWorkerTarget createNodeWorkers)	How many workers to create on each node.
ProvisionedWorkerPoolProperties.Builder	idleNodeShutdown(AutoShutdown idleNodeShutdown)	Determines the auto shutdown behaviour applied for idle nodes.
ProvisionedWorkerPoolProperties.Builder	idleNodeShutdownTimeout(Duration timeout)
ProvisionedWorkerPoolProperties.Builder	idlePoolShutdown(AutoShutdown idlePoolShutdown)	Determines the auto shutdown behaviour applied for an idle pool.
ProvisionedWorkerPoolProperties.Builder	idlePoolShutdownTimeout(Duration timeout)
ProvisionedWorkerPoolProperties.Builder	maxNodes(Integer maxNodes)	The maximum number of nodes that the worker pool can be scaled up to.
ProvisionedWorkerPoolProperties.Builder	metricsEnabled(Boolean metricsEnabled)
ProvisionedWorkerPoolProperties.Builder	minNodes(Integer minNodes)	The minimum number of nodes that the worker pool can be scaled down to.
ProvisionedWorkerPoolProperties.Builder	nodeBootTimeout(Duration nodeBootTimeout)	The time given for a node to be registered before it is considered to have failed.
ProvisionedWorkerPoolProperties.Builder	nodeConfiguration(WorkerPoolNodeConfiguration nodeConfiguration)
String	toString()
ProvisionedWorkerPoolProperties.Builder	workersPerNode(int targetCount)
ProvisionedWorkerPoolProperties.Builder	workersPerVcpu(double targetCount)
ProvisionedWorkerPoolProperties.Builder	workerTag(String workerTag)	An optional tag value that will be attached to all workers in this pool and used to constrain worker allocation.

Methods inherited from class co.yellowdog.platform.model.builders.ValidatedBuilder

build, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

workersPerNode

public ProvisionedWorkerPoolProperties.Builder workersPerNode(int targetCount)

workersPerVcpu

public ProvisionedWorkerPoolProperties.Builder workersPerVcpu(double targetCount)

idleNodeShutdownTimeout

public ProvisionedWorkerPoolProperties.Builder idleNodeShutdownTimeout(Duration timeout)

idlePoolShutdownTimeout

public ProvisionedWorkerPoolProperties.Builder idlePoolShutdownTimeout(Duration timeout)

createNodeWorkers

public ProvisionedWorkerPoolProperties.Builder createNodeWorkers(NodeWorkerTarget createNodeWorkers)

How many workers to create on each node.

Parameters:

createNodeWorkers - how many workers to create on each node

Returns:

this.

minNodes

public ProvisionedWorkerPoolProperties.Builder minNodes(Integer minNodes)

The minimum number of nodes that the worker pool can be scaled down to.

Parameters:

minNodes - the minimum number of nodes

Returns:

this.

maxNodes

public ProvisionedWorkerPoolProperties.Builder maxNodes(Integer maxNodes)

The maximum number of nodes that the worker pool can be scaled up to.

Parameters:

maxNodes - the maximum number of nodes

Returns:

this.

nodeBootTimeout

public ProvisionedWorkerPoolProperties.Builder nodeBootTimeout(Duration nodeBootTimeout)

The time given for a node to be registered before it is considered to have failed.

Parameters:

nodeBootTimeout - the time given for a node to be registered before it is considered to have failed

Returns:

this.

idleNodeShutdown

public ProvisionedWorkerPoolProperties.Builder idleNodeShutdown(AutoShutdown idleNodeShutdown)

Determines the auto shutdown behaviour applied for idle nodes.

Parameters:

idleNodeShutdown - the auto shutdown behaviour applied for idle nodes

Returns:

this.

idlePoolShutdown

public ProvisionedWorkerPoolProperties.Builder idlePoolShutdown(AutoShutdown idlePoolShutdown)

Determines the auto shutdown behaviour applied for an idle pool.

Parameters:

idlePoolShutdown - the auto shutdown behaviour applied for an idle pool

Returns:

this.

workerTag

public ProvisionedWorkerPoolProperties.Builder workerTag(String workerTag)

An optional tag value that will be attached to all workers in this pool and used to constrain worker allocation.

Parameters:

workerTag - an optional tag value

Returns:

this.

nodeConfiguration

public ProvisionedWorkerPoolProperties.Builder nodeConfiguration(WorkerPoolNodeConfiguration nodeConfiguration)

Returns:

this.

metricsEnabled

public ProvisionedWorkerPoolProperties.Builder metricsEnabled(Boolean metricsEnabled)

Returns:

this.

buildUnchecked

public ProvisionedWorkerPoolProperties buildUnchecked()

Description copied from class: ValidatedBuilder

Builds the object without enforcing validation constraints. This should only be used for testing purposes

Overrides:

buildUnchecked in class ValidatedBuilder<ProvisionedWorkerPoolProperties>

Returns:

the object being built

toString

public String toString()

Overrides:

toString in class Object