Class SidecarService

Creates and manages sidecar containers inside a Sandbox.

EXPERIMENTAL: the API is subject to change.

Index

Methods

create get list

Methods

create

create(
    name: string,
    image: Image,
    params?: SidecarCreateParams,
): Promise<SidecarContainer>
Start a new sidecar container in the Sandbox. The Image must already be built by calling Image.build() before it is passed to create.
Parameters
- name: string
- image: Image
- Optionalparams: SidecarCreateParams
Returns Promise<SidecarContainer>
- Defined in src/sandbox_sidecar.ts:135

get

get(name: string, params?: SidecarGetParams): Promise<SidecarContainer>
Return a sidecar container by name.
Parameters
- name: string
- Optionalparams: SidecarGetParams
Returns Promise<SidecarContainer>
- Defined in src/sandbox_sidecar.ts:188

list

list(params?: SidecarListParams): Promise<SidecarContainer[]>
Return all sidecar containers (not including the main container).
Parameters
- Optionalparams: SidecarListParams
Returns Promise<SidecarContainer[]>
- Defined in src/sandbox_sidecar.ts:220