Class Image

Description

Sandbox の起動に使用するコンテナイメージ

Index

Constructors

Accessors

Methods

build dockerfileCommands delete fromAwsEcr fromGcpArtifactRegistry fromId fromRegistry

Constructors

constructor

new Image(
    client: ModalClient,
    imageId: string,
    tag: string,
    imageRegistryConfig?: ImageRegistryConfig,
    layers?: Layer[],
): Image
Internal
Parameters
- client: ModalClient
- imageId: string
- tag: string
- OptionalimageRegistryConfig: ImageRegistryConfig
- Optionallayers: Layer[]
Returns Image
- Defined in src/image.ts:193

Accessors

imageId

get imageId(): string
Returns string
- Defined in src/image.ts:212

Methods

build

build(app: App): Promise<Image>
Parameters
- app: App
  ビルドに使用する App
Returns Promise<Image>
ビルドされた Image インスタンス

Description
Modal 上で Image を即座にビルドする
- Defined in src/image.ts:294

dockerfileCommands

dockerfileCommands(
commands: string[],
params?: ImageDockerfileCommandsParams,
): Image
Parameters
- commands: string[]
  Dockerfile コマンドの文字列配列
- Optionalparams: ImageDockerfileCommandsParams
  このレイヤーのビルド設定
Returns Image
新しい Image インスタンス

Description
任意の Dockerfile コマンドで Image を拡張する。各呼び出しは順次ビルドされる新しいレイヤーを作成する
- Defined in src/image.ts:261

`Static`delete

delete(imageId: string, _?: ImageDeleteParams): Promise<void>
Parameters
- imageId: string
- _: ImageDeleteParams = {}
Returns Promise<void>
Deprecated
Use client.images.delete() instead.
- Defined in src/image.ts:409

`Static`fromAwsEcr

fromAwsEcr(tag: string, secret: Secret): Image
Parameters
- tag: string
- secret: Secret
Returns Image
Deprecated
Use client.images.fromAwsEcr() instead.
- Defined in src/image.ts:233

`Static`fromGcpArtifactRegistry

fromGcpArtifactRegistry(tag: string, secret: Secret): Image
Parameters
- tag: string
- secret: Secret
Returns Image
Deprecated
Use client.images.fromGcpArtifactRegistry() instead.
- Defined in src/image.ts:240

`Static`fromId

fromId(imageId: string): Promise<Image>
Parameters
- imageId: string
Returns Promise<Image>
Deprecated
Use client.images.fromId() instead.
- Defined in src/image.ts:219

`Static`fromRegistry

fromRegistry(tag: string, secret?: Secret): Image
Parameters
- tag: string
- Optionalsecret: Secret
Returns Image
Deprecated
Use client.images.fromRegistry() instead.
- Defined in src/image.ts:226