Class SetupRemoteDocker

Creates a remote Docker environment configured to execute Docker commands.

see: https://circleci.com/docs/2.0/configuration-reference/#setupremotedocker

Hierarchy

SetupRemoteDocker

Implements

Command

Index

Constructors

constructor

Properties

parameters

Accessors

Methods

Constructors

constructor

new SetupRemoteDocker(parameters?: SetupRemoteDockerParameters): SetupRemoteDocker

- Defined in src/lib/Components/Commands/exports/Native/SetupRemoteDocker.ts:12
Parameters
- parameters: SetupRemoteDockerParameters = ...
Returns SetupRemoteDocker

Properties

parameters

parameters: SetupRemoteDockerParameters

Step parameters

Accessors

generableType

get generableType(): GenerableType

Implementation of Command.generableType
- Defined in src/lib/Components/Commands/exports/Native/SetupRemoteDocker.ts:31
Type of generable object

Returns GenerableType

name

get name(): string

Implementation of Command.name
- Defined in src/lib/Components/Commands/exports/Native/SetupRemoteDocker.ts:27
The name of the CircleCI step, which will appear in the CircleCI UI.

Returns string

Methods

generate

generate(): SetupRemoteDockerCommandShape

Implementation of Command.generate
- Defined in src/lib/Components/Commands/exports/Native/SetupRemoteDocker.ts:21
Generate SetupRemoteDocker Command shape.

Returns SetupRemoteDockerCommandShape
The generated JSON for the SetupRemoteDocker Commands.

setDockerLayerCaching

setDockerLayerCaching(enabled: boolean): SetupRemoteDocker

- Defined in src/lib/Components/Commands/exports/Native/SetupRemoteDocker.ts:41
Enable docker image layer caching

see
https://circleci.com/docs/2.0/docker-layer-caching/

Parameters
- enabled: boolean
  
  If true, docker layer caching is enabled for the job.
Returns SetupRemoteDocker
SetupRemoteDocker - The current instance of the SetupRemoteDocker Command.

Generated using TypeDoc