Class MachineExecutor

The Linux Virtual Machine Executor.

see: https://circleci.com/docs/2.0/executor-types/#using-machine

Hierarchy

Executor<MachineResourceClass>
- MachineExecutor

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new MachineExecutor(resource_class?: MachineResourceClass, image?: string, docker_layer_caching?: boolean): MachineExecutor

Overrides Executor.constructor
- Defined in src/lib/Components/Executors/exports/MachineExecutor.ts:21
Parameters
- resource_class: MachineResourceClass = 'medium'
- Optional image: string
- Optional docker_layer_caching: boolean
Returns MachineExecutor

Properties

Optional docker_layer_caching

docker_layer_caching?: boolean

image

image: string = 'ubuntu-2004:202010-01'

Select one of the Ubuntu Linux VM Images provided by CircleCI.

see

https://circleci.com/developer/machine

resource_class

resource_class: MachineResourceClass

Accessors

executorLiteral

get executorLiteral(): ExecutorLiteral

Overrides Executor.executorLiteral
- Defined in src/lib/Components/Executors/exports/MachineExecutor.ts:42
Returns ExecutorLiteral

generableType

get generableType(): GenerableType

Overrides Executor.generableType
- Defined in src/lib/Components/Executors/exports/MachineExecutor.ts:38
Returns GenerableType

generateResourceClass

get generateResourceClass(): string | ResourceClass

Inherited from Executor.generateResourceClass
- Defined in src/lib/Components/Executors/exports/Executor.ts:31
Returns string | ResourceClass

Methods

generate

generate(): ExecutorShape

Inherited from Executor.generate
- Defined in src/lib/Components/Executors/exports/Executor.ts:35
Returns ExecutorShape

generateContents

generateContents(): MachineExecutorShape

Overrides Executor.generateContents
- Defined in src/lib/Components/Executors/exports/MachineExecutor.ts:31
Returns MachineExecutorShape

setDockerLayerCaching

setDockerLayerCaching(enabled: boolean): MachineExecutor

- Defined in src/lib/Components/Executors/exports/MachineExecutor.ts:52
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 machine executor.
Returns MachineExecutor
MachineExecutor - The current instance of the MachineExecutor Command.

toReusable

toReusable(name: string, parameters?: CustomParametersList<ExecutorParameterLiteral>): ReusableExecutor

Inherited from Executor.toReusable
- Defined in src/lib/Components/Executors/exports/Executor.ts:42
Parameters
- name: string
- Optional parameters: CustomParametersList<ExecutorParameterLiteral>
Returns ReusableExecutor

Generated using TypeDoc