Class.PutStep - DecentM/concourse-ts GitHub Wiki

Class: PutStep<Source, PutParams, GetParams>

Pushes to a resource. When the step succeeds, the resulting version is immediately fetched into a directory with the same name as the resource.

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

Extends

Step<PutStep>

Type Parameters

• Source extends Config = Config

• PutParams extends Config = Config

• GetParams extends Config = Config

Constructors

new PutStep()

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

Defined in: components/step/put.ts:33

Parameters

name

string

customise?

(instance) => void

Returns

PutStep<Source, PutParams, GetParams>

Overrides

Step<Type.PutStep>.constructor

Properties

name

name: string

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

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_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

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_params()

set_get_params(params): void

Defined in: components/step/put.ts:126

Sets parameters to pass when fetching the version that was pushed. By default, the implicit get step uses the same parameters as the original get step that fetched the resource.

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

Parameters

params

GetParams

Resource-specific get parameters

Returns

void

set_inputs()

set_inputs(inputs): void

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

Specifies which inputs (artifacts) should be available when pushing. Can be 'all', 'detect', or a list of specific input names.

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

Parameters

inputs

Inputs

Input specification

Returns

void

set_no_get()

set_no_get(): void

Defined in: components/step/put.ts:142

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

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

Returns

void

set_params()

set_params(params): void

Defined in: components/step/put.ts:111

Sets resource-specific parameters to pass to the resource when pushing. These parameters are defined by the resource type.

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

Parameters

params

PutParams

Resource-specific put parameters

Returns

void

set_put()

set_put<ResourceType>(resource): void

Defined in: components/step/put.ts:55

Sets the resource to push to.

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

Type Parameters

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

Parameters

resource

ResourceType

The resource to push to

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

customise()

static customise(init): void

Defined in: components/step/put.ts:29

Customises all PutSteps 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