Class RunSpecification.Builder

java.lang.Object

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

co.yellowdog.platform.model.RunSpecification.Builder

Enclosing class:

RunSpecification

public static class RunSpecification.Builder
extends ValidatedBuilder<RunSpecification>

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

Method Summary

Modifier and Type	Method	Description
RunSpecification	buildUnchecked()	Builds the object without enforcing validation constraints.
RunSpecification.Builder	clearInstanceTypes()
RunSpecification.Builder	clearNamespaces()
RunSpecification.Builder	clearProviders()
RunSpecification.Builder	clearRegions()
RunSpecification.Builder	clearRetryableErrors()	Deprecated.
RunSpecification.Builder	clearTaskTypes()
RunSpecification.Builder	clearWorkerTags()
RunSpecification.Builder	disablePreallocation(Boolean disablePreallocation)	If true, tasks are only allocated to nodes as workers become idle and are not queued on the node.
RunSpecification.Builder	failurePolicy(FailurePolicy failurePolicy)	An optional FailurePolicy for Tasks.
RunSpecification.Builder	instancePricingPreference(InstancePricingPreference instancePricingPreference)	The preferred InstancePricing of the machine instances to use.
RunSpecification.Builder	instanceType(@NotBlank String instanceType)
RunSpecification.Builder	instanceTypes(Collection<? extends @NotBlank String> instanceTypes)
RunSpecification.Builder	maximumTaskRetries(Integer maximumTaskRetries)	Deprecated. Use retryPolicy instead
RunSpecification.Builder	maxWorkers(Integer maxWorkers)	The maximum number of Workers that can be claimed for the associated TaskGroup.
RunSpecification.Builder	minWorkers(Integer minWorkers)	The minimum number of Workers that the YellowDog Scheduler aims to keep claimed for the associated TaskGroup while it is TaskGroupStatus.RUNNING.
RunSpecification.Builder	namespace(@NotBlank @Namespace String namespace)
RunSpecification.Builder	namespaces(Collection<? extends @NotBlank @Namespace String> namespaces)
RunSpecification.Builder	provider(@NotNull CloudProvider provider)
RunSpecification.Builder	providers(Collection<? extends @NotNull CloudProvider> providers)
RunSpecification.Builder	ram(DoubleRange ram)	Range constraint on GB of RAM that are required to execute tasks
RunSpecification.Builder	region(@NotBlank String region)
RunSpecification.Builder	regions(Collection<? extends @NotBlank String> regions)
RunSpecification.Builder	retryableError(TaskErrorMatcher retryableError)	Deprecated.
RunSpecification.Builder	retryableErrors(Collection<? extends TaskErrorMatcher> retryableErrors)	Deprecated.
RunSpecification.Builder	retryPolicy(RetryPolicy retryPolicy)	A RetryPolicy for Tasks.
RunSpecification.Builder	tasksPerWorker(Integer tasksPerWorker)	Determines the number of worker claims based on splitting the number of unfinished tasks across workers.
RunSpecification.Builder	taskTimeout(Duration taskTimeout)	The maximum time that a worker should attempt to execute a task for before failing it.
RunSpecification.Builder	taskType(@NotBlank String taskType)
RunSpecification.Builder	taskTypes(Collection<? extends @NotBlank String> taskTypes)
String	toString()
RunSpecification.Builder	vcpus(DoubleRange vcpus)	Range constraint on number of vCPUs that are required to execute tasks
RunSpecification.Builder	workerTag(@NotBlank @Size(max=200) String workerTag)
RunSpecification.Builder	workerTags(Collection<? extends @NotBlank @Size(max=200) String> workerTags)

Methods inherited from class ValidatedBuilder

build, validate

Modifier and Type	Method	Description
RunSpecification	build()	Builds and validates the object.
Set<jakarta.validation.ConstraintViolation<RunSpecification>>	validate()	Performs validation based on the current builder properties and returns the ConstraintViolations without throwing.

Methods inherited from class Object

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

Method Details

instanceType

public RunSpecification.Builder instanceType(@NotBlank
 @NotBlank String instanceType)

instanceTypes

public RunSpecification.Builder instanceTypes(Collection<? extends @NotBlank String> instanceTypes)

clearInstanceTypes

public RunSpecification.Builder clearInstanceTypes()

instancePricingPreference

public RunSpecification.Builder instancePricingPreference(InstancePricingPreference instancePricingPreference)

The preferred InstancePricing of the machine instances to use.

Parameters:

instancePricingPreference - the preferred InstancePricing of the machine instances to use

Returns:

this.

vcpus

public RunSpecification.Builder vcpus(DoubleRange vcpus)

Range constraint on number of vCPUs that are required to execute tasks

Parameters:

vcpus - range constraint on required number of vCPUs

Returns:

this.

ram

public RunSpecification.Builder ram(DoubleRange ram)

Range constraint on GB of RAM that are required to execute tasks

Parameters:

ram - range constraint on GB of RAM

Returns:

this.

taskType

public RunSpecification.Builder taskType(@NotBlank
 @NotBlank String taskType)

taskTypes

public RunSpecification.Builder taskTypes(Collection<? extends @NotBlank String> taskTypes)

clearTaskTypes

public RunSpecification.Builder clearTaskTypes()

minWorkers

public RunSpecification.Builder minWorkers(Integer minWorkers)

The minimum number of Workers that the YellowDog Scheduler aims to keep claimed for the associated TaskGroup while it is TaskGroupStatus.RUNNING. This does not delay the TaskGroup starting, and is no longer applied once the TaskGroup is TaskGroupStatus.FINISHING.

Parameters:

minWorkers - defines the minimum number of Workers required

Returns:

this.

maxWorkers

public RunSpecification.Builder maxWorkers(Integer maxWorkers)

The maximum number of Workers that can be claimed for the associated TaskGroup.

Parameters:

maxWorkers - defines the maximum number of Workers that can be claimed

Returns:

this.

tasksPerWorker

public RunSpecification.Builder tasksPerWorker(Integer tasksPerWorker)

Determines the number of worker claims based on splitting the number of unfinished tasks across workers. This is only used until the YellowDog Scheduler has estimated how long the associated TaskGroup's tasks take, after which claims are sized from that estimate instead.

Parameters:

tasksPerWorker - how many unfinished tasks per worker to determine the number of worker claims

Returns:

this.

maximumTaskRetries

@Deprecated
public RunSpecification.Builder maximumTaskRetries(Integer maximumTaskRetries)

Deprecated.

Use retryPolicy instead

The maximum number of times a task can be retried after it has failed.

To restrict which tasks can be retried based on the last error that was encountered, see retryableErrors

Parameters:

maximumTaskRetries - the maximum number of times a task can be retried after it has failed

Returns:

this.

taskTimeout

public RunSpecification.Builder taskTimeout(Duration taskTimeout)

The maximum time that a worker should attempt to execute a task for before failing it. NB: This value can be overridden on individual tasks when they are added.

Parameters:

taskTimeout - the maximum time that a worker should attempt to execute a task for before failing it

Returns:

this.

provider

public RunSpecification.Builder provider(@NotNull
 @NotNull CloudProvider provider)

providers

public RunSpecification.Builder providers(Collection<? extends @NotNull CloudProvider> providers)

clearProviders

public RunSpecification.Builder clearProviders()

region

public RunSpecification.Builder region(@NotBlank
 @NotBlank String region)

regions

public RunSpecification.Builder regions(Collection<? extends @NotBlank String> regions)

clearRegions

public RunSpecification.Builder clearRegions()

workerTag

public RunSpecification.Builder workerTag(@NotBlank @Size(max=200)
 @NotBlank @Size(max=200) String workerTag)

workerTags

public RunSpecification.Builder workerTags(Collection<? extends @NotBlank @Size(max=200) String> workerTags)

clearWorkerTags

public RunSpecification.Builder clearWorkerTags()

namespace

public RunSpecification.Builder namespace(@NotBlank @Namespace
 @NotBlank @Namespace String namespace)

namespaces

public RunSpecification.Builder namespaces(Collection<? extends @NotBlank @Namespace String> namespaces)

clearNamespaces

public RunSpecification.Builder clearNamespaces()

retryableError

@Deprecated
public RunSpecification.Builder retryableError(TaskErrorMatcher retryableError)

Deprecated.

retryableErrors

@Deprecated
public RunSpecification.Builder retryableErrors(Collection<? extends TaskErrorMatcher> retryableErrors)

Deprecated.

clearRetryableErrors

@Deprecated
public RunSpecification.Builder clearRetryableErrors()

Deprecated.

disablePreallocation

public RunSpecification.Builder disablePreallocation(Boolean disablePreallocation)

If true, tasks are only allocated to nodes as workers become idle and are not queued on the node.

Parameters:

disablePreallocation - true, if tasks are only allocated to nodes as workers become idle; otherwise, false

Returns:

this.

retryPolicy

public RunSpecification.Builder retryPolicy(RetryPolicy retryPolicy)

A RetryPolicy for Tasks. This must not be used in combination with the deprecated retryableErrors or maximumTaskRetries.

Parameters:

retryPolicy - Policy describing how Tasks should be retried, can be null if Tasks should not be retried using the RetryPolicy

Returns:

this.

failurePolicy

public RunSpecification.Builder failurePolicy(FailurePolicy failurePolicy)

An optional FailurePolicy for Tasks.

Parameters:

failurePolicy - policy describing what to do when a Task fails, can be null if no further actions should be taken.

Returns:

this.

buildUnchecked

public RunSpecification buildUnchecked()

Description copied from class: ValidatedBuilder

Builds the object without enforcing validation constraints. Use this when the object is validated later, for example as part of an enclosing object built with ValidatedBuilder.build(), or when it does not need to be valid on its own.

Overrides:

buildUnchecked in class ValidatedBuilder<RunSpecification>

Returns:

the object being built

toString

public String toString()

Overrides:

toString in class Object