Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

ResourceWithWaitSupport

Interfacemarker
📦 Aspire.Hosting v17.0.0

Represents a resource that can wait for other resources to be running, health, and/or completed.

type ResourceWithWaitSupport interface{}

Methods

A marker interface declares no methods of its own in Go. Its functions are declared on the concrete types they apply to.

methodWaitForbuilder
Waits for another resource to be ready
WaitFor(
dependency Resource,
options ...*WaitForOptions,
) ResourceWithWaitSupport
dependencyResource
options...*WaitForOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WaitForOptions argument.

WaitBehavior*WaitBehavior
ResourceWithWaitSupport

Returns a handle; failures surface later via Err().

methodWaitForCompletionbuilder
Waits for the dependency resource to enter the Exited or Finished state before starting the resource.
WaitForCompletion(
dependency Resource,
options ...*WaitForCompletionOptions,
) ResourceWithWaitSupport
dependencyResourceThe resource builder for the dependency resource.
options...*WaitForCompletionOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WaitForCompletionOptions argument.

ExitCode*float64The exit code which is interpreted as successful.
ResourceWithWaitSupport

The resource builder.

Returns a handle; failures surface later via Err().

methodWaitForStartbuilder
Waits for another resource to start
WaitForStart(
dependency Resource,
options ...*WaitForStartOptions,
) ResourceWithWaitSupport
dependencyResource
options...*WaitForStartOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WaitForStartOptions argument.

WaitBehavior*WaitBehavior
ResourceWithWaitSupport

Returns a handle; failures surface later via Err().

Applies to

This interface applies to the following types: