Class WindowsExecutor

A Windows Virtual Machine (CircleCI Cloud)

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

Hierarchy

Executor<WindowsResourceClass>
- WindowsExecutor

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new WindowsExecutor(resource_class?: WindowsResourceClass, image?: string): WindowsExecutor

Overrides Executor.constructor
- Defined in src/lib/Components/Executors/exports/WindowsExecutor.ts:23
Parameters
- resource_class: WindowsResourceClass = 'medium'
- Optional image: string
Returns WindowsExecutor

Properties

image

image: string = 'windows-server-2019-vs2019:stable'

Select one of the available Windows VM Images provided by CircleCI

see

https://circleci.com/developer/machine

resource_class

resource_class: WindowsResourceClass

Static defaultShell

defaultShell: string = 'powershell.exe -ExecutionPolicy Bypass'

Accessors

executorLiteral

get executorLiteral(): ExecutorLiteral

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

generableType

get generableType(): GenerableType

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

generateResourceClass

get generateResourceClass(): WindowsResourceClassGenerated

Overrides Executor.generateResourceClass
- Defined in src/lib/Components/Executors/exports/WindowsExecutor.ts:51
Returns WindowsResourceClassGenerated

Methods

generate

generate(): ExecutorShape

Overrides Executor.generate
- Defined in src/lib/Components/Executors/exports/WindowsExecutor.ts:30
Returns ExecutorShape

generateContents

generateContents(): WindowsExecutorShape

Overrides Executor.generateContents
- Defined in src/lib/Components/Executors/exports/WindowsExecutor.ts:37
Returns WindowsExecutorShape

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