Class.GetStep

@decentm/concourse-ts / GetStep

Class: GetStep<Source, PutParams, GetParams>

Defined in: components/step/get.ts:16

Fetches a version of a resource. The fetched bits are placed in a directory with the same name as the resource.

https://concourse-ci.org/docs/steps/get/

Extends

Step<GetStep>

Type Parameters

• Source extends Config = Config

• PutParams extends Config = Config

• GetParams extends Config = Config

Constructors

new GetStep()

new GetStep<Source, PutParams, GetParams>(name, customise?): GetStep<Source, PutParams, GetParams>

Defined in: components/step/get.ts:34

Parameters

name

string

customise?

(instance) => void

Returns

GetStep<Source, PutParams, GetParams>

Overrides

Step<Type.GetStep>.constructor

Properties

name

name: string

Defined in: components/step/get.ts:35

Inherited from

Step.name

Methods

add_across()

add_across(...across): void

Defined in: components/step/base.ts:57

https://concourse-ci.org/docs/steps/modifier-and-hooks/across/#across-step-modifier

Parameters

across

...Across<Identifier>[]

The modifier to add

Returns

void

Inherited from

Step.add_across

add_ensure()

add_ensure(step): void

Defined in: components/step/base.ts:249

Adds a step to always be run after this one.

https://concourse-ci.org/docs/steps/modifier-and-hooks/ensure/#ensure-step-hook

Parameters

step

AnyStep

Returns

void

Inherited from

Step.add_ensure

add_on_abort()

add_on_abort(step): void

Defined in: components/step/base.ts:234

Adds a step to be run after this one is aborted.

https://concourse-ci.org/docs/steps/modifier-and-hooks/on-abort/#on_abort-step-hook

Parameters

step

AnyStep

Returns

void

Inherited from

Step.add_on_abort

add_on_error()

add_on_error(step): void

Defined in: components/step/base.ts:219

Adds a step to be run after this one errors.

https://concourse-ci.org/docs/steps/modifier-and-hooks/on-error/#on_error-step-hook

Parameters

step

AnyStep

Returns

void

Inherited from

Step.add_on_error

add_on_failure()

add_on_failure(step): void

Defined in: components/step/base.ts:204

Adds a step to be run after this one fails.

https://concourse-ci.org/docs/steps/modifier-and-hooks/on-failure/#on_failure-step-hook

Parameters

step

AnyStep

Returns

void

Inherited from

Step.add_on_failure

add_on_success()

add_on_success(step): void

Defined in: components/step/base.ts:189

Adds a step to be run after this one succeeds.

https://concourse-ci.org/docs/steps/modifier-and-hooks/on-success/#on_success-step-hook

Parameters

step

AnyStep

Returns

void

Inherited from

Step.add_on_success

add_passed()

add_passed(...jobs): void

Defined in: components/step/get.ts:97

Constrains this get step to only fetch versions that have passed through the given jobs. When multiple jobs are specified, only versions that have passed through all of them are considered.

https://concourse-ci.org/docs/steps/get/#get-step

Parameters

jobs

...(string | Job)[]

Jobs that must have passed

Returns

void

add_tags()

add_tags(...tags): void

Defined in: components/step/base.ts:174

https://concourse-ci.org/docs/steps/modifier-and-hooks/tags/#tags-step-modifier

Parameters

Returns

void

Inherited from

Step.add_tags

serialise()

serialise(): GetStep

Defined in: components/step/get.ts:148

Serialises this step into a valid Concourse configuration fixture. The returned value needs to be converted into YAML to be used in Concourse.

Returns

GetStep

Overrides

Step.serialise

set_attempts()

set_attempts(attempts): void

Defined in: components/step/base.ts:81

Sets the number of attempts for this step.

https://concourse-ci.org/docs/steps/modifier-and-hooks/attempts/#attempts-step-modifier

Parameters

attempts

number

Returns

void

Inherited from

Step.set_attempts

set_get()

set_get<ResourceType>(resource): void

Defined in: components/step/get.ts:56

Sets the resource to fetch.

https://concourse-ci.org/docs/steps/get/#get-step

Type Parameters

• ResourceType extends Resource<Source, PutParams, GetParams, string, Config>

Parameters

resource

ResourceType

The resource to fetch

Returns

void

set_params()

set_params(params): void

Defined in: components/step/get.ts:113

Arbitrary configuration to pass to the resource when fetching. Refer to the resource type's documentation to see what parameters it supports.

https://concourse-ci.org/docs/steps/get/#get-step

Parameters

params

GetParams

Resource-specific parameters

Returns

void

set_timeout()

set_timeout(timeout): void

Defined in: components/step/base.ts:68

https://concourse-ci.org/docs/steps/modifier-and-hooks/timeout/#timeout-step-modifier

Parameters

timeout

DurationInput

Returns

void

Inherited from

Step.set_timeout

set_trigger()

set_trigger(): void

Defined in: components/step/get.ts:124

Sets "trigger" to true - avoid calling to keep false

https://concourse-ci.org/docs/steps/get/#get-step

Returns

void

set_version()

set_version(version): void

Defined in: components/step/get.ts:138

Sets a specific version of the resource to fetch. If not specified, the latest version will be fetched.

https://concourse-ci.org/docs/steps/get/#get-step

Parameters

version

Version

The version to fetch

Returns

void

customise()

static customise(init): void

Defined in: components/step/get.ts:30

Customises all GetSteps constructed after calling this function.

Type.Customiser

Parameters

init

(instance) => void

Returns

void

customise_base()

static customise_base(init): void

Defined in: components/step/base.ts:28

Customises the base of all Steps constructed after calling this function

Type.Customiser

Parameters

init

(instance) => void

Returns

void

Inherited from

Step.customise_base