Help us shape the future of Go! Take the 2026 Go Developer Survey

client

package
v0.11.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 25, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildChunkPayload 

func BuildChunkPayload(executionsChunkExecutionID string, executionsChunkIndex string) (*executions.ChunkPayload, error)

BuildChunkPayload builds the payload for the executions chunk endpoint from CLI flags.

func BuildGetPayload 

func BuildGetPayload(executionsGetExecutionID string) (*executions.GetPayload, error)

BuildGetPayload builds the payload for the executions get endpoint from CLI flags.

func BuildListPayload 

func BuildListPayload(executionsListNamespace string, executionsListWorkspaceName string, executionsListActorID string, executionsListSince string, executionsListLimit string) (*executions.ListPayload, error)

BuildListPayload builds the payload for the executions list endpoint from CLI flags.

func BuildManifestPayload 

func BuildManifestPayload(executionsManifestExecutionID string) (*executions.ManifestPayload, error)

BuildManifestPayload builds the payload for the executions manifest endpoint from CLI flags.

func BuildStartPayload 

func BuildStartPayload(executionsStartBody string) (*executions.StartPayload, error)

BuildStartPayload builds the payload for the executions start endpoint from CLI flags.

func ChunkExecutionsPath 

func ChunkExecutionsPath(executionID string, index uint64) string

ChunkExecutionsPath returns the URL path to the executions service chunk HTTP endpoint.

func DecodeChunkResponse 

func DecodeChunkResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeChunkResponse returns a decoder for responses returned by the executions chunk endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeChunkResponse may return the following errors:

  • "forbidden" (type executions.Forbidden): http.StatusForbidden
  • "invalid" (type executions.Invalid): http.StatusBadRequest
  • "not_found" (type executions.NotFound): http.StatusNotFound
  • "unauthorized" (type executions.Unauthorized): http.StatusUnauthorized
  • "unavailable" (type executions.Unavailable): http.StatusServiceUnavailable
  • error: internal error

func DecodeGetResponse 

func DecodeGetResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeGetResponse returns a decoder for responses returned by the executions get endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeGetResponse may return the following errors:

  • "forbidden" (type executions.Forbidden): http.StatusForbidden
  • "invalid" (type executions.Invalid): http.StatusBadRequest
  • "not_found" (type executions.NotFound): http.StatusNotFound
  • "unauthorized" (type executions.Unauthorized): http.StatusUnauthorized
  • "unavailable" (type executions.Unavailable): http.StatusServiceUnavailable
  • error: internal error

func DecodeListResponse 

func DecodeListResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeListResponse returns a decoder for responses returned by the executions list endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeListResponse may return the following errors:

  • "forbidden" (type executions.Forbidden): http.StatusForbidden
  • "invalid" (type executions.Invalid): http.StatusBadRequest
  • "not_found" (type executions.NotFound): http.StatusNotFound
  • "unauthorized" (type executions.Unauthorized): http.StatusUnauthorized
  • "unavailable" (type executions.Unavailable): http.StatusServiceUnavailable
  • error: internal error

func DecodeManifestResponse 

func DecodeManifestResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeManifestResponse returns a decoder for responses returned by the executions manifest endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeManifestResponse may return the following errors:

  • "forbidden" (type executions.Forbidden): http.StatusForbidden
  • "invalid" (type executions.Invalid): http.StatusBadRequest
  • "not_found" (type executions.NotFound): http.StatusNotFound
  • "unauthorized" (type executions.Unauthorized): http.StatusUnauthorized
  • "unavailable" (type executions.Unavailable): http.StatusServiceUnavailable
  • error: internal error

func DecodeStartResponse 

func DecodeStartResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeStartResponse returns a decoder for responses returned by the executions start endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeStartResponse may return the following errors:

  • "forbidden" (type executions.Forbidden): http.StatusForbidden
  • "invalid" (type executions.Invalid): http.StatusBadRequest
  • "not_found" (type executions.NotFound): http.StatusNotFound
  • "unauthorized" (type executions.Unauthorized): http.StatusUnauthorized
  • "unavailable" (type executions.Unavailable): http.StatusServiceUnavailable
  • error: internal error

func DecodeStatusResponse 

func DecodeStatusResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeStatusResponse returns a decoder for responses returned by the executions status endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeStatusResponse may return the following errors:

  • "forbidden" (type executions.Forbidden): http.StatusForbidden
  • "invalid" (type executions.Invalid): http.StatusBadRequest
  • "not_found" (type executions.NotFound): http.StatusNotFound
  • "unauthorized" (type executions.Unauthorized): http.StatusUnauthorized
  • "unavailable" (type executions.Unavailable): http.StatusServiceUnavailable
  • error: internal error

func EncodeListRequest 

func EncodeListRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeListRequest returns an encoder for requests sent to the executions list server.

func EncodeStartRequest 

func EncodeStartRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeStartRequest returns an encoder for requests sent to the executions start server.

func GetExecutionsPath 

func GetExecutionsPath(executionID string) string

GetExecutionsPath returns the URL path to the executions service get HTTP endpoint.

func ListExecutionsPath 

func ListExecutionsPath() string

ListExecutionsPath returns the URL path to the executions service list HTTP endpoint.

func ManifestExecutionsPath 

func ManifestExecutionsPath(executionID string) string

ManifestExecutionsPath returns the URL path to the executions service manifest HTTP endpoint.

func NewChunkExecutionRecordingChunkOK 

func NewChunkExecutionRecordingChunkOK(body *ChunkResponseBody) *executions.ExecutionRecordingChunk

NewChunkExecutionRecordingChunkOK builds a "executions" service "chunk" endpoint result from a HTTP "OK" response.

func NewChunkForbidden 

func NewChunkForbidden(body string) executions.Forbidden

NewChunkForbidden builds a executions service chunk endpoint forbidden error.

func NewChunkInvalid 

func NewChunkInvalid(body string) executions.Invalid

NewChunkInvalid builds a executions service chunk endpoint invalid error.

func NewChunkNotFound 

func NewChunkNotFound(body string) executions.NotFound

NewChunkNotFound builds a executions service chunk endpoint not_found error.

func NewChunkUnauthorized 

func NewChunkUnauthorized(body string) executions.Unauthorized

NewChunkUnauthorized builds a executions service chunk endpoint unauthorized error.

func NewChunkUnavailable 

func NewChunkUnavailable(body string) executions.Unavailable

NewChunkUnavailable builds a executions service chunk endpoint unavailable error.

func NewGetExecutionRecordOK 

func NewGetExecutionRecordOK(body *GetResponseBody) *executionsviews.ExecutionRecordView

NewGetExecutionRecordOK builds a "executions" service "get" endpoint result from a HTTP "OK" response.

func NewGetForbidden 

func NewGetForbidden(body string) executions.Forbidden

NewGetForbidden builds a executions service get endpoint forbidden error.

func NewGetInvalid 

func NewGetInvalid(body string) executions.Invalid

NewGetInvalid builds a executions service get endpoint invalid error.

func NewGetNotFound 

func NewGetNotFound(body string) executions.NotFound

NewGetNotFound builds a executions service get endpoint not_found error.

func NewGetUnauthorized 

func NewGetUnauthorized(body string) executions.Unauthorized

NewGetUnauthorized builds a executions service get endpoint unauthorized error.

func NewGetUnavailable 

func NewGetUnavailable(body string) executions.Unavailable

NewGetUnavailable builds a executions service get endpoint unavailable error.

func NewListExecutionRecordOK 

func NewListExecutionRecordOK(body []*ExecutionRecordResponse) []*executions.ExecutionRecord

NewListExecutionRecordOK builds a "executions" service "list" endpoint result from a HTTP "OK" response.

func NewListForbidden 

func NewListForbidden(body string) executions.Forbidden

NewListForbidden builds a executions service list endpoint forbidden error.

func NewListInvalid 

func NewListInvalid(body string) executions.Invalid

NewListInvalid builds a executions service list endpoint invalid error.

func NewListNotFound 

func NewListNotFound(body string) executions.NotFound

NewListNotFound builds a executions service list endpoint not_found error.

func NewListUnauthorized 

func NewListUnauthorized(body string) executions.Unauthorized

NewListUnauthorized builds a executions service list endpoint unauthorized error.

func NewListUnavailable 

func NewListUnavailable(body string) executions.Unavailable

NewListUnavailable builds a executions service list endpoint unavailable error.

func NewManifestExecutionRecordingManifestOK 

func NewManifestExecutionRecordingManifestOK(body *ManifestResponseBody) *executions.ExecutionRecordingManifest

NewManifestExecutionRecordingManifestOK builds a "executions" service "manifest" endpoint result from a HTTP "OK" response.

func NewManifestForbidden 

func NewManifestForbidden(body string) executions.Forbidden

NewManifestForbidden builds a executions service manifest endpoint forbidden error.

func NewManifestInvalid 

func NewManifestInvalid(body string) executions.Invalid

NewManifestInvalid builds a executions service manifest endpoint invalid error.

func NewManifestNotFound 

func NewManifestNotFound(body string) executions.NotFound

NewManifestNotFound builds a executions service manifest endpoint not_found error.

func NewManifestUnauthorized 

func NewManifestUnauthorized(body string) executions.Unauthorized

NewManifestUnauthorized builds a executions service manifest endpoint unauthorized error.

func NewManifestUnavailable 

func NewManifestUnavailable(body string) executions.Unavailable

NewManifestUnavailable builds a executions service manifest endpoint unavailable error.

func NewStartExecutionCommandOK 

func NewStartExecutionCommandOK(body *StartResponseBody) *executionsviews.ExecutionCommandView

NewStartExecutionCommandOK builds a "executions" service "start" endpoint result from a HTTP "OK" response.

func NewStartForbidden 

func NewStartForbidden(body string) executions.Forbidden

NewStartForbidden builds a executions service start endpoint forbidden error.

func NewStartInvalid 

func NewStartInvalid(body string) executions.Invalid

NewStartInvalid builds a executions service start endpoint invalid error.

func NewStartNotFound 

func NewStartNotFound(body string) executions.NotFound

NewStartNotFound builds a executions service start endpoint not_found error.

func NewStartUnauthorized 

func NewStartUnauthorized(body string) executions.Unauthorized

NewStartUnauthorized builds a executions service start endpoint unauthorized error.

func NewStartUnavailable 

func NewStartUnavailable(body string) executions.Unavailable

NewStartUnavailable builds a executions service start endpoint unavailable error.

func NewStatusExecutionStatusOK 

func NewStatusExecutionStatusOK(body *StatusResponseBody) *executionsviews.ExecutionStatusView

NewStatusExecutionStatusOK builds a "executions" service "status" endpoint result from a HTTP "OK" response.

func NewStatusForbidden 

func NewStatusForbidden(body string) executions.Forbidden

NewStatusForbidden builds a executions service status endpoint forbidden error.

func NewStatusInvalid 

func NewStatusInvalid(body string) executions.Invalid

NewStatusInvalid builds a executions service status endpoint invalid error.

func NewStatusNotFound 

func NewStatusNotFound(body string) executions.NotFound

NewStatusNotFound builds a executions service status endpoint not_found error.

func NewStatusUnauthorized 

func NewStatusUnauthorized(body string) executions.Unauthorized

NewStatusUnauthorized builds a executions service status endpoint unauthorized error.

func NewStatusUnavailable 

func NewStatusUnavailable(body string) executions.Unavailable

NewStatusUnavailable builds a executions service status endpoint unavailable error.

func StartExecutionsPath 

func StartExecutionsPath() string

StartExecutionsPath returns the URL path to the executions service start HTTP endpoint.

func StatusExecutionsPath 

func StatusExecutionsPath() string

StatusExecutionsPath returns the URL path to the executions service status HTTP endpoint.

func ValidateChunkResponseBody 

func ValidateChunkResponseBody(body *ChunkResponseBody) (err error)

ValidateChunkResponseBody runs the validations defined on ChunkResponseBody

func ValidateExecutionRecordResponse 

func ValidateExecutionRecordResponse(body *ExecutionRecordResponse) (err error)

ValidateExecutionRecordResponse runs the validations defined on Execution-RecordResponse

func ValidateExecutionScriptPayloadRequestBody added in v0.11.0 

func ValidateExecutionScriptPayloadRequestBody(body *ExecutionScriptPayloadRequestBody) (err error)

ValidateExecutionScriptPayloadRequestBody runs the validations defined on ExecutionScriptPayloadRequestBody

func ValidateManifestResponseBody 

func ValidateManifestResponseBody(body *ManifestResponseBody) (err error)

ValidateManifestResponseBody runs the validations defined on ManifestResponseBody

Types

type ChunkResponseBody 

type ChunkResponseBody struct {
	// Chunk index starting at 0
	Index *uint64 `form:"index,omitempty" json:"index,omitempty" xml:"index,omitempty"`
	// Base64-encoded plaintext recording data
	Data []byte `form:"data,omitempty" json:"data,omitempty" xml:"data,omitempty"`
}

ChunkResponseBody is the type of the "executions" service "chunk" endpoint HTTP response body.

type Client 

type Client struct {
	// Status Doer is the HTTP client used to make requests to the status endpoint.
	StatusDoer goahttp.Doer

	// List Doer is the HTTP client used to make requests to the list endpoint.
	ListDoer goahttp.Doer

	// Get Doer is the HTTP client used to make requests to the get endpoint.
	GetDoer goahttp.Doer

	// Start Doer is the HTTP client used to make requests to the start endpoint.
	StartDoer goahttp.Doer

	// Manifest Doer is the HTTP client used to make requests to the manifest
	// endpoint.
	ManifestDoer goahttp.Doer

	// Chunk Doer is the HTTP client used to make requests to the chunk endpoint.
	ChunkDoer goahttp.Doer

	// RestoreResponseBody controls whether the response bodies are reset after
	// decoding so they can be read again.
	RestoreResponseBody bool
	// contains filtered or unexported fields
}

Client lists the executions service endpoint HTTP clients.

func NewClient 

func NewClient(
	scheme string,
	host string,
	doer goahttp.Doer,
	enc func(*http.Request) goahttp.Encoder,
	dec func(*http.Response) goahttp.Decoder,
	restoreBody bool,
) *Client

NewClient instantiates HTTP clients for all the executions service servers.

func (*Client) BuildChunkRequest 

func (c *Client) BuildChunkRequest(ctx context.Context, v any) (*http.Request, error)

BuildChunkRequest instantiates a HTTP request object with method and path set to call the "executions" service "chunk" endpoint

func (*Client) BuildGetRequest 

func (c *Client) BuildGetRequest(ctx context.Context, v any) (*http.Request, error)

BuildGetRequest instantiates a HTTP request object with method and path set to call the "executions" service "get" endpoint

func (*Client) BuildListRequest 

func (c *Client) BuildListRequest(ctx context.Context, v any) (*http.Request, error)

BuildListRequest instantiates a HTTP request object with method and path set to call the "executions" service "list" endpoint

func (*Client) BuildManifestRequest 

func (c *Client) BuildManifestRequest(ctx context.Context, v any) (*http.Request, error)

BuildManifestRequest instantiates a HTTP request object with method and path set to call the "executions" service "manifest" endpoint

func (*Client) BuildStartRequest 

func (c *Client) BuildStartRequest(ctx context.Context, v any) (*http.Request, error)

BuildStartRequest instantiates a HTTP request object with method and path set to call the "executions" service "start" endpoint

func (*Client) BuildStatusRequest 

func (c *Client) BuildStatusRequest(ctx context.Context, v any) (*http.Request, error)

BuildStatusRequest instantiates a HTTP request object with method and path set to call the "executions" service "status" endpoint

func (*Client) Chunk 

func (c *Client) Chunk() goa.Endpoint

Chunk returns an endpoint that makes HTTP requests to the executions service chunk server.

func (*Client) Get 

func (c *Client) Get() goa.Endpoint

Get returns an endpoint that makes HTTP requests to the executions service get server.

func (*Client) List 

func (c *Client) List() goa.Endpoint

List returns an endpoint that makes HTTP requests to the executions service list server.

func (*Client) Manifest 

func (c *Client) Manifest() goa.Endpoint

Manifest returns an endpoint that makes HTTP requests to the executions service manifest server.

func (*Client) Start 

func (c *Client) Start() goa.Endpoint

Start returns an endpoint that makes HTTP requests to the executions service start server.

func (*Client) Status 

func (c *Client) Status() goa.Endpoint

Status returns an endpoint that makes HTTP requests to the executions service status server.

type ExecutionRecordResponse 

type ExecutionRecordResponse struct {
	// Execution identifier
	ExecutionID *string `form:"execution_id,omitempty" json:"execution_id,omitempty" xml:"execution_id,omitempty"`
	// Actor identifier
	ActorID *string `form:"actor_id,omitempty" json:"actor_id,omitempty" xml:"actor_id,omitempty"`
	// command|script|shell
	Operation           *string `form:"operation,omitempty" json:"operation,omitempty" xml:"operation,omitempty"`
	Namespace           *string `form:"namespace,omitempty" json:"namespace,omitempty" xml:"namespace,omitempty"`
	WorkspaceName       *string `form:"workspace_name,omitempty" json:"workspace_name,omitempty" xml:"workspace_name,omitempty"`
	WorkspaceUID        *string `form:"workspace_uid,omitempty" json:"workspace_uid,omitempty" xml:"workspace_uid,omitempty"`
	WorkspaceGeneration *int64  `form:"workspace_generation,omitempty" json:"workspace_generation,omitempty" xml:"workspace_generation,omitempty"`
	GrantVersion        *string `form:"grant_version,omitempty" json:"grant_version,omitempty" xml:"grant_version,omitempty"`
	OsIdentity          *string `form:"os_identity,omitempty" json:"os_identity,omitempty" xml:"os_identity,omitempty"`
	Elevated            *bool   `form:"elevated,omitempty" json:"elevated,omitempty" xml:"elevated,omitempty"`
	RecordingID         *string `form:"recording_id,omitempty" json:"recording_id,omitempty" xml:"recording_id,omitempty"`
	// Storage mode: ephemeral|external|bundled
	Mode *string `form:"mode,omitempty" json:"mode,omitempty" xml:"mode,omitempty"`
	// none|durable
	Durability *string `form:"durability,omitempty" json:"durability,omitempty" xml:"durability,omitempty"`
	Admitted   *bool   `form:"admitted,omitempty" json:"admitted,omitempty" xml:"admitted,omitempty"`
	// RFC3339 timestamp
	AdmissionTime *string `form:"admission_time,omitempty" json:"admission_time,omitempty" xml:"admission_time,omitempty"`
	DenyReason    *string `form:"deny_reason,omitempty" json:"deny_reason,omitempty" xml:"deny_reason,omitempty"`
	// lifecycle state
	State *string `form:"state,omitempty" json:"state,omitempty" xml:"state,omitempty"`
	// RFC3339 timestamp
	StartTime *string `form:"start_time,omitempty" json:"start_time,omitempty" xml:"start_time,omitempty"`
	// RFC3339 timestamp
	EndTime       *string `form:"end_time,omitempty" json:"end_time,omitempty" xml:"end_time,omitempty"`
	ExitCode      *int    `form:"exit_code,omitempty" json:"exit_code,omitempty" xml:"exit_code,omitempty"`
	Termination   *string `form:"termination,omitempty" json:"termination,omitempty" xml:"termination,omitempty"`
	RecordingLost *bool   `form:"recording_lost,omitempty" json:"recording_lost,omitempty" xml:"recording_lost,omitempty"`
}

ExecutionRecordResponse is used to define fields on response body types.

type ExecutionScriptPayloadRequestBody added in v0.11.0 

type ExecutionScriptPayloadRequestBody struct {
	// Script content
	Body string `form:"body" json:"body" xml:"body"`
	// Optional filename hint (e.g. run.sh, script.ps1)
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Optional working directory for the script
	Cwd *string `form:"cwd,omitempty" json:"cwd,omitempty" xml:"cwd,omitempty"`
}

ExecutionScriptPayloadRequestBody is used to define fields on request body types.

type GetResponseBody 

type GetResponseBody struct {
	// Execution identifier
	ExecutionID *string `form:"execution_id,omitempty" json:"execution_id,omitempty" xml:"execution_id,omitempty"`
	// Actor identifier
	ActorID *string `form:"actor_id,omitempty" json:"actor_id,omitempty" xml:"actor_id,omitempty"`
	// command|script|shell
	Operation           *string `form:"operation,omitempty" json:"operation,omitempty" xml:"operation,omitempty"`
	Namespace           *string `form:"namespace,omitempty" json:"namespace,omitempty" xml:"namespace,omitempty"`
	WorkspaceName       *string `form:"workspace_name,omitempty" json:"workspace_name,omitempty" xml:"workspace_name,omitempty"`
	WorkspaceUID        *string `form:"workspace_uid,omitempty" json:"workspace_uid,omitempty" xml:"workspace_uid,omitempty"`
	WorkspaceGeneration *int64  `form:"workspace_generation,omitempty" json:"workspace_generation,omitempty" xml:"workspace_generation,omitempty"`
	GrantVersion        *string `form:"grant_version,omitempty" json:"grant_version,omitempty" xml:"grant_version,omitempty"`
	OsIdentity          *string `form:"os_identity,omitempty" json:"os_identity,omitempty" xml:"os_identity,omitempty"`
	Elevated            *bool   `form:"elevated,omitempty" json:"elevated,omitempty" xml:"elevated,omitempty"`
	RecordingID         *string `form:"recording_id,omitempty" json:"recording_id,omitempty" xml:"recording_id,omitempty"`
	// Storage mode: ephemeral|external|bundled
	Mode *string `form:"mode,omitempty" json:"mode,omitempty" xml:"mode,omitempty"`
	// none|durable
	Durability *string `form:"durability,omitempty" json:"durability,omitempty" xml:"durability,omitempty"`
	Admitted   *bool   `form:"admitted,omitempty" json:"admitted,omitempty" xml:"admitted,omitempty"`
	// RFC3339 timestamp
	AdmissionTime *string `form:"admission_time,omitempty" json:"admission_time,omitempty" xml:"admission_time,omitempty"`
	DenyReason    *string `form:"deny_reason,omitempty" json:"deny_reason,omitempty" xml:"deny_reason,omitempty"`
	// lifecycle state
	State *string `form:"state,omitempty" json:"state,omitempty" xml:"state,omitempty"`
	// RFC3339 timestamp
	StartTime *string `form:"start_time,omitempty" json:"start_time,omitempty" xml:"start_time,omitempty"`
	// RFC3339 timestamp
	EndTime       *string `form:"end_time,omitempty" json:"end_time,omitempty" xml:"end_time,omitempty"`
	ExitCode      *int    `form:"exit_code,omitempty" json:"exit_code,omitempty" xml:"exit_code,omitempty"`
	Termination   *string `form:"termination,omitempty" json:"termination,omitempty" xml:"termination,omitempty"`
	RecordingLost *bool   `form:"recording_lost,omitempty" json:"recording_lost,omitempty" xml:"recording_lost,omitempty"`
}

GetResponseBody is the type of the "executions" service "get" endpoint HTTP response body.

type ManifestResponseBody 

type ManifestResponseBody struct {
	RecordingID    *string `form:"recording_id,omitempty" json:"recording_id,omitempty" xml:"recording_id,omitempty"`
	Chunks         *uint64 `form:"chunks,omitempty" json:"chunks,omitempty" xml:"chunks,omitempty"`
	PlaintextBytes *int64  `form:"plaintext_bytes,omitempty" json:"plaintext_bytes,omitempty" xml:"plaintext_bytes,omitempty"`
	Verified       *bool   `form:"verified,omitempty" json:"verified,omitempty" xml:"verified,omitempty"`
}

ManifestResponseBody is the type of the "executions" service "manifest" endpoint HTTP response body.

type StartRequestBody 

type StartRequestBody struct {
	// Workspace namespace
	Namespace string `form:"namespace" json:"namespace" xml:"namespace"`
	// Workspace name
	WorkspaceName string `form:"workspace_name" json:"workspace_name" xml:"workspace_name"`
	// Absolute path or name of the program to run
	Executable *string `form:"executable,omitempty" json:"executable,omitempty" xml:"executable,omitempty"`
	// Arguments passed to the executable verbatim
	Args []string `form:"args,omitempty" json:"args,omitempty" xml:"args,omitempty"`
	// Optional working directory for the new process
	Cwd *string `form:"cwd,omitempty" json:"cwd,omitempty" xml:"cwd,omitempty"`
	// Guest execution deadline in seconds
	DeadlineSeconds int `form:"deadline_seconds" json:"deadline_seconds" xml:"deadline_seconds"`
	// Script to execute (mutually exclusive with executable/args)
	Script *ExecutionScriptPayloadRequestBody `form:"script,omitempty" json:"script,omitempty" xml:"script,omitempty"`
}

StartRequestBody is the type of the "executions" service "start" endpoint HTTP request body.

func NewStartRequestBody 

func NewStartRequestBody(p *executions.StartPayload) *StartRequestBody

NewStartRequestBody builds the HTTP request body from the payload of the "start" endpoint of the "executions" service.

type StartResponseBody 

type StartResponseBody struct {
	// Execution identifier
	ExecutionID *string `form:"execution_id,omitempty" json:"execution_id,omitempty" xml:"execution_id,omitempty"`
	// Recording identifier
	RecordingID   *string `form:"recording_id,omitempty" json:"recording_id,omitempty" xml:"recording_id,omitempty"`
	Namespace     *string `form:"namespace,omitempty" json:"namespace,omitempty" xml:"namespace,omitempty"`
	WorkspaceName *string `form:"workspace_name,omitempty" json:"workspace_name,omitempty" xml:"workspace_name,omitempty"`
	WorkspaceUID  *string `form:"workspace_uid,omitempty" json:"workspace_uid,omitempty" xml:"workspace_uid,omitempty"`
	// RFC3339 timestamp
	AdmissionTime *string `form:"admission_time,omitempty" json:"admission_time,omitempty" xml:"admission_time,omitempty"`
	// Storage mode: ephemeral|external|bundled
	Mode *string `form:"mode,omitempty" json:"mode,omitempty" xml:"mode,omitempty"`
	// none|durable
	Durability *string `form:"durability,omitempty" json:"durability,omitempty" xml:"durability,omitempty"`
	// Final command outcome
	Outcome *string `form:"outcome,omitempty" json:"outcome,omitempty" xml:"outcome,omitempty"`
	// Final lifecycle state
	State *string `form:"state,omitempty" json:"state,omitempty" xml:"state,omitempty"`
	// Guest process exit code when known
	ExitCode *int `form:"exit_code,omitempty" json:"exit_code,omitempty" xml:"exit_code,omitempty"`
	// Standard output, truncated to the pilot output bound
	Stdout []byte `form:"stdout,omitempty" json:"stdout,omitempty" xml:"stdout,omitempty"`
	// Standard error, truncated to the pilot output bound
	Stderr []byte `form:"stderr,omitempty" json:"stderr,omitempty" xml:"stderr,omitempty"`
	// Output was truncated at the 16 KiB bound
	Truncated *bool `form:"truncated,omitempty" json:"truncated,omitempty" xml:"truncated,omitempty"`
	// Guest-measured duration in milliseconds
	DurationMs *uint64 `form:"duration_ms,omitempty" json:"duration_ms,omitempty" xml:"duration_ms,omitempty"`
	// Runner denial or transport-loss note
	Denial *string `form:"denial,omitempty" json:"denial,omitempty" xml:"denial,omitempty"`
}

StartResponseBody is the type of the "executions" service "start" endpoint HTTP response body.

type StatusResponseBody 

type StatusResponseBody struct {
	// Whether VM execution is enabled by policy
	Enabled *bool `form:"enabled,omitempty" json:"enabled,omitempty" xml:"enabled,omitempty"`
	// Whether elevated execution is allowed by policy
	AllowElevated *bool `form:"allow_elevated,omitempty" json:"allow_elevated,omitempty" xml:"allow_elevated,omitempty"`
	// Storage mode: disabled|ephemeral|external|bundled
	StorageMode *string `form:"storage_mode,omitempty" json:"storage_mode,omitempty" xml:"storage_mode,omitempty"`
	// Metadata and recordings are durable (not ephemeral)
	Durable *bool `form:"durable,omitempty" json:"durable,omitempty" xml:"durable,omitempty"`
	// Store is Ready and can admit work
	StorageAvailable *bool `form:"storage_available,omitempty" json:"storage_available,omitempty" xml:"storage_available,omitempty"`
	// Opt-in management issuer prerequisites and initial bootstrap sync are ready;
	// not a guest execution capability
	IssuerReady *bool `form:"issuer_ready,omitempty" json:"issuer_ready,omitempty" xml:"issuer_ready,omitempty"`
}

StatusResponseBody is the type of the "executions" service "status" endpoint HTTP response body.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.