execution-target
execution-target
Section titled “execution-target”| Field | Value |
|---|---|
| Prefix | execution-target |
| Namespace constant | ExecutionTargetNamespace |
| Subjects constant | ExecutionTargetSubjects |
| Kind | bus |
| Schema record | ExecutionTargetSchemas |
| Tier | framework |
| Package | @makaio/services-core |
| Defined in | packages/services/core/src/execution-target/namespace.ts |
Subjects
Section titled “Subjects”| Key | Wire | Type | Schema |
|---|---|---|---|
created | execution-target.created | event | schemas.ts |
delete | execution-target.delete | rpc | schemas.ts |
deleted | execution-target.deleted | event | schemas.ts |
get | execution-target.get | rpc | schemas.ts |
list | execution-target.list | rpc | schemas.ts |
resolve | execution-target.resolve | rpc | schemas.ts |
set | execution-target.set | rpc | schemas.ts |
updated | execution-target.updated | event | schemas.ts |
Subject Details
Section titled “Subject Details”execution-target.created (event)
Section titled “execution-target.created (event)”Subject: execution-target.created
Type: Event
| Field | Type | Required |
|---|---|---|
createdAt | number | yes |
description | string | undefined | no |
enabled | boolean | yes |
id | string | yes |
name | string | yes |
scope | string | yes |
type | "local" | "container-local" | "container-isolated" | yes |
updatedAt | number | yes |
execution-target.delete (rpc)
Section titled “execution-target.delete (rpc)”Subject: execution-target.delete
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
id | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
deleted | boolean | yes |
execution-target.deleted (event)
Section titled “execution-target.deleted (event)”Subject: execution-target.deleted
Type: Event
| Field | Type | Required |
|---|---|---|
id | string | yes |
execution-target.get (rpc)
Section titled “execution-target.get (rpc)”Subject: execution-target.get
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
id | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
executionTarget | { id: string; name: string; scope: string; enabled: boolean; createdAt: number; updatedAt: number; type: "local"; description?: string | undefined; } | { id: string; name: string; scope: string; enabled: boolean; createdAt: number; updatedAt: number; type: "container-local"; description?: string | undefined; image?: string | undefined; env?: Record<string, string> | undefined; busUrl?: string | undefined; } | { id: string; name: string; scope: string; enabled: boolean; createdAt: number; updatedAt: number; type: "container-isolated"; busMode: "relay" | "host"; gitCredentialMode: "token" | "ssh-agent"; description?: string | undefined; image?: string | undefined; env?: Record<string, string> | undefined; relayUrl?: string | undefined; repoUrl?: string | undefined; } | null | yes |
execution-target.list (rpc)
Section titled “execution-target.list (rpc)”Subject: execution-target.list
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
scope | string | undefined | no |
type | "local" | "container-local" | "container-isolated" | undefined | no |
Response:
| Field | Type | Required |
|---|---|---|
executionTargets | ({ id: string; name: string; scope: string; enabled: boolean; createdAt: number; updatedAt: number; type: "local"; description?: string | undefined; } | { id: string; name: string; scope: string; enabled: boolean; createdAt: number; updatedAt: number; type: "container-local"; description?: string | undefined; image?: string | undefined; env?: Record<string, string> | undefined; busUrl?: string | undefined; } | { id: string; name: string; scope: string; enabled: boolean; createdAt: number; updatedAt: number; type: "container-isolated"; busMode: "relay" | "host"; gitCredentialMode: "token" | "ssh-agent"; description?: string | undefined; image?: string | undefined; env?: Record<string, string> | undefined; relayUrl?: string | undefined; repoUrl?: string | undefined; })[] | yes |
execution-target.resolve (rpc)
Section titled “execution-target.resolve (rpc)”Subject: execution-target.resolve
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
executionTargetId | string | undefined | no |
projectId | string | undefined | no |
workstreamId | string | undefined | no |
Response:
| Field | Type | Required |
|---|---|---|
executionTarget | { id: string; name: string; scope: string; enabled: boolean; createdAt: number; updatedAt: number; type: "local"; description?: string | undefined; } | { id: string; name: string; scope: string; enabled: boolean; createdAt: number; updatedAt: number; type: "container-local"; description?: string | undefined; image?: string | undefined; env?: Record<string, string> | undefined; busUrl?: string | undefined; } | { id: string; name: string; scope: string; enabled: boolean; createdAt: number; updatedAt: number; type: "container-isolated"; busMode: "relay" | "host"; gitCredentialMode: "token" | "ssh-agent"; description?: string | undefined; image?: string | undefined; env?: Record<string, string> | undefined; relayUrl?: string | undefined; repoUrl?: string | undefined; } | yes |
execution-target.set (rpc)
Section titled “execution-target.set (rpc)”Subject: execution-target.set
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
executionTarget | { type: "local"; id: string; name: string; enabled: boolean; scope: string; description?: string | undefined; } | { type: "container-local"; id: string; name: string; enabled: boolean; scope: string; description?: string | undefined; image?: string | undefined; env?: Record<string, string> | undefined; busUrl?: string | undefined; } | { type: "container-isolated"; id: string; name: string; enabled: boolean; scope: string; busMode: "relay" | "host"; gitCredentialMode: "token" | "ssh-agent"; description?: string | undefined; image?: string | undefined; env?: Record<string, string> | undefined; relayUrl?: string | undefined; repoUrl?: string | undefined; } | yes |
Response:
| Field | Type | Required |
|---|---|---|
id | string | yes |
execution-target.updated (event)
Section titled “execution-target.updated (event)”Subject: execution-target.updated
Type: Event
| Field | Type | Required |
|---|---|---|
createdAt | number | yes |
description | string | undefined | no |
enabled | boolean | yes |
id | string | yes |
name | string | yes |
scope | string | yes |
type | "local" | "container-local" | "container-isolated" | yes |
updatedAt | number | yes |
Auto-generated by yarn docs:bus. Do not edit manually.