Documentation
¶
Overview ¶
Package client provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.
Package client is the typed, generated client for the Dexaflow (Airflow-compatible) /api/v2 surface. It is the single control-plane client shared by the CLI, the MCP server, and the smoke tests (ADR 0050 D8) — no component hand-rolls HTTP against /api/v2, and nothing here imports internal/ packages.
client.gen.go is generated from docs/api/openapi.yaml. Do not edit it by hand; run `make pkg-client` from the repo root after changing the spec (the oapi-codegen config's output path is repo-root-relative, so generation must run from there, not via `go generate` in this package). CI catches drift with `make pkg-client-check`.
Index ¶
- Constants
- Variables
- func DryRunRegister(_ context.Context, req *http.Request) error
- func NewClearDagRunRequest(server string, dagId DagID, dagRunId DagRunID, body ClearDagRunJSONRequestBody) (*http.Request, error)
- func NewClearDagRunRequestWithBody(server string, dagId DagID, dagRunId DagRunID, contentType string, ...) (*http.Request, error)
- func NewClearTaskInstancesRequest(server string, dagId DagID, body ClearTaskInstancesJSONRequestBody) (*http.Request, error)
- func NewClearTaskInstancesRequestWithBody(server string, dagId DagID, contentType string, body io.Reader) (*http.Request, error)
- func NewCreateAPITokenRequest(server string, body CreateAPITokenJSONRequestBody) (*http.Request, error)
- func NewCreateAPITokenRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewCreateConnectionRequest(server string, body CreateConnectionJSONRequestBody) (*http.Request, error)
- func NewCreateConnectionRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewCreateUserRequest(server string, body CreateUserJSONRequestBody) (*http.Request, error)
- func NewCreateUserRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewCreateVariableRequest(server string, body CreateVariableJSONRequestBody) (*http.Request, error)
- func NewCreateVariableRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewDeleteConnectionRequest(server string, connectionId ConnectionID) (*http.Request, error)
- func NewDeleteVariableRequest(server string, variableKey VariableKey) (*http.Request, error)
- func NewGetConnectionRequest(server string, connectionId ConnectionID) (*http.Request, error)
- func NewGetDagRequest(server string, dagId DagID) (*http.Request, error)
- func NewGetDagRunRequest(server string, dagId DagID, dagRunId DagRunID) (*http.Request, error)
- func NewGetDagSourceRequest(server string, dagId DagID) (*http.Request, error)
- func NewGetDagSpecRequest(server string, dagId DagID) (*http.Request, error)
- func NewGetDagVersionRequest(server string, dagId DagID, versionNumber int) (*http.Request, error)
- func NewGetHealthzRequest(server string) (*http.Request, error)
- func NewGetMonitorExecutorRequest(server string) (*http.Request, error)
- func NewGetMonitorHealthRequest(server string) (*http.Request, error)
- func NewGetReadyzRequest(server string) (*http.Request, error)
- func NewGetTaskInstanceRequest(server string, dagId DagID, dagRunId DagRunID, taskId TaskID) (*http.Request, error)
- func NewGetTaskLogsRequest(server string, dagId DagID, dagRunId DagRunID, taskId TaskID, tryNumber int) (*http.Request, error)
- func NewGetVariableRequest(server string, variableKey VariableKey) (*http.Request, error)
- func NewGetVersionRequest(server string) (*http.Request, error)
- func NewGetXcomEntryRequest(server string, dagId DagID, dagRunId DagRunID, taskId TaskID, key string) (*http.Request, error)
- func NewIssueTokenRequest(server string, body IssueTokenJSONRequestBody) (*http.Request, error)
- func NewIssueTokenRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewListAPITokensRequest(server string, params *ListAPITokensParams) (*http.Request, error)
- func NewListConnectionsRequest(server string, params *ListConnectionsParams) (*http.Request, error)
- func NewListDagRunsRequest(server string, dagId DagID, params *ListDagRunsParams) (*http.Request, error)
- func NewListDagVersionsRequest(server string, dagId DagID) (*http.Request, error)
- func NewListDagsRequest(server string, params *ListDagsParams) (*http.Request, error)
- func NewListTaskInstancesRequest(server string, dagId DagID, dagRunId DagRunID) (*http.Request, error)
- func NewListUsersRequest(server string, params *ListUsersParams) (*http.Request, error)
- func NewListVariablesRequest(server string, params *ListVariablesParams) (*http.Request, error)
- func NewPatchTaskInstanceDryRunRequest(server string, dagId DagID, dagRunId DagRunID, taskId TaskID, ...) (*http.Request, error)
- func NewPatchTaskInstanceDryRunRequestWithBody(server string, dagId DagID, dagRunId DagRunID, taskId TaskID, ...) (*http.Request, error)
- func NewPatchTaskInstanceRequest(server string, dagId DagID, dagRunId DagRunID, taskId TaskID, ...) (*http.Request, error)
- func NewPatchTaskInstanceRequestWithBody(server string, dagId DagID, dagRunId DagRunID, taskId TaskID, ...) (*http.Request, error)
- func NewRegisterDagVersionRequest(server string, dagId DagID, params *RegisterDagVersionParams, ...) (*http.Request, error)
- func NewRegisterDagVersionRequestWithBody(server string, dagId DagID, params *RegisterDagVersionParams, ...) (*http.Request, error)
- func NewRenewTokenRequest(server string) (*http.Request, error)
- func NewRevokeAPITokenRequest(server string, tokenId string) (*http.Request, error)
- func NewSetDagCurrentVersionRequest(server string, dagId DagID, body SetDagCurrentVersionJSONRequestBody) (*http.Request, error)
- func NewSetDagCurrentVersionRequestWithBody(server string, dagId DagID, contentType string, body io.Reader) (*http.Request, error)
- func NewTriggerDagRunRequest(server string, dagId DagID, body TriggerDagRunJSONRequestBody) (*http.Request, error)
- func NewTriggerDagRunRequestWithBody(server string, dagId DagID, contentType string, body io.Reader) (*http.Request, error)
- func NewUpdateConnectionRequest(server string, connectionId ConnectionID, body UpdateConnectionJSONRequestBody) (*http.Request, error)
- func NewUpdateConnectionRequestWithBody(server string, connectionId ConnectionID, contentType string, body io.Reader) (*http.Request, error)
- func NewUpdateDagRequest(server string, dagId DagID, body UpdateDagJSONRequestBody) (*http.Request, error)
- func NewUpdateDagRequestWithBody(server string, dagId DagID, contentType string, body io.Reader) (*http.Request, error)
- type APIToken
- type APITokenCollection
- type AuthMethods
- type BuildInfo
- type CITokenRequest
- type CITokenResponse
- type CLIDeviceAuthorization
- type CLITokenRequest
- type ClearDagRun200JSONResponseBody
- func (t ClearDagRun200JSONResponseBody) AsDAGRun() (DAGRun, error)
- func (t ClearDagRun200JSONResponseBody) AsTaskInstanceCollection() (TaskInstanceCollection, error)
- func (t *ClearDagRun200JSONResponseBody) FromDAGRun(v DAGRun) error
- func (t *ClearDagRun200JSONResponseBody) FromTaskInstanceCollection(v TaskInstanceCollection) error
- func (t ClearDagRun200JSONResponseBody) MarshalJSON() ([]byte, error)
- func (t *ClearDagRun200JSONResponseBody) MergeDAGRun(v DAGRun) error
- func (t *ClearDagRun200JSONResponseBody) MergeTaskInstanceCollection(v TaskInstanceCollection) error
- func (t *ClearDagRun200JSONResponseBody) UnmarshalJSON(b []byte) error
- type ClearDagRunJSONRequestBody
- type ClearDagRunResponse
- func (r ClearDagRunResponse) ContentType() string
- func (r ClearDagRunResponse) GetBody() []byte
- func (r ClearDagRunResponse) GetJSON200() *ClearDagRun200JSONResponseBody
- func (r ClearDagRunResponse) GetJSON400() *Error
- func (r ClearDagRunResponse) GetJSON403() *Error
- func (r ClearDagRunResponse) GetJSON404() *NotFound
- func (r ClearDagRunResponse) GetJSON409() *Error
- func (r ClearDagRunResponse) Status() string
- func (r ClearDagRunResponse) StatusCode() int
- type ClearTaskInstancesJSONRequestBody
- type ClearTaskInstancesRequest
- type ClearTaskInstancesResponse
- func (r ClearTaskInstancesResponse) ContentType() string
- func (r ClearTaskInstancesResponse) GetBody() []byte
- func (r ClearTaskInstancesResponse) GetJSON200() *TaskInstanceCollection
- func (r ClearTaskInstancesResponse) GetJSON409() *Error
- func (r ClearTaskInstancesResponse) Status() string
- func (r ClearTaskInstancesResponse) StatusCode() int
- type ClearVersionNotApplied
- type Client
- func (c *Client) ClearDagRun(ctx context.Context, dagId DagID, dagRunId DagRunID, ...) (*http.Response, error)
- func (c *Client) ClearDagRunWithBody(ctx context.Context, dagId DagID, dagRunId DagRunID, contentType string, ...) (*http.Response, error)
- func (c *Client) ClearTaskInstances(ctx context.Context, dagId DagID, body ClearTaskInstancesJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) ClearTaskInstancesWithBody(ctx context.Context, dagId DagID, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) CreateAPIToken(ctx context.Context, body CreateAPITokenJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) CreateAPITokenWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) CreateConnection(ctx context.Context, body CreateConnectionJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) CreateConnectionWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) CreateUser(ctx context.Context, body CreateUserJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) CreateUserWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) CreateVariable(ctx context.Context, body CreateVariableJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) CreateVariableWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) DeleteConnection(ctx context.Context, connectionId ConnectionID, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) DeleteVariable(ctx context.Context, variableKey VariableKey, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) ExchangeCIToken(ctx context.Context, body CITokenRequest, reqEditors ...RequestEditorFn) (*CITokenResponse, error)
- func (c *Client) ExchangeCLILoginCode(ctx context.Context, body CLITokenRequest, reqEditors ...RequestEditorFn) (*TokenResponse, error)
- func (c *Client) GetAuthMethods(ctx context.Context, reqEditors ...RequestEditorFn) (*AuthMethods, error)
- func (c *Client) GetConnection(ctx context.Context, connectionId ConnectionID, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetDag(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetDagRun(ctx context.Context, dagId DagID, dagRunId DagRunID, ...) (*http.Response, error)
- func (c *Client) GetDagSource(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetDagSpec(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetDagVersion(ctx context.Context, dagId DagID, versionNumber int, ...) (*http.Response, error)
- func (c *Client) GetDagVersionSpec(ctx context.Context, dagID string, versionNumber int, ...) (json.RawMessage, error)
- func (c *Client) GetDeployDefaults(ctx context.Context, reqEditors ...RequestEditorFn) (*DeployDefaults, error)
- func (c *Client) GetHealthz(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetMonitorExecutor(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetMonitorHealth(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetReadyz(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetTaskInstance(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, ...) (*http.Response, error)
- func (c *Client) GetTaskLogs(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, ...) (*http.Response, error)
- func (c *Client) GetVariable(ctx context.Context, variableKey VariableKey, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetVersion(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetXcomEntry(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, key string, ...) (*http.Response, error)
- func (c *Client) IssueToken(ctx context.Context, body IssueTokenJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) IssueTokenWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) ListAPITokens(ctx context.Context, params *ListAPITokensParams, ...) (*http.Response, error)
- func (c *Client) ListConnections(ctx context.Context, params *ListConnectionsParams, ...) (*http.Response, error)
- func (c *Client) ListDagRuns(ctx context.Context, dagId DagID, params *ListDagRunsParams, ...) (*http.Response, error)
- func (c *Client) ListDagVersions(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) ListDags(ctx context.Context, params *ListDagsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) ListTaskInstances(ctx context.Context, dagId DagID, dagRunId DagRunID, ...) (*http.Response, error)
- func (c *Client) ListUsers(ctx context.Context, params *ListUsersParams, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) ListVariables(ctx context.Context, params *ListVariablesParams, ...) (*http.Response, error)
- func (c *Client) PatchTaskInstance(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, ...) (*http.Response, error)
- func (c *Client) PatchTaskInstanceDryRun(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, ...) (*http.Response, error)
- func (c *Client) PatchTaskInstanceDryRunWithBody(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, ...) (*http.Response, error)
- func (c *Client) PatchTaskInstanceWithBody(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, ...) (*http.Response, error)
- func (c *Client) PollCLIDeviceLogin(ctx context.Context, deviceCode string, reqEditors ...RequestEditorFn) (*TokenResponse, error)
- func (c *Client) RegisterDagVersion(ctx context.Context, dagId DagID, params *RegisterDagVersionParams, ...) (*http.Response, error)
- func (c *Client) RegisterDagVersionWithBody(ctx context.Context, dagId DagID, params *RegisterDagVersionParams, ...) (*http.Response, error)
- func (c *Client) RenewToken(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) RevokeAPIToken(ctx context.Context, tokenId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) SetDagCurrentVersion(ctx context.Context, dagId DagID, body SetDagCurrentVersionJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) SetDagCurrentVersionWithBody(ctx context.Context, dagId DagID, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) StartCLIDeviceLogin(ctx context.Context, reqEditors ...RequestEditorFn) (*CLIDeviceAuthorization, error)
- func (c *Client) TriggerDagRun(ctx context.Context, dagId DagID, body TriggerDagRunJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) TriggerDagRunWithBody(ctx context.Context, dagId DagID, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) UpdateConnection(ctx context.Context, connectionId ConnectionID, ...) (*http.Response, error)
- func (c *Client) UpdateConnectionWithBody(ctx context.Context, connectionId ConnectionID, contentType string, ...) (*http.Response, error)
- func (c *Client) UpdateDag(ctx context.Context, dagId DagID, body UpdateDagJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) UpdateDagWithBody(ctx context.Context, dagId DagID, contentType string, body io.Reader, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) ClearDagRunWithBodyWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, contentType string, ...) (*ClearDagRunResponse, error)
- func (c *ClientWithResponses) ClearDagRunWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, ...) (*ClearDagRunResponse, error)
- func (c *ClientWithResponses) ClearTaskInstancesWithBodyWithResponse(ctx context.Context, dagId DagID, contentType string, body io.Reader, ...) (*ClearTaskInstancesResponse, error)
- func (c *ClientWithResponses) ClearTaskInstancesWithResponse(ctx context.Context, dagId DagID, body ClearTaskInstancesJSONRequestBody, ...) (*ClearTaskInstancesResponse, error)
- func (c *ClientWithResponses) CreateAPITokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateAPITokenResponse, error)
- func (c *ClientWithResponses) CreateAPITokenWithResponse(ctx context.Context, body CreateAPITokenJSONRequestBody, ...) (*CreateAPITokenResponse, error)
- func (c *ClientWithResponses) CreateConnectionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateConnectionResponse, error)
- func (c *ClientWithResponses) CreateConnectionWithResponse(ctx context.Context, body CreateConnectionJSONRequestBody, ...) (*CreateConnectionResponse, error)
- func (c *ClientWithResponses) CreateUserWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateUserResponse, error)
- func (c *ClientWithResponses) CreateUserWithResponse(ctx context.Context, body CreateUserJSONRequestBody, ...) (*CreateUserResponse, error)
- func (c *ClientWithResponses) CreateVariableWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateVariableResponse, error)
- func (c *ClientWithResponses) CreateVariableWithResponse(ctx context.Context, body CreateVariableJSONRequestBody, ...) (*CreateVariableResponse, error)
- func (c *ClientWithResponses) DeleteConnectionWithResponse(ctx context.Context, connectionId ConnectionID, reqEditors ...RequestEditorFn) (*DeleteConnectionResponse, error)
- func (c *ClientWithResponses) DeleteVariableWithResponse(ctx context.Context, variableKey VariableKey, reqEditors ...RequestEditorFn) (*DeleteVariableResponse, error)
- func (c *ClientWithResponses) GetConnectionWithResponse(ctx context.Context, connectionId ConnectionID, reqEditors ...RequestEditorFn) (*GetConnectionResponse, error)
- func (c *ClientWithResponses) GetDagRunWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, ...) (*GetDagRunResponse, error)
- func (c *ClientWithResponses) GetDagSourceWithResponse(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*GetDagSourceResponse, error)
- func (c *ClientWithResponses) GetDagSpecWithResponse(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*GetDagSpecResponse, error)
- func (c *ClientWithResponses) GetDagVersionWithResponse(ctx context.Context, dagId DagID, versionNumber int, ...) (*GetDagVersionResponse, error)
- func (c *ClientWithResponses) GetDagWithResponse(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*GetDagResponse, error)
- func (c *ClientWithResponses) GetHealthzWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetHealthzResponse, error)
- func (c *ClientWithResponses) GetMonitorExecutorWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetMonitorExecutorResponse, error)
- func (c *ClientWithResponses) GetMonitorHealthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetMonitorHealthResponse, error)
- func (c *ClientWithResponses) GetReadyzWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetReadyzResponse, error)
- func (c *ClientWithResponses) GetTaskInstanceWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, ...) (*GetTaskInstanceResponse, error)
- func (c *ClientWithResponses) GetTaskLogsWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, ...) (*GetTaskLogsResponse, error)
- func (c *ClientWithResponses) GetVariableWithResponse(ctx context.Context, variableKey VariableKey, reqEditors ...RequestEditorFn) (*GetVariableResponse, error)
- func (c *ClientWithResponses) GetVersionWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetVersionResponse, error)
- func (c *ClientWithResponses) GetXcomEntryWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, key string, ...) (*GetXcomEntryResponse, error)
- func (c *ClientWithResponses) IssueTokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*IssueTokenResponse, error)
- func (c *ClientWithResponses) IssueTokenWithResponse(ctx context.Context, body IssueTokenJSONRequestBody, ...) (*IssueTokenResponse, error)
- func (c *ClientWithResponses) ListAPITokensWithResponse(ctx context.Context, params *ListAPITokensParams, ...) (*ListAPITokensResponse, error)
- func (c *ClientWithResponses) ListConnectionsWithResponse(ctx context.Context, params *ListConnectionsParams, ...) (*ListConnectionsResponse, error)
- func (c *ClientWithResponses) ListDagRunsWithResponse(ctx context.Context, dagId DagID, params *ListDagRunsParams, ...) (*ListDagRunsResponse, error)
- func (c *ClientWithResponses) ListDagVersionsWithResponse(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*ListDagVersionsResponse, error)
- func (c *ClientWithResponses) ListDagsWithResponse(ctx context.Context, params *ListDagsParams, reqEditors ...RequestEditorFn) (*ListDagsResponse, error)
- func (c *ClientWithResponses) ListTaskInstancesWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, ...) (*ListTaskInstancesResponse, error)
- func (c *ClientWithResponses) ListUsersWithResponse(ctx context.Context, params *ListUsersParams, reqEditors ...RequestEditorFn) (*ListUsersResponse, error)
- func (c *ClientWithResponses) ListVariablesWithResponse(ctx context.Context, params *ListVariablesParams, ...) (*ListVariablesResponse, error)
- func (c *ClientWithResponses) PatchTaskInstanceDryRunWithBodyWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, ...) (*PatchTaskInstanceDryRunResponse, error)
- func (c *ClientWithResponses) PatchTaskInstanceDryRunWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, ...) (*PatchTaskInstanceDryRunResponse, error)
- func (c *ClientWithResponses) PatchTaskInstanceWithBodyWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, ...) (*PatchTaskInstanceResponse, error)
- func (c *ClientWithResponses) PatchTaskInstanceWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, ...) (*PatchTaskInstanceResponse, error)
- func (c *ClientWithResponses) RegisterDagVersionWithBodyWithResponse(ctx context.Context, dagId DagID, params *RegisterDagVersionParams, ...) (*RegisterDagVersionResponse, error)
- func (c *ClientWithResponses) RegisterDagVersionWithResponse(ctx context.Context, dagId DagID, params *RegisterDagVersionParams, ...) (*RegisterDagVersionResponse, error)
- func (c *ClientWithResponses) RenewTokenWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RenewTokenResponse, error)
- func (c *ClientWithResponses) RevokeAPITokenWithResponse(ctx context.Context, tokenId string, reqEditors ...RequestEditorFn) (*RevokeAPITokenResponse, error)
- func (c *ClientWithResponses) SetDagCurrentVersionWithBodyWithResponse(ctx context.Context, dagId DagID, contentType string, body io.Reader, ...) (*SetDagCurrentVersionResponse, error)
- func (c *ClientWithResponses) SetDagCurrentVersionWithResponse(ctx context.Context, dagId DagID, body SetDagCurrentVersionJSONRequestBody, ...) (*SetDagCurrentVersionResponse, error)
- func (c *ClientWithResponses) TriggerDagRunWithBodyWithResponse(ctx context.Context, dagId DagID, contentType string, body io.Reader, ...) (*TriggerDagRunResponse, error)
- func (c *ClientWithResponses) TriggerDagRunWithResponse(ctx context.Context, dagId DagID, body TriggerDagRunJSONRequestBody, ...) (*TriggerDagRunResponse, error)
- func (c *ClientWithResponses) UpdateConnectionWithBodyWithResponse(ctx context.Context, connectionId ConnectionID, contentType string, ...) (*UpdateConnectionResponse, error)
- func (c *ClientWithResponses) UpdateConnectionWithResponse(ctx context.Context, connectionId ConnectionID, ...) (*UpdateConnectionResponse, error)
- func (c *ClientWithResponses) UpdateDagWithBodyWithResponse(ctx context.Context, dagId DagID, contentType string, body io.Reader, ...) (*UpdateDagResponse, error)
- func (c *ClientWithResponses) UpdateDagWithResponse(ctx context.Context, dagId DagID, body UpdateDagJSONRequestBody, ...) (*UpdateDagResponse, error)
- type ClientWithResponsesInterface
- type ComponentHealth
- type Connection
- type ConnectionBody
- type ConnectionCollection
- type ConnectionID
- type CreateAPITokenJSONRequestBody
- type CreateAPITokenRequest
- type CreateAPITokenRequestScope
- type CreateAPITokenResponse
- func (r CreateAPITokenResponse) ContentType() string
- func (r CreateAPITokenResponse) GetBody() []byte
- func (r CreateAPITokenResponse) GetJSON201() *CreatedAPIToken
- func (r CreateAPITokenResponse) GetJSON400() *Error
- func (r CreateAPITokenResponse) GetJSON401() *Unauthorized
- func (r CreateAPITokenResponse) GetJSON403() *Error
- func (r CreateAPITokenResponse) GetJSON409() *Error
- func (r CreateAPITokenResponse) Status() string
- func (r CreateAPITokenResponse) StatusCode() int
- type CreateConnectionJSONRequestBody
- type CreateConnectionResponse
- func (r CreateConnectionResponse) ContentType() string
- func (r CreateConnectionResponse) GetBody() []byte
- func (r CreateConnectionResponse) GetJSON201() *Connection
- func (r CreateConnectionResponse) GetJSON400() *Error
- func (r CreateConnectionResponse) GetJSON401() *Unauthorized
- func (r CreateConnectionResponse) GetJSON503() *EncryptionUnavailable
- func (r CreateConnectionResponse) Status() string
- func (r CreateConnectionResponse) StatusCode() int
- type CreateUserJSONRequestBody
- type CreateUserRequest
- type CreateUserResponse
- func (r CreateUserResponse) ContentType() string
- func (r CreateUserResponse) GetBody() []byte
- func (r CreateUserResponse) GetJSON201() *User
- func (r CreateUserResponse) GetJSON400() *Error
- func (r CreateUserResponse) GetJSON401() *Unauthorized
- func (r CreateUserResponse) GetJSON409() *Error
- func (r CreateUserResponse) Status() string
- func (r CreateUserResponse) StatusCode() int
- type CreateVariableJSONRequestBody
- type CreateVariableResponse
- func (r CreateVariableResponse) ContentType() string
- func (r CreateVariableResponse) GetBody() []byte
- func (r CreateVariableResponse) GetJSON201() *Variable
- func (r CreateVariableResponse) GetJSON400() *Error
- func (r CreateVariableResponse) GetJSON401() *Unauthorized
- func (r CreateVariableResponse) Status() string
- func (r CreateVariableResponse) StatusCode() int
- type CreatedAPIToken
- type Cursor
- type DAG
- type DAGCollection
- type DAGRun
- type DAGRunClearRequest
- type DAGRunCollection
- type DAGRunCreate
- type DAGRunRunType
- type DAGRunState
- type DAGUpdate
- type DagCurrentVersionChange
- type DagCurrentVersionRequest
- type DagID
- type DagRunID
- type DagSource
- type DagSpec
- type DagVersion
- type DagVersionCollection
- type DeleteConnectionResponse
- func (r DeleteConnectionResponse) ContentType() string
- func (r DeleteConnectionResponse) GetBody() []byte
- func (r DeleteConnectionResponse) GetJSON401() *Unauthorized
- func (r DeleteConnectionResponse) GetJSON404() *NotFound
- func (r DeleteConnectionResponse) Status() string
- func (r DeleteConnectionResponse) StatusCode() int
- type DeleteVariableResponse
- func (r DeleteVariableResponse) ContentType() string
- func (r DeleteVariableResponse) GetBody() []byte
- func (r DeleteVariableResponse) GetJSON401() *Unauthorized
- func (r DeleteVariableResponse) GetJSON404() *NotFound
- func (r DeleteVariableResponse) Status() string
- func (r DeleteVariableResponse) StatusCode() int
- type DeployBuildKit
- type DeployCIOIDC
- type DeployCIOIDCIssuer
- type DeployCloudBuild
- type DeployDefaults
- type DeployRemoteBuilder
- type DeployWarmPools
- type EncryptionUnavailable
- type Error
- type ExecutionReport
- type ExecutorInfo
- type GetConnectionResponse
- func (r GetConnectionResponse) ContentType() string
- func (r GetConnectionResponse) GetBody() []byte
- func (r GetConnectionResponse) GetJSON200() *Connection
- func (r GetConnectionResponse) GetJSON401() *Unauthorized
- func (r GetConnectionResponse) GetJSON404() *NotFound
- func (r GetConnectionResponse) Status() string
- func (r GetConnectionResponse) StatusCode() int
- type GetDagResponse
- type GetDagRunResponse
- type GetDagSourceResponse
- func (r GetDagSourceResponse) ContentType() string
- func (r GetDagSourceResponse) GetBody() []byte
- func (r GetDagSourceResponse) GetJSON200() *DagSource
- func (r GetDagSourceResponse) GetJSON400() *Error
- func (r GetDagSourceResponse) GetJSON404() *NotFound
- func (r GetDagSourceResponse) Status() string
- func (r GetDagSourceResponse) StatusCode() int
- type GetDagSpecResponse
- type GetDagVersionResponse
- func (r GetDagVersionResponse) ContentType() string
- func (r GetDagVersionResponse) GetBody() []byte
- func (r GetDagVersionResponse) GetJSON200() *DagVersion
- func (r GetDagVersionResponse) GetJSON404() *NotFound
- func (r GetDagVersionResponse) Status() string
- func (r GetDagVersionResponse) StatusCode() int
- type GetHealthzResponse
- type GetMonitorExecutorResponse
- type GetMonitorHealthResponse
- type GetReadyzResponse
- type GetTaskInstanceResponse
- type GetTaskLogsResponse
- type GetVariableResponse
- func (r GetVariableResponse) ContentType() string
- func (r GetVariableResponse) GetBody() []byte
- func (r GetVariableResponse) GetJSON200() *Variable
- func (r GetVariableResponse) GetJSON401() *Unauthorized
- func (r GetVariableResponse) GetJSON404() *NotFound
- func (r GetVariableResponse) Status() string
- func (r GetVariableResponse) StatusCode() int
- type GetVersionResponse
- type GetXcomEntryResponse
- type HealthInfo
- type HttpRequestDoer
- type IssueTokenJSONRequestBody
- type IssueTokenResponse
- type IssueTokenResponse200Headers
- type Limit
- type ListAPITokensParams
- type ListAPITokensResponse
- func (r ListAPITokensResponse) ContentType() string
- func (r ListAPITokensResponse) GetBody() []byte
- func (r ListAPITokensResponse) GetJSON200() *APITokenCollection
- func (r ListAPITokensResponse) GetJSON401() *Unauthorized
- func (r ListAPITokensResponse) GetJSON403() *Error
- func (r ListAPITokensResponse) Status() string
- func (r ListAPITokensResponse) StatusCode() int
- type ListConnectionsParams
- type ListConnectionsResponse
- func (r ListConnectionsResponse) ContentType() string
- func (r ListConnectionsResponse) GetBody() []byte
- func (r ListConnectionsResponse) GetJSON200() *ConnectionCollection
- func (r ListConnectionsResponse) GetJSON401() *Unauthorized
- func (r ListConnectionsResponse) Status() string
- func (r ListConnectionsResponse) StatusCode() int
- type ListDagRunsParams
- type ListDagRunsParamsState
- type ListDagRunsResponse
- type ListDagVersionsResponse
- type ListDagsParams
- type ListDagsResponse
- type ListTaskInstancesResponse
- type ListUsersParams
- type ListUsersResponse
- type ListVariablesParams
- type ListVariablesResponse
- func (r ListVariablesResponse) ContentType() string
- func (r ListVariablesResponse) GetBody() []byte
- func (r ListVariablesResponse) GetJSON200() *VariableCollection
- func (r ListVariablesResponse) GetJSON401() *Unauthorized
- func (r ListVariablesResponse) Status() string
- func (r ListVariablesResponse) StatusCode() int
- type NotFound
- type Offset
- type PatchTaskInstanceDryRunJSONRequestBody
- type PatchTaskInstanceDryRunResponse
- func (r PatchTaskInstanceDryRunResponse) ContentType() string
- func (r PatchTaskInstanceDryRunResponse) GetBody() []byte
- func (r PatchTaskInstanceDryRunResponse) GetJSON200() *TaskInstanceCollection
- func (r PatchTaskInstanceDryRunResponse) GetJSON400() *Error
- func (r PatchTaskInstanceDryRunResponse) GetJSON404() *NotFound
- func (r PatchTaskInstanceDryRunResponse) Status() string
- func (r PatchTaskInstanceDryRunResponse) StatusCode() int
- type PatchTaskInstanceJSONRequestBody
- type PatchTaskInstanceResponse
- func (r PatchTaskInstanceResponse) ContentType() string
- func (r PatchTaskInstanceResponse) GetBody() []byte
- func (r PatchTaskInstanceResponse) GetJSON200() *TaskInstanceCollection
- func (r PatchTaskInstanceResponse) GetJSON400() *Error
- func (r PatchTaskInstanceResponse) GetJSON404() *NotFound
- func (r PatchTaskInstanceResponse) Status() string
- func (r PatchTaskInstanceResponse) StatusCode() int
- type RegisterDagVersionJSONRequestBody
- type RegisterDagVersionParams
- type RegisterDagVersionResponse
- func (r RegisterDagVersionResponse) ContentType() string
- func (r RegisterDagVersionResponse) GetBody() []byte
- func (r RegisterDagVersionResponse) GetJSON200() *VersionRegistration
- func (r RegisterDagVersionResponse) GetJSON201() *VersionRegistration
- func (r RegisterDagVersionResponse) GetJSON400() *Error
- func (r RegisterDagVersionResponse) GetJSON401() *Unauthorized
- func (r RegisterDagVersionResponse) GetJSON403() *Error
- func (r RegisterDagVersionResponse) GetJSON409() *Error
- func (r RegisterDagVersionResponse) Status() string
- func (r RegisterDagVersionResponse) StatusCode() int
- type RegisterDagVersionResponse403Headers
- type RenewTokenResponse
- type RequestEditorFn
- type RevokeAPITokenResponse
- func (r RevokeAPITokenResponse) ContentType() string
- func (r RevokeAPITokenResponse) GetBody() []byte
- func (r RevokeAPITokenResponse) GetJSON401() *Unauthorized
- func (r RevokeAPITokenResponse) GetJSON403() *Error
- func (r RevokeAPITokenResponse) GetJSON404() *NotFound
- func (r RevokeAPITokenResponse) Status() string
- func (r RevokeAPITokenResponse) StatusCode() int
- type SetDagCurrentVersionJSONRequestBody
- type SetDagCurrentVersionResponse
- func (r SetDagCurrentVersionResponse) ContentType() string
- func (r SetDagCurrentVersionResponse) GetBody() []byte
- func (r SetDagCurrentVersionResponse) GetJSON200() *DagCurrentVersionChange
- func (r SetDagCurrentVersionResponse) GetJSON400() *Error
- func (r SetDagCurrentVersionResponse) GetJSON401() *Unauthorized
- func (r SetDagCurrentVersionResponse) GetJSON403() *Error
- func (r SetDagCurrentVersionResponse) GetJSON404() *NotFound
- func (r SetDagCurrentVersionResponse) Status() string
- func (r SetDagCurrentVersionResponse) StatusCode() int
- type SetDagCurrentVersionResponse403Headers
- type StatusError
- type TaskExecution
- type TaskExecutionMode
- type TaskID
- type TaskInstance
- type TaskInstanceCollection
- type TaskInstanceState
- type TaskInstanceStateUpdate
- type TaskInstanceStateUpdateNewState
- type TaskPodsReport
- type TaskServiceAccountCheck
- type TokenRequest
- type TokenResponse
- type TriggerDagRunJSONRequestBody
- type TriggerDagRunResponse
- type Unauthorized
- type UpdateConnectionJSONRequestBody
- type UpdateConnectionResponse
- func (r UpdateConnectionResponse) ContentType() string
- func (r UpdateConnectionResponse) GetBody() []byte
- func (r UpdateConnectionResponse) GetJSON200() *Connection
- func (r UpdateConnectionResponse) GetJSON400() *Error
- func (r UpdateConnectionResponse) GetJSON401() *Unauthorized
- func (r UpdateConnectionResponse) GetJSON404() *NotFound
- func (r UpdateConnectionResponse) GetJSON503() *EncryptionUnavailable
- func (r UpdateConnectionResponse) Status() string
- func (r UpdateConnectionResponse) StatusCode() int
- type UpdateDagJSONRequestBody
- type UpdateDagResponse
- type User
- type UserCollection
- type UserListItem
- type Variable
- type VariableBody
- type VariableCollection
- type VariableKey
- type VersionInfo
- type VersionRegistration
- type WarmPoolReport
- type WarmPoolReportPreviousPool
- type WarmPoolReportState
- type XComEntry
Constants ¶
const DeviceGrantType = "urn:ietf:params:oauth:grant-type:device_code"
DeviceGrantType is the grant_type of a device poll (RFC 8628).
Variables ¶
var ( // ErrDeviceAuthorizationPending: nobody approved the sign-in yet; poll // again after the interval. ErrDeviceAuthorizationPending = errors.New("the sign-in is waiting for its approval in the browser") // ErrDeviceSlowDown: the poll came too soon; add five seconds to the // interval. ErrDeviceSlowDown = errors.New("polling too fast") // ErrDeviceAccessDenied: the sign-in was canceled in the browser. ErrDeviceAccessDenied = errors.New("the sign-in was canceled in the browser") // ErrDeviceExpired: the sign-in expired before it was approved. ErrDeviceExpired = errors.New("the sign-in expired") )
The answers of a device poll that are not a token (RFC 8628 section 3.5). ErrCLILoginCodeRefused is the answer for a device code that is not live.
var ErrAuthMethodsNotServed = errors.New("the server does not serve " + authMethodsPath)
ErrAuthMethodsNotServed is what GetAuthMethods returns when the server answers 404: it predates GET /api/v2/auth/methods, and so offers only a password login to the CLI.
var ErrCITokenNotServed = errors.New("the server does not serve " + ciTokenPath)
ErrCITokenNotServed is what ExchangeCIToken returns when the server answers 404: it trusts no CI issuer, or predates the exchange.
var ErrCLILoginCodeRefused = errors.New("the server refused the sign-in code")
ErrCLILoginCodeRefused is what ExchangeCLILoginCode returns when the server refuses the code (400). The server does not say why, by design: the code may be unknown, expired, already used, or not bound to the verifier.
var ErrDeployDefaultsNotServed = errors.New("the server does not serve " + deployDefaultsPath)
ErrDeployDefaultsNotServed is what GetDeployDefaults returns when the server answers 404: it predates GET /api/v2/deployDefaults, and so advertises no deploy defaults.
var ErrDeviceLoginNotServed = errors.New("the server does not serve " + cliDevicePath)
ErrDeviceLoginNotServed is what StartCLIDeviceLogin returns when the server answers 404: it does not serve the device sign-in.
Functions ¶
func DryRunRegister ¶ added in v0.5.4
DryRunRegister is a RequestEditorFn for RegisterDagVersion that sends the register to POST /api/v2/dags/{dag_id}/versions/dry_run instead: the server runs every check of the register and writes nothing, answering 200 with dry_run true, or the refusal the register would give. A server from before the route answers 404 and registers nothing. Pass it only to RegisterDagVersion; it refuses any request other than a POST to the register path.
As an argument of the call it runs after the client-level editors (WithRequestEditorFn): an editor of the client that signs the path signs the register path, not the dry run route.
func NewClearDagRunRequest ¶ added in v0.5.4
func NewClearDagRunRequest(server string, dagId DagID, dagRunId DagRunID, body ClearDagRunJSONRequestBody) (*http.Request, error)
NewClearDagRunRequest calls the generic ClearDagRun builder with application/json body
func NewClearDagRunRequestWithBody ¶ added in v0.5.4
func NewClearDagRunRequestWithBody(server string, dagId DagID, dagRunId DagRunID, contentType string, body io.Reader) (*http.Request, error)
NewClearDagRunRequestWithBody constructs an http.Request for the ClearDagRun method, with any body, and a specified content type
func NewClearTaskInstancesRequest ¶
func NewClearTaskInstancesRequest(server string, dagId DagID, body ClearTaskInstancesJSONRequestBody) (*http.Request, error)
NewClearTaskInstancesRequest calls the generic ClearTaskInstances builder with application/json body
func NewClearTaskInstancesRequestWithBody ¶
func NewClearTaskInstancesRequestWithBody(server string, dagId DagID, contentType string, body io.Reader) (*http.Request, error)
NewClearTaskInstancesRequestWithBody constructs an http.Request for the ClearTaskInstances method, with any body, and a specified content type
func NewCreateAPITokenRequest ¶ added in v0.5.4
func NewCreateAPITokenRequest(server string, body CreateAPITokenJSONRequestBody) (*http.Request, error)
NewCreateAPITokenRequest calls the generic CreateAPIToken builder with application/json body
func NewCreateAPITokenRequestWithBody ¶ added in v0.5.4
func NewCreateAPITokenRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewCreateAPITokenRequestWithBody constructs an http.Request for the CreateAPIToken method, with any body, and a specified content type
func NewCreateConnectionRequest ¶
func NewCreateConnectionRequest(server string, body CreateConnectionJSONRequestBody) (*http.Request, error)
NewCreateConnectionRequest calls the generic CreateConnection builder with application/json body
func NewCreateConnectionRequestWithBody ¶
func NewCreateConnectionRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewCreateConnectionRequestWithBody constructs an http.Request for the CreateConnection method, with any body, and a specified content type
func NewCreateUserRequest ¶
func NewCreateUserRequest(server string, body CreateUserJSONRequestBody) (*http.Request, error)
NewCreateUserRequest calls the generic CreateUser builder with application/json body
func NewCreateUserRequestWithBody ¶
func NewCreateUserRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewCreateUserRequestWithBody constructs an http.Request for the CreateUser method, with any body, and a specified content type
func NewCreateVariableRequest ¶
func NewCreateVariableRequest(server string, body CreateVariableJSONRequestBody) (*http.Request, error)
NewCreateVariableRequest calls the generic CreateVariable builder with application/json body
func NewCreateVariableRequestWithBody ¶
func NewCreateVariableRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewCreateVariableRequestWithBody constructs an http.Request for the CreateVariable method, with any body, and a specified content type
func NewDeleteConnectionRequest ¶
func NewDeleteConnectionRequest(server string, connectionId ConnectionID) (*http.Request, error)
NewDeleteConnectionRequest constructs an http.Request for the DeleteConnection method
func NewDeleteVariableRequest ¶
func NewDeleteVariableRequest(server string, variableKey VariableKey) (*http.Request, error)
NewDeleteVariableRequest constructs an http.Request for the DeleteVariable method
func NewGetConnectionRequest ¶
func NewGetConnectionRequest(server string, connectionId ConnectionID) (*http.Request, error)
NewGetConnectionRequest constructs an http.Request for the GetConnection method
func NewGetDagRequest ¶
NewGetDagRequest constructs an http.Request for the GetDag method
func NewGetDagRunRequest ¶
NewGetDagRunRequest constructs an http.Request for the GetDagRun method
func NewGetDagSourceRequest ¶
NewGetDagSourceRequest constructs an http.Request for the GetDagSource method
func NewGetDagSpecRequest ¶
NewGetDagSpecRequest constructs an http.Request for the GetDagSpec method
func NewGetDagVersionRequest ¶
NewGetDagVersionRequest constructs an http.Request for the GetDagVersion method
func NewGetHealthzRequest ¶
NewGetHealthzRequest constructs an http.Request for the GetHealthz method
func NewGetMonitorExecutorRequest ¶
NewGetMonitorExecutorRequest constructs an http.Request for the GetMonitorExecutor method
func NewGetMonitorHealthRequest ¶
NewGetMonitorHealthRequest constructs an http.Request for the GetMonitorHealth method
func NewGetReadyzRequest ¶
NewGetReadyzRequest constructs an http.Request for the GetReadyz method
func NewGetTaskInstanceRequest ¶
func NewGetTaskInstanceRequest(server string, dagId DagID, dagRunId DagRunID, taskId TaskID) (*http.Request, error)
NewGetTaskInstanceRequest constructs an http.Request for the GetTaskInstance method
func NewGetTaskLogsRequest ¶
func NewGetTaskLogsRequest(server string, dagId DagID, dagRunId DagRunID, taskId TaskID, tryNumber int) (*http.Request, error)
NewGetTaskLogsRequest constructs an http.Request for the GetTaskLogs method
func NewGetVariableRequest ¶
func NewGetVariableRequest(server string, variableKey VariableKey) (*http.Request, error)
NewGetVariableRequest constructs an http.Request for the GetVariable method
func NewGetVersionRequest ¶
NewGetVersionRequest constructs an http.Request for the GetVersion method
func NewGetXcomEntryRequest ¶
func NewGetXcomEntryRequest(server string, dagId DagID, dagRunId DagRunID, taskId TaskID, key string) (*http.Request, error)
NewGetXcomEntryRequest constructs an http.Request for the GetXcomEntry method
func NewIssueTokenRequest ¶
func NewIssueTokenRequest(server string, body IssueTokenJSONRequestBody) (*http.Request, error)
NewIssueTokenRequest calls the generic IssueToken builder with application/json body
func NewIssueTokenRequestWithBody ¶
func NewIssueTokenRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewIssueTokenRequestWithBody constructs an http.Request for the IssueToken method, with any body, and a specified content type
func NewListAPITokensRequest ¶ added in v0.5.4
func NewListAPITokensRequest(server string, params *ListAPITokensParams) (*http.Request, error)
NewListAPITokensRequest constructs an http.Request for the ListAPITokens method
func NewListConnectionsRequest ¶
func NewListConnectionsRequest(server string, params *ListConnectionsParams) (*http.Request, error)
NewListConnectionsRequest constructs an http.Request for the ListConnections method
func NewListDagRunsRequest ¶
func NewListDagRunsRequest(server string, dagId DagID, params *ListDagRunsParams) (*http.Request, error)
NewListDagRunsRequest constructs an http.Request for the ListDagRuns method
func NewListDagVersionsRequest ¶
NewListDagVersionsRequest constructs an http.Request for the ListDagVersions method
func NewListDagsRequest ¶
func NewListDagsRequest(server string, params *ListDagsParams) (*http.Request, error)
NewListDagsRequest constructs an http.Request for the ListDags method
func NewListTaskInstancesRequest ¶
func NewListTaskInstancesRequest(server string, dagId DagID, dagRunId DagRunID) (*http.Request, error)
NewListTaskInstancesRequest constructs an http.Request for the ListTaskInstances method
func NewListUsersRequest ¶
func NewListUsersRequest(server string, params *ListUsersParams) (*http.Request, error)
NewListUsersRequest constructs an http.Request for the ListUsers method
func NewListVariablesRequest ¶
func NewListVariablesRequest(server string, params *ListVariablesParams) (*http.Request, error)
NewListVariablesRequest constructs an http.Request for the ListVariables method
func NewPatchTaskInstanceDryRunRequest ¶ added in v0.5.4
func NewPatchTaskInstanceDryRunRequest(server string, dagId DagID, dagRunId DagRunID, taskId TaskID, body PatchTaskInstanceDryRunJSONRequestBody) (*http.Request, error)
NewPatchTaskInstanceDryRunRequest calls the generic PatchTaskInstanceDryRun builder with application/json body
func NewPatchTaskInstanceDryRunRequestWithBody ¶ added in v0.5.4
func NewPatchTaskInstanceDryRunRequestWithBody(server string, dagId DagID, dagRunId DagRunID, taskId TaskID, contentType string, body io.Reader) (*http.Request, error)
NewPatchTaskInstanceDryRunRequestWithBody constructs an http.Request for the PatchTaskInstanceDryRun method, with any body, and a specified content type
func NewPatchTaskInstanceRequest ¶ added in v0.5.4
func NewPatchTaskInstanceRequest(server string, dagId DagID, dagRunId DagRunID, taskId TaskID, body PatchTaskInstanceJSONRequestBody) (*http.Request, error)
NewPatchTaskInstanceRequest calls the generic PatchTaskInstance builder with application/json body
func NewPatchTaskInstanceRequestWithBody ¶ added in v0.5.4
func NewPatchTaskInstanceRequestWithBody(server string, dagId DagID, dagRunId DagRunID, taskId TaskID, contentType string, body io.Reader) (*http.Request, error)
NewPatchTaskInstanceRequestWithBody constructs an http.Request for the PatchTaskInstance method, with any body, and a specified content type
func NewRegisterDagVersionRequest ¶ added in v0.5.4
func NewRegisterDagVersionRequest(server string, dagId DagID, params *RegisterDagVersionParams, body RegisterDagVersionJSONRequestBody) (*http.Request, error)
NewRegisterDagVersionRequest calls the generic RegisterDagVersion builder with application/json body
func NewRegisterDagVersionRequestWithBody ¶ added in v0.5.4
func NewRegisterDagVersionRequestWithBody(server string, dagId DagID, params *RegisterDagVersionParams, contentType string, body io.Reader) (*http.Request, error)
NewRegisterDagVersionRequestWithBody constructs an http.Request for the RegisterDagVersion method, with any body, and a specified content type
func NewRenewTokenRequest ¶
NewRenewTokenRequest constructs an http.Request for the RenewToken method
func NewRevokeAPITokenRequest ¶ added in v0.5.4
NewRevokeAPITokenRequest constructs an http.Request for the RevokeAPIToken method
func NewSetDagCurrentVersionRequest ¶ added in v0.5.4
func NewSetDagCurrentVersionRequest(server string, dagId DagID, body SetDagCurrentVersionJSONRequestBody) (*http.Request, error)
NewSetDagCurrentVersionRequest calls the generic SetDagCurrentVersion builder with application/json body
func NewSetDagCurrentVersionRequestWithBody ¶ added in v0.5.4
func NewSetDagCurrentVersionRequestWithBody(server string, dagId DagID, contentType string, body io.Reader) (*http.Request, error)
NewSetDagCurrentVersionRequestWithBody constructs an http.Request for the SetDagCurrentVersion method, with any body, and a specified content type
func NewTriggerDagRunRequest ¶
func NewTriggerDagRunRequest(server string, dagId DagID, body TriggerDagRunJSONRequestBody) (*http.Request, error)
NewTriggerDagRunRequest calls the generic TriggerDagRun builder with application/json body
func NewTriggerDagRunRequestWithBody ¶
func NewTriggerDagRunRequestWithBody(server string, dagId DagID, contentType string, body io.Reader) (*http.Request, error)
NewTriggerDagRunRequestWithBody constructs an http.Request for the TriggerDagRun method, with any body, and a specified content type
func NewUpdateConnectionRequest ¶
func NewUpdateConnectionRequest(server string, connectionId ConnectionID, body UpdateConnectionJSONRequestBody) (*http.Request, error)
NewUpdateConnectionRequest calls the generic UpdateConnection builder with application/json body
func NewUpdateConnectionRequestWithBody ¶
func NewUpdateConnectionRequestWithBody(server string, connectionId ConnectionID, contentType string, body io.Reader) (*http.Request, error)
NewUpdateConnectionRequestWithBody constructs an http.Request for the UpdateConnection method, with any body, and a specified content type
func NewUpdateDagRequest ¶
func NewUpdateDagRequest(server string, dagId DagID, body UpdateDagJSONRequestBody) (*http.Request, error)
NewUpdateDagRequest calls the generic UpdateDag builder with application/json body
Types ¶
type APIToken ¶ added in v0.5.4
type APIToken struct {
CreatedAt time.Time `json:"created_at"`
ExpiresAt time.Time `json:"expires_at"`
Id string `json:"id"`
// LastUsedAt When the token last authenticated a request, recorded at most once every five minutes; null when it was never used.
LastUsedAt *time.Time `json:"last_used_at,omitempty"`
Name string `json:"name"`
// OwnerEmail Email of the token's owner (in lists).
OwnerEmail *string `json:"owner_email,omitempty"`
Scopes []string `json:"scopes"`
}
APIToken defines model for APIToken.
type APITokenCollection ¶ added in v0.5.4
type APITokenCollection struct {
ApiTokens *[]APIToken `json:"api_tokens,omitempty"`
TotalEntries *int `json:"total_entries,omitempty"`
}
APITokenCollection defines model for APITokenCollection.
type AuthMethods ¶ added in v0.5.4
type AuthMethods struct {
// Password is whether a password login can succeed for someone.
Password bool `json:"password"`
// SSO is whether the OIDC single sign-on flow is served.
SSO bool `json:"sso"`
// Device is whether the device sign-in for machines with no browser is
// served (POST /api/v2/auth/cli/device). Servers from before it omit it.
Device bool `json:"device"`
}
AuthMethods are the sign-in methods GET /api/v2/auth/methods reports.
type BuildInfo ¶ added in v0.5.4
type BuildInfo struct {
// BaseImage The base image the DAG image was built from; it carries the task agent.
BaseImage *string `json:"base_image,omitempty"`
// Builder The builder that produced the image.
Builder *string `json:"builder,omitempty"`
// CliVersion The version of the CLI that built and registered the version.
CliVersion *string `json:"cli_version,omitempty"`
// Commit The git commit of the sources.
Commit *string `json:"commit,omitempty"`
// PipelineUrl The CI pipeline run that built the version (http or https URL).
PipelineUrl *string `json:"pipeline_url,omitempty"`
// Repo The repository of the sources (http or https URL).
Repo *string `json:"repo,omitempty"`
}
BuildInfo Dexaflow. Where a DAG version was built (#1702), as the register claimed it, not verified. Every field is optional and absent when it was not sent.
type CITokenRequest ¶ added in v0.5.5
type CITokenRequest struct {
Token string `json:"token"`
}
CITokenRequest is the body of POST /api/v2/auth/ciToken: the OIDC token the CI provider minted for the job.
type CITokenResponse ¶ added in v0.5.5
type CITokenResponse struct {
AccessToken string `json:"access_token"`
TokenType string `json:"token_type"`
ExpiresIn int `json:"expires_in"`
ExpiresAt time.Time `json:"expires_at"`
Issuer string `json:"issuer"`
Tenant string `json:"tenant"`
Role string `json:"role"`
Scopes []string `json:"scopes"`
}
CITokenResponse is the deploy session POST /api/v2/auth/ciToken answers: the token, its lifetime, and the issuer entry, tenant, role and scopes it acts with.
type CLIDeviceAuthorization ¶ added in v0.5.4
type CLIDeviceAuthorization struct {
// DeviceCode is the secret the CLI polls with. Never print it.
DeviceCode string `json:"device_code"`
// UserCode is the short code the person enters and confirms.
UserCode string `json:"user_code"`
// VerificationURI is the page the person enters the code on.
VerificationURI string `json:"verification_uri"`
// VerificationURIComplete is that page with the code filled in.
VerificationURIComplete string `json:"verification_uri_complete"`
// ExpiresIn is the sign-in's lifetime in seconds.
ExpiresIn int `json:"expires_in"`
// Interval is the minimum number of seconds between polls.
Interval int `json:"interval"`
}
CLIDeviceAuthorization is what POST /api/v2/auth/cli/device answers: the device code the CLI polls with, and what the person needs to approve it.
type CLITokenRequest ¶ added in v0.5.4
type CLITokenRequest struct {
// Code is the one-time code the CLI's loopback received.
Code string `json:"code"`
// CodeVerifier is the PKCE verifier of the login's code_challenge.
CodeVerifier string `json:"code_verifier"`
// RedirectURI is the redirect_uri the login was started with.
RedirectURI string `json:"redirect_uri"`
}
CLITokenRequest is the body of POST /api/v2/auth/cli/token.
type ClearDagRun200JSONResponseBody ¶ added in v0.5.4
type ClearDagRun200JSONResponseBody struct {
// contains filtered or unexported fields
}
ClearDagRun200JSONResponseBody defines parameters for ClearDagRun.
func (ClearDagRun200JSONResponseBody) AsDAGRun ¶ added in v0.5.4
func (t ClearDagRun200JSONResponseBody) AsDAGRun() (DAGRun, error)
AsDAGRun returns the union data inside the ClearDagRun200JSONResponseBody as a DAGRun
func (ClearDagRun200JSONResponseBody) AsTaskInstanceCollection ¶ added in v0.5.4
func (t ClearDagRun200JSONResponseBody) AsTaskInstanceCollection() (TaskInstanceCollection, error)
AsTaskInstanceCollection returns the union data inside the ClearDagRun200JSONResponseBody as a TaskInstanceCollection
func (*ClearDagRun200JSONResponseBody) FromDAGRun ¶ added in v0.5.4
func (t *ClearDagRun200JSONResponseBody) FromDAGRun(v DAGRun) error
FromDAGRun overwrites any union data inside the ClearDagRun200JSONResponseBody as the provided DAGRun
func (*ClearDagRun200JSONResponseBody) FromTaskInstanceCollection ¶ added in v0.5.4
func (t *ClearDagRun200JSONResponseBody) FromTaskInstanceCollection(v TaskInstanceCollection) error
FromTaskInstanceCollection overwrites any union data inside the ClearDagRun200JSONResponseBody as the provided TaskInstanceCollection
func (ClearDagRun200JSONResponseBody) MarshalJSON ¶ added in v0.5.4
func (t ClearDagRun200JSONResponseBody) MarshalJSON() ([]byte, error)
func (*ClearDagRun200JSONResponseBody) MergeDAGRun ¶ added in v0.5.4
func (t *ClearDagRun200JSONResponseBody) MergeDAGRun(v DAGRun) error
MergeDAGRun performs a merge with any union data inside the ClearDagRun200JSONResponseBody, using the provided DAGRun
func (*ClearDagRun200JSONResponseBody) MergeTaskInstanceCollection ¶ added in v0.5.4
func (t *ClearDagRun200JSONResponseBody) MergeTaskInstanceCollection(v TaskInstanceCollection) error
MergeTaskInstanceCollection performs a merge with any union data inside the ClearDagRun200JSONResponseBody, using the provided TaskInstanceCollection
func (*ClearDagRun200JSONResponseBody) UnmarshalJSON ¶ added in v0.5.4
func (t *ClearDagRun200JSONResponseBody) UnmarshalJSON(b []byte) error
type ClearDagRunJSONRequestBody ¶ added in v0.5.4
type ClearDagRunJSONRequestBody = DAGRunClearRequest
ClearDagRunJSONRequestBody defines body for ClearDagRun for application/json ContentType.
type ClearDagRunResponse ¶ added in v0.5.4
type ClearDagRunResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *ClearDagRun200JSONResponseBody
// JSON400 the response for an HTTP 400 `application/json` response
JSON400 *Error
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *Error
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *NotFound
// JSON409 the response for an HTTP 409 `application/json` response
JSON409 *Error
}
func ParseClearDagRunResponse ¶ added in v0.5.4
func ParseClearDagRunResponse(rsp *http.Response) (*ClearDagRunResponse, error)
ParseClearDagRunResponse parses an HTTP response from a ClearDagRunWithResponse call
func (ClearDagRunResponse) ContentType ¶ added in v0.5.4
func (r ClearDagRunResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (ClearDagRunResponse) GetBody ¶ added in v0.5.4
func (r ClearDagRunResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (ClearDagRunResponse) GetJSON200 ¶ added in v0.5.4
func (r ClearDagRunResponse) GetJSON200() *ClearDagRun200JSONResponseBody
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (ClearDagRunResponse) GetJSON400 ¶ added in v0.5.4
func (r ClearDagRunResponse) GetJSON400() *Error
GetJSON400 returns the response for an HTTP 400 `application/json` response
func (ClearDagRunResponse) GetJSON403 ¶ added in v0.5.4
func (r ClearDagRunResponse) GetJSON403() *Error
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (ClearDagRunResponse) GetJSON404 ¶ added in v0.5.4
func (r ClearDagRunResponse) GetJSON404() *NotFound
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (ClearDagRunResponse) GetJSON409 ¶ added in v0.5.4
func (r ClearDagRunResponse) GetJSON409() *Error
GetJSON409 returns the response for an HTTP 409 `application/json` response
func (ClearDagRunResponse) Status ¶ added in v0.5.4
func (r ClearDagRunResponse) Status() string
Status returns HTTPResponse.Status
func (ClearDagRunResponse) StatusCode ¶ added in v0.5.4
func (r ClearDagRunResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ClearTaskInstancesJSONRequestBody ¶
type ClearTaskInstancesJSONRequestBody = ClearTaskInstancesRequest
ClearTaskInstancesJSONRequestBody defines body for ClearTaskInstances for application/json ContentType.
type ClearTaskInstancesRequest ¶
type ClearTaskInstancesRequest struct {
DagRunId *string `json:"dag_run_id,omitempty"`
// DryRun Return the task instances that WOULD be cleared, without clearing them. Defaults to true, matching Apache Airflow, so a request that names no flags never destroys state. Send false to execute.
DryRun *bool `json:"dry_run,omitempty"`
IncludeDownstream *bool `json:"include_downstream,omitempty"`
IncludeFuture *bool `json:"include_future,omitempty"`
IncludePast *bool `json:"include_past,omitempty"`
IncludeUpstream *bool `json:"include_upstream,omitempty"`
// OnlyFailed Restrict the clear to task instances in a failed state, matching Apache Airflow. false widens it to every task instance named by the request, including ones that succeeded.
OnlyFailed *bool `json:"only_failed,omitempty"`
// OnlyRunning Not supported. Sending true is refused with 400. leoflow has no path that clears a running task instance (Apache Airflow sets it to RESTARTING and kills it), and honoring the only_failed=false that Airflow requires alongside it would widen the clear to every task instance named by the request, including ones that succeeded.
OnlyRunning *bool `json:"only_running,omitempty"`
// ResetDagRuns Re-open the run so the scheduler looks at it again. Without it a terminal run stays terminal and the cleared task instance is never scheduled.
ResetDagRuns *bool `json:"reset_dag_runs,omitempty"`
// RunOnLatestVersion Which version the re-run executes. false (the default, matching Apache Airflow) keeps the version the run was created with, so the re-run executes the image that produced the original attempt. true re-binds the run to the DAG's current registered version, so the re-run picks up the newest image and config. Use it to re-run a failed task against a fix without creating a new run. Only a finished run (success or failed, with no task instance queued or running) moves: the clear creates the task instances of the tasks the version adds and marks removed the ones of the tasks it dropped. A run that has not finished keeps its version, as in Airflow, and the response lists it in run_on_latest_version_not_applied with the reason (ADR 0086).
RunOnLatestVersion *bool `json:"run_on_latest_version,omitempty"`
TaskIds *[]string `json:"task_ids,omitempty"`
}
ClearTaskInstancesRequest defines model for ClearTaskInstancesRequest.
type ClearTaskInstancesResponse ¶
type ClearTaskInstancesResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *TaskInstanceCollection
// JSON409 the response for an HTTP 409 `application/json` response
JSON409 *Error
}
func ParseClearTaskInstancesResponse ¶
func ParseClearTaskInstancesResponse(rsp *http.Response) (*ClearTaskInstancesResponse, error)
ParseClearTaskInstancesResponse parses an HTTP response from a ClearTaskInstancesWithResponse call
func (ClearTaskInstancesResponse) ContentType ¶
func (r ClearTaskInstancesResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (ClearTaskInstancesResponse) GetBody ¶
func (r ClearTaskInstancesResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (ClearTaskInstancesResponse) GetJSON200 ¶
func (r ClearTaskInstancesResponse) GetJSON200() *TaskInstanceCollection
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (ClearTaskInstancesResponse) GetJSON409 ¶ added in v0.5.4
func (r ClearTaskInstancesResponse) GetJSON409() *Error
GetJSON409 returns the response for an HTTP 409 `application/json` response
func (ClearTaskInstancesResponse) Status ¶
func (r ClearTaskInstancesResponse) Status() string
Status returns HTTPResponse.Status
func (ClearTaskInstancesResponse) StatusCode ¶
func (r ClearTaskInstancesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ClearVersionNotApplied ¶ added in v0.5.5
type ClearVersionNotApplied = []struct {
DagRunId string `json:"dag_run_id"`
// Reason Why the run keeps its version, for example "the run is running: only a finished run moves to the current version".
Reason string `json:"reason"`
}
ClearVersionNotApplied Dexaflow-only. The runs a clear with run_on_latest_version keeps on their own version, each with the reason (ADR 0086): only a finished run with no task instance queued or running moves to the current version. The clear still applies to these runs, on their version. Left out when every run moved or the option was not asked, and on every response other than the two clear routes.
type Client ¶
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client HttpRequestDoer
// A list of callbacks for modifying requests which are generated before sending over
// the network.
RequestEditors []RequestEditorFn
}
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) ClearDagRun ¶ added in v0.5.4
func (c *Client) ClearDagRun(ctx context.Context, dagId DagID, dagRunId DagRunID, body ClearDagRunJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
ClearDagRun Clear a whole DAG run (queue its task instances for re-run)
The run page's Clear action. A dry run (the default) answers the task instances the clear would reset. The clear itself resets them, re-queues the run and answers the run.
Takes a body of the `application/json` content type.
Corresponds with POST /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/clear (the `ClearDagRun` operationId).
func (*Client) ClearDagRunWithBody ¶ added in v0.5.4
func (c *Client) ClearDagRunWithBody(ctx context.Context, dagId DagID, dagRunId DagRunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
ClearDagRunWithBody Clear a whole DAG run (queue its task instances for re-run)
The run page's Clear action. A dry run (the default) answers the task instances the clear would reset. The clear itself resets them, re-queues the run and answers the run.
Takes any type of body and a specified content type.
Corresponds with POST /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/clear (the `ClearDagRun` operationId).
func (*Client) ClearTaskInstances ¶
func (c *Client) ClearTaskInstances(ctx context.Context, dagId DagID, body ClearTaskInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
ClearTaskInstances Clear task instances (queue them for re-run)
Takes a body of the `application/json` content type.
Corresponds with POST /api/v2/dags/{dag_id}/clearTaskInstances (the `ClearTaskInstances` operationId).
func (*Client) ClearTaskInstancesWithBody ¶
func (c *Client) ClearTaskInstancesWithBody(ctx context.Context, dagId DagID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
ClearTaskInstancesWithBody Clear task instances (queue them for re-run)
Takes any type of body and a specified content type.
Corresponds with POST /api/v2/dags/{dag_id}/clearTaskInstances (the `ClearTaskInstances` operationId).
func (*Client) CreateAPIToken ¶ added in v0.5.4
func (c *Client) CreateAPIToken(ctx context.Context, body CreateAPITokenJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateAPIToken Create an API token (Dexaflow)
Creates a long-lived, named API token owned by the caller (ADR 0074). The response carries the token once; the server keeps only its SHA-256 hash. The token authenticates as its owner, with the owner's current roles narrowed to the token's scopes: deploy carries dexaflow:deploy alone (it registers versions, sets the current version, and reads the DAG list, DAGs, their details and versions, and nothing else), read carries dexaflow:read. The caller's roles must allow what the scope does (deploy needs deploy or write on dags, read needs read on dags). An account holds at most 50 live tokens. Audited as api_token.create. Reusing the name of an expired token retires that token, audited as api_token.retire_expired. Not callable with an API token or any other scoped token.
Takes a body of the `application/json` content type.
Corresponds with POST /api/v2/apiTokens (the `CreateAPIToken` operationId).
func (*Client) CreateAPITokenWithBody ¶ added in v0.5.4
func (c *Client) CreateAPITokenWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateAPITokenWithBody Create an API token (Dexaflow)
Creates a long-lived, named API token owned by the caller (ADR 0074). The response carries the token once; the server keeps only its SHA-256 hash. The token authenticates as its owner, with the owner's current roles narrowed to the token's scopes: deploy carries dexaflow:deploy alone (it registers versions, sets the current version, and reads the DAG list, DAGs, their details and versions, and nothing else), read carries dexaflow:read. The caller's roles must allow what the scope does (deploy needs deploy or write on dags, read needs read on dags). An account holds at most 50 live tokens. Audited as api_token.create. Reusing the name of an expired token retires that token, audited as api_token.retire_expired. Not callable with an API token or any other scoped token.
Takes any type of body and a specified content type.
Corresponds with POST /api/v2/apiTokens (the `CreateAPIToken` operationId).
func (*Client) CreateConnection ¶
func (c *Client) CreateConnection(ctx context.Context, body CreateConnectionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateConnection Create or replace a connection (upsert)
Upserts a connection: creates it, or replaces an existing one with the same connection_id. The password is write-only and never returned. Requires the write:connection permission and a configured encryption key.
Takes a body of the `application/json` content type.
Corresponds with POST /api/v2/connections (the `CreateConnection` operationId).
func (*Client) CreateConnectionWithBody ¶
func (c *Client) CreateConnectionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateConnectionWithBody Create or replace a connection (upsert)
Upserts a connection: creates it, or replaces an existing one with the same connection_id. The password is write-only and never returned. Requires the write:connection permission and a configured encryption key.
Takes any type of body and a specified content type.
Corresponds with POST /api/v2/connections (the `CreateConnection` operationId).
func (*Client) CreateUser ¶
func (c *Client) CreateUser(ctx context.Context, body CreateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateUser Create a user
Admin-only. Creates a control-plane account with the given email and password and grants the requested roles. The password is write-only and is never returned. Requires the write:user permission.
Takes a body of the `application/json` content type.
Corresponds with POST /api/v2/users (the `CreateUser` operationId).
func (*Client) CreateUserWithBody ¶
func (c *Client) CreateUserWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateUserWithBody Create a user
Admin-only. Creates a control-plane account with the given email and password and grants the requested roles. The password is write-only and is never returned. Requires the write:user permission.
Takes any type of body and a specified content type.
Corresponds with POST /api/v2/users (the `CreateUser` operationId).
func (*Client) CreateVariable ¶
func (c *Client) CreateVariable(ctx context.Context, body CreateVariableJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateVariable Create or replace a variable (upsert)
Upserts a variable: creates it, or replaces an existing one with the same key. Requires the write:variable permission.
Takes a body of the `application/json` content type.
Corresponds with POST /api/v2/variables (the `CreateVariable` operationId).
func (*Client) CreateVariableWithBody ¶
func (c *Client) CreateVariableWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateVariableWithBody Create or replace a variable (upsert)
Upserts a variable: creates it, or replaces an existing one with the same key. Requires the write:variable permission.
Takes any type of body and a specified content type.
Corresponds with POST /api/v2/variables (the `CreateVariable` operationId).
func (*Client) DeleteConnection ¶
func (c *Client) DeleteConnection(ctx context.Context, connectionId ConnectionID, reqEditors ...RequestEditorFn) (*http.Response, error)
DeleteConnection Delete a connection
Corresponds with DELETE /api/v2/connections/{connection_id} (the `DeleteConnection` operationId).
func (*Client) DeleteVariable ¶
func (c *Client) DeleteVariable(ctx context.Context, variableKey VariableKey, reqEditors ...RequestEditorFn) (*http.Response, error)
DeleteVariable Delete a variable
Corresponds with DELETE /api/v2/variables/{variable_key} (the `DeleteVariable` operationId).
func (*Client) ExchangeCIToken ¶ added in v0.5.5
func (c *Client) ExchangeCIToken(ctx context.Context, body CITokenRequest, reqEditors ...RequestEditorFn) (*CITokenResponse, error)
ExchangeCIToken posts a CI job's OIDC token to POST /api/v2/auth/ciToken and returns the session the server answers. A 404 is ErrCITokenNotServed; any other status but 200 is an error naming it and the problem detail.
func (*Client) ExchangeCLILoginCode ¶ added in v0.5.4
func (c *Client) ExchangeCLILoginCode(ctx context.Context, body CLITokenRequest, reqEditors ...RequestEditorFn) (*TokenResponse, error)
ExchangeCLILoginCode posts a one-time sign-in code with its PKCE verifier to POST /api/v2/auth/cli/token and returns the token the server answers, the same shape POST /auth/token answers. A refused code is ErrCLILoginCodeRefused; any other status but 200 is an error naming it.
func (*Client) GetAuthMethods ¶ added in v0.5.4
func (c *Client) GetAuthMethods(ctx context.Context, reqEditors ...RequestEditorFn) (*AuthMethods, error)
GetAuthMethods reads GET /api/v2/auth/methods through the client's Doer, server URL and request editors, then reqEditors. A server from before the route answers 404, which returns ErrAuthMethodsNotServed.
func (*Client) GetConnection ¶
func (c *Client) GetConnection(ctx context.Context, connectionId ConnectionID, reqEditors ...RequestEditorFn) (*http.Response, error)
GetConnection Get a connection
Corresponds with GET /api/v2/connections/{connection_id} (the `GetConnection` operationId).
func (*Client) GetDag ¶
func (c *Client) GetDag(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*http.Response, error)
GetDag Get a DAG
Corresponds with GET /api/v2/dags/{dag_id} (the `GetDag` operationId).
func (*Client) GetDagRun ¶
func (c *Client) GetDagRun(ctx context.Context, dagId DagID, dagRunId DagRunID, reqEditors ...RequestEditorFn) (*http.Response, error)
GetDagRun Get a DAG run
Corresponds with GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id} (the `GetDagRun` operationId).
func (*Client) GetDagSource ¶
func (c *Client) GetDagSource(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*http.Response, error)
GetDagSource Get a DAG's source (the dag.py text)
The source registered with one version of the DAG, as in Airflow 3.2: version_number selects the version, and without it (or with 0) the newest version is served. After a rollback the newest version is not the current one. A version the DAG does not have is a 404, and a version_number that is not an integer is a 400.
Corresponds with GET /api/v2/dagSources/{dag_id} (the `GetDagSource` operationId).
func (*Client) GetDagSpec ¶
func (c *Client) GetDagSpec(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*http.Response, error)
GetDagSpec Get a DAG's compiled spec (the dag.json artifact)
Corresponds with GET /api/v2/dags/{dag_id}/spec (the `GetDagSpec` operationId).
func (*Client) GetDagVersion ¶
func (c *Client) GetDagVersion(ctx context.Context, dagId DagID, versionNumber int, reqEditors ...RequestEditorFn) (*http.Response, error)
GetDagVersion Get a specific registered DAG version
Corresponds with GET /api/v2/dags/{dag_id}/dagVersions/{version_number} (the `GetDagVersion` operationId).
func (*Client) GetDagVersionSpec ¶ added in v0.5.4
func (c *Client) GetDagVersionSpec(ctx context.Context, dagID string, versionNumber int, reqEditors ...RequestEditorFn) (json.RawMessage, error)
GetDagVersionSpec reads GET /api/v2/dags/{dag_id}/dagVersions/{version_number}/spec, the dag.json registered with that version of the DAG, through the client's Doer, server URL and request editors, then reqEditors (#1708). The spec is returned as served, byte for byte, so it can be registered again unchanged. An answer other than 200 is a *StatusError: a 404 is an unknown version or a server from before the route. The route gets no generated method (see overlay.yaml): a new method on ClientInterface would break every implementation of it.
func (*Client) GetDeployDefaults ¶ added in v0.5.4
func (c *Client) GetDeployDefaults(ctx context.Context, reqEditors ...RequestEditorFn) (*DeployDefaults, error)
GetDeployDefaults reads GET /api/v2/deployDefaults through the client's Doer, server URL and request editors, then reqEditors. A server from before the route answers 404, which returns ErrDeployDefaultsNotServed; any other status but 200 is an error naming it. The route gets no generated method (see overlay.yaml): a new method on ClientInterface would break every implementation of it.
func (*Client) GetHealthz ¶
func (c *Client) GetHealthz(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
GetHealthz Liveness probe
Corresponds with GET /healthz (the `GetHealthz` operationId).
func (*Client) GetMonitorExecutor ¶
func (c *Client) GetMonitorExecutor(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
GetMonitorExecutor Executor capability and configuration
Corresponds with GET /api/v2/monitor/executor (the `GetMonitorExecutor` operationId).
func (*Client) GetMonitorHealth ¶
func (c *Client) GetMonitorHealth(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
GetMonitorHealth Control-plane health (Airflow HealthInfoResponse shape)
Corresponds with GET /api/v2/monitor/health (the `GetMonitorHealth` operationId).
func (*Client) GetReadyz ¶
func (c *Client) GetReadyz(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
GetReadyz Readiness probe
Corresponds with GET /readyz (the `GetReadyz` operationId).
func (*Client) GetTaskInstance ¶
func (c *Client) GetTaskInstance(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, reqEditors ...RequestEditorFn) (*http.Response, error)
GetTaskInstance Get a task instance
Corresponds with GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} (the `GetTaskInstance` operationId).
func (*Client) GetTaskLogs ¶
func (c *Client) GetTaskLogs(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, tryNumber int, reqEditors ...RequestEditorFn) (*http.Response, error)
GetTaskLogs Get task logs
Corresponds with GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{try_number} (the `GetTaskLogs` operationId).
func (*Client) GetVariable ¶
func (c *Client) GetVariable(ctx context.Context, variableKey VariableKey, reqEditors ...RequestEditorFn) (*http.Response, error)
GetVariable Get a variable
Corresponds with GET /api/v2/variables/{variable_key} (the `GetVariable` operationId).
func (*Client) GetVersion ¶
func (c *Client) GetVersion(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
GetVersion Control-plane version (Airflow VersionInfo shape)
Corresponds with GET /api/v2/version (the `GetVersion` operationId).
func (*Client) GetXcomEntry ¶
func (c *Client) GetXcomEntry(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, key string, reqEditors ...RequestEditorFn) (*http.Response, error)
GetXcomEntry Read XCom value (read-only proxy for the Redis backend)
Corresponds with GET /api/v2/xcoms/{dag_id}/{dag_run_id}/{task_id}/{key} (the `GetXcomEntry` operationId).
func (*Client) IssueToken ¶
func (c *Client) IssueToken(ctx context.Context, body IssueTokenJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
IssueToken Issue a JWT for username/password credentials
Takes a body of the `application/json` content type.
Corresponds with POST /auth/token (the `IssueToken` operationId).
func (*Client) IssueTokenWithBody ¶
func (c *Client) IssueTokenWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
IssueTokenWithBody Issue a JWT for username/password credentials
Takes any type of body and a specified content type.
Corresponds with POST /auth/token (the `IssueToken` operationId).
func (*Client) ListAPITokens ¶ added in v0.5.4
func (c *Client) ListAPITokens(ctx context.Context, params *ListAPITokensParams, reqEditors ...RequestEditorFn) (*http.Response, error)
ListAPITokens List API tokens (Dexaflow)
Lists the caller's unrevoked API tokens, newest first, expired ones included. A caller who may manage accounts (write:user) sees every token of the tenant. The token itself and its hash are never returned. Not callable with an API token or any other scoped token (ADR 0074).
Corresponds with GET /api/v2/apiTokens (the `ListAPITokens` operationId).
func (*Client) ListConnections ¶
func (c *Client) ListConnections(ctx context.Context, params *ListConnectionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
ListConnections List connections
Lists the tenant's Airflow-style connections. Passwords are write-only and never returned; secret-bearing keys inside `extra` are masked server-side. Requires the read:connection permission.
Corresponds with GET /api/v2/connections (the `ListConnections` operationId).
func (*Client) ListDagRuns ¶
func (c *Client) ListDagRuns(ctx context.Context, dagId DagID, params *ListDagRunsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
ListDagRuns List DAG runs
Corresponds with GET /api/v2/dags/{dag_id}/dagRuns (the `ListDagRuns` operationId).
func (*Client) ListDagVersions ¶
func (c *Client) ListDagVersions(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*http.Response, error)
ListDagVersions List a DAG's registered versions
Corresponds with GET /api/v2/dags/{dag_id}/dagVersions (the `ListDagVersions` operationId).
func (*Client) ListDags ¶
func (c *Client) ListDags(ctx context.Context, params *ListDagsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
ListDags List DAGs
Corresponds with GET /api/v2/dags (the `ListDags` operationId).
func (*Client) ListTaskInstances ¶
func (c *Client) ListTaskInstances(ctx context.Context, dagId DagID, dagRunId DagRunID, reqEditors ...RequestEditorFn) (*http.Response, error)
ListTaskInstances List task instances of a DAG run
Pages with the same limit, offset and cursor query parameters as the DAG run list (they are not declared on this operation so the generated client keeps its signature). A request that carries cursor gets next_cursor and previous_cursor in the body; only the offset cursors this list issues are accepted, any other is refused with 400.
Corresponds with GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances (the `ListTaskInstances` operationId).
func (*Client) ListUsers ¶
func (c *Client) ListUsers(ctx context.Context, params *ListUsersParams, reqEditors ...RequestEditorFn) (*http.Response, error)
ListUsers List users
Lists the tenant's control-plane accounts, newest first. Each entry carries the full set of roles the user holds; the password and its hash are write-only and never returned. Requires the read:user permission.
Corresponds with GET /api/v2/users (the `ListUsers` operationId).
func (*Client) ListVariables ¶
func (c *Client) ListVariables(ctx context.Context, params *ListVariablesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
ListVariables List variables
Lists the tenant's Airflow-style variables. Values of secret-ish keys are masked server-side. Requires the read:variable permission.
Corresponds with GET /api/v2/variables (the `ListVariables` operationId).
func (*Client) PatchTaskInstance ¶ added in v0.5.4
func (c *Client) PatchTaskInstance(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, body PatchTaskInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
PatchTaskInstance Mark a task instance as success, failed or skipped
Sets the task instance's state, as the UI's Mark as action does. The answer is the affected set, a collection holding the updated task instance, as Apache Airflow declares it.
Takes a body of the `application/json` content type.
Corresponds with PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} (the `PatchTaskInstance` operationId).
func (*Client) PatchTaskInstanceDryRun ¶ added in v0.5.4
func (c *Client) PatchTaskInstanceDryRun(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, body PatchTaskInstanceDryRunJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
PatchTaskInstanceDryRun Preview marking a task instance
Answers the task instance with the state the PATCH would set, without changing anything.
Takes a body of the `application/json` content type.
Corresponds with PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/dry_run (the `PatchTaskInstanceDryRun` operationId).
func (*Client) PatchTaskInstanceDryRunWithBody ¶ added in v0.5.4
func (c *Client) PatchTaskInstanceDryRunWithBody(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PatchTaskInstanceDryRunWithBody Preview marking a task instance
Answers the task instance with the state the PATCH would set, without changing anything.
Takes any type of body and a specified content type.
Corresponds with PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/dry_run (the `PatchTaskInstanceDryRun` operationId).
func (*Client) PatchTaskInstanceWithBody ¶ added in v0.5.4
func (c *Client) PatchTaskInstanceWithBody(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PatchTaskInstanceWithBody Mark a task instance as success, failed or skipped
Sets the task instance's state, as the UI's Mark as action does. The answer is the affected set, a collection holding the updated task instance, as Apache Airflow declares it.
Takes any type of body and a specified content type.
Corresponds with PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} (the `PatchTaskInstance` operationId).
func (*Client) PollCLIDeviceLogin ¶ added in v0.5.4
func (c *Client) PollCLIDeviceLogin(ctx context.Context, deviceCode string, reqEditors ...RequestEditorFn) (*TokenResponse, error)
PollCLIDeviceLogin polls a device sign-in once on POST /api/v2/auth/cli/token and returns the token once it was approved. A refusal is one of the ErrDevice sentinels, or ErrCLILoginCodeRefused for a device code that is not live; a 429 is ErrDeviceSlowDown too.
func (*Client) RegisterDagVersion ¶ added in v0.5.4
func (c *Client) RegisterDagVersion(ctx context.Context, dagId DagID, params *RegisterDagVersionParams, body RegisterDagVersionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
RegisterDagVersion Register a compiled DAG version (Dexaflow)
Registers a compiled dag.json as a new version of the DAG and makes it current. Re-registering content that is already registered (same spec hash) is a no-op answered with 200 and created false, and leaves the current version as it is. The same label with other content is refused with 409. Needs deploy or write on dags (scope dexaflow:deploy). Without is_paused, a DAG the register creates starts paused per its is_paused_upon_creation, else the server's dags_are_paused_at_creation, and an existing DAG keeps its state. With is_paused, the DAG ends the register in that state whether it is created, gets a new version or already had this content; a change to an existing DAG is audited as dag.pause or dag.unpause in the same transaction. Pausing is a run-state write: sending is_paused also needs write on dags, and a scoped token needs dexaflow:run as well as dexaflow:deploy, else the register is refused with 403. Under the server setting deploy.require_digest, an image that is not pinned by a full digest (repository@sha256: and 64 hex characters) is registered with a warning in warnings (warn), or refused with 400 (enforce). Off, the default, accepts any image. POST /api/v2/dags/{dag_id}/versions/dry_run runs the same checks and writes nothing.
Takes a body of the `application/json` content type.
Corresponds with POST /api/v2/dags/{dag_id}/versions (the `RegisterDagVersion` operationId).
func (*Client) RegisterDagVersionWithBody ¶ added in v0.5.4
func (c *Client) RegisterDagVersionWithBody(ctx context.Context, dagId DagID, params *RegisterDagVersionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
RegisterDagVersionWithBody Register a compiled DAG version (Dexaflow)
Registers a compiled dag.json as a new version of the DAG and makes it current. Re-registering content that is already registered (same spec hash) is a no-op answered with 200 and created false, and leaves the current version as it is. The same label with other content is refused with 409. Needs deploy or write on dags (scope dexaflow:deploy). Without is_paused, a DAG the register creates starts paused per its is_paused_upon_creation, else the server's dags_are_paused_at_creation, and an existing DAG keeps its state. With is_paused, the DAG ends the register in that state whether it is created, gets a new version or already had this content; a change to an existing DAG is audited as dag.pause or dag.unpause in the same transaction. Pausing is a run-state write: sending is_paused also needs write on dags, and a scoped token needs dexaflow:run as well as dexaflow:deploy, else the register is refused with 403. Under the server setting deploy.require_digest, an image that is not pinned by a full digest (repository@sha256: and 64 hex characters) is registered with a warning in warnings (warn), or refused with 400 (enforce). Off, the default, accepts any image. POST /api/v2/dags/{dag_id}/versions/dry_run runs the same checks and writes nothing.
Takes any type of body and a specified content type.
Corresponds with POST /api/v2/dags/{dag_id}/versions (the `RegisterDagVersion` operationId).
func (*Client) RenewToken ¶
func (c *Client) RenewToken(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
RenewToken Renew a still-valid JWT into a fresh short-lived token
Transparent renewal: given a still-valid user bearer, re-mints the same identity with a fresh short TTL, bounded by a server-side max_lifetime measured from first login. Lets a long CLI/dev session avoid re-logging in every token TTL while keeping the access token short-lived. Returns 401 when the presented token is invalid, expired, or past max_lifetime, in which case the client must log in again.
Corresponds with POST /api/v2/auth/token/renew (the `RenewToken` operationId).
func (*Client) RevokeAPIToken ¶ added in v0.5.4
func (c *Client) RevokeAPIToken(ctx context.Context, tokenId string, reqEditors ...RequestEditorFn) (*http.Response, error)
RevokeAPIToken Revoke an API token (Dexaflow)
Revokes one of the caller's API tokens, or any token of the tenant for a caller who may manage accounts (write:user). The token stops working on its next request. Revoking a revoked token succeeds. Audited as api_token.revoke. Not callable with an API token or any other scoped token.
Corresponds with DELETE /api/v2/apiTokens/{token_id} (the `RevokeAPIToken` operationId).
func (*Client) SetDagCurrentVersion ¶ added in v0.5.4
func (c *Client) SetDagCurrentVersion(ctx context.Context, dagId DagID, body SetDagCurrentVersionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
SetDagCurrentVersion Make a registered version current (Dexaflow)
Makes a registered version of the DAG the one new runs are created with, by label or by version_number: a rollback, or a roll forward. The DAG's schedule and metadata become that version's, in the same transaction. Runs that already exist keep their version, and is_paused is never changed. The version must pass the checks a register of it would pass today. Naming the current version changes nothing (changed false). Audited as dag.version.set_current. Needs deploy or write on dags (scope dexaflow:deploy). Under the server setting deploy.require_digest, a version whose image is not pinned by a full sha256 digest is made current with a warning in warnings (warn), or refused with 400 (enforce).
Takes a body of the `application/json` content type.
Corresponds with PUT /api/v2/dags/{dag_id}/currentVersion (the `SetDagCurrentVersion` operationId).
func (*Client) SetDagCurrentVersionWithBody ¶ added in v0.5.4
func (c *Client) SetDagCurrentVersionWithBody(ctx context.Context, dagId DagID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
SetDagCurrentVersionWithBody Make a registered version current (Dexaflow)
Makes a registered version of the DAG the one new runs are created with, by label or by version_number: a rollback, or a roll forward. The DAG's schedule and metadata become that version's, in the same transaction. Runs that already exist keep their version, and is_paused is never changed. The version must pass the checks a register of it would pass today. Naming the current version changes nothing (changed false). Audited as dag.version.set_current. Needs deploy or write on dags (scope dexaflow:deploy). Under the server setting deploy.require_digest, a version whose image is not pinned by a full sha256 digest is made current with a warning in warnings (warn), or refused with 400 (enforce).
Takes any type of body and a specified content type.
Corresponds with PUT /api/v2/dags/{dag_id}/currentVersion (the `SetDagCurrentVersion` operationId).
func (*Client) StartCLIDeviceLogin ¶ added in v0.5.4
func (c *Client) StartCLIDeviceLogin(ctx context.Context, reqEditors ...RequestEditorFn) (*CLIDeviceAuthorization, error)
StartCLIDeviceLogin starts a device sign-in with POST /api/v2/auth/cli/device. A server without the route answers 404, which returns ErrDeviceLoginNotServed.
func (*Client) TriggerDagRun ¶
func (c *Client) TriggerDagRun(ctx context.Context, dagId DagID, body TriggerDagRunJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
TriggerDagRun Trigger a DAG run
Takes a body of the `application/json` content type.
Corresponds with POST /api/v2/dags/{dag_id}/dagRuns (the `TriggerDagRun` operationId).
func (*Client) TriggerDagRunWithBody ¶
func (c *Client) TriggerDagRunWithBody(ctx context.Context, dagId DagID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
TriggerDagRunWithBody Trigger a DAG run
Takes any type of body and a specified content type.
Corresponds with POST /api/v2/dags/{dag_id}/dagRuns (the `TriggerDagRun` operationId).
func (*Client) UpdateConnection ¶
func (c *Client) UpdateConnection(ctx context.Context, connectionId ConnectionID, body UpdateConnectionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateConnection Update a connection
Takes a body of the `application/json` content type.
Corresponds with PATCH /api/v2/connections/{connection_id} (the `UpdateConnection` operationId).
func (*Client) UpdateConnectionWithBody ¶
func (c *Client) UpdateConnectionWithBody(ctx context.Context, connectionId ConnectionID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateConnectionWithBody Update a connection
Takes any type of body and a specified content type.
Corresponds with PATCH /api/v2/connections/{connection_id} (the `UpdateConnection` operationId).
func (*Client) UpdateDag ¶
func (c *Client) UpdateDag(ctx context.Context, dagId DagID, body UpdateDagJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateDag Update DAG (typically pause/unpause)
Sets is_paused. A change is audited as dag.pause or dag.unpause with the acting user; asking for the state the DAG is already in records nothing.
Takes a body of the `application/json` content type.
Corresponds with PATCH /api/v2/dags/{dag_id} (the `UpdateDag` operationId).
func (*Client) UpdateDagWithBody ¶
func (c *Client) UpdateDagWithBody(ctx context.Context, dagId DagID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateDagWithBody Update DAG (typically pause/unpause)
Sets is_paused. A change is audited as dag.pause or dag.unpause with the acting user; asking for the state the DAG is already in records nothing.
Takes any type of body and a specified content type.
Corresponds with PATCH /api/v2/dags/{dag_id} (the `UpdateDag` operationId).
type ClientInterface ¶
type ClientInterface interface {
// ListAPITokens List API tokens (Dexaflow)
//
// Lists the caller's unrevoked API tokens, newest first, expired ones included. A caller who may manage accounts (write:user) sees every token of the tenant. The token itself and its hash are never returned. Not callable with an API token or any other scoped token (ADR 0074).
//
// Corresponds with GET /api/v2/apiTokens (the `ListAPITokens` operationId).
ListAPITokens(ctx context.Context, params *ListAPITokensParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateAPITokenWithBody Create an API token (Dexaflow)
//
// Creates a long-lived, named API token owned by the caller (ADR 0074). The response carries the token once; the server keeps only its SHA-256 hash. The token authenticates as its owner, with the owner's current roles narrowed to the token's scopes: deploy carries dexaflow:deploy alone (it registers versions, sets the current version, and reads the DAG list, DAGs, their details and versions, and nothing else), read carries dexaflow:read. The caller's roles must allow what the scope does (deploy needs deploy or write on dags, read needs read on dags). An account holds at most 50 live tokens. Audited as api_token.create. Reusing the name of an expired token retires that token, audited as api_token.retire_expired. Not callable with an API token or any other scoped token.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /api/v2/apiTokens (the `CreateAPIToken` operationId).
CreateAPITokenWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateAPIToken Create an API token (Dexaflow)
//
// Creates a long-lived, named API token owned by the caller (ADR 0074). The response carries the token once; the server keeps only its SHA-256 hash. The token authenticates as its owner, with the owner's current roles narrowed to the token's scopes: deploy carries dexaflow:deploy alone (it registers versions, sets the current version, and reads the DAG list, DAGs, their details and versions, and nothing else), read carries dexaflow:read. The caller's roles must allow what the scope does (deploy needs deploy or write on dags, read needs read on dags). An account holds at most 50 live tokens. Audited as api_token.create. Reusing the name of an expired token retires that token, audited as api_token.retire_expired. Not callable with an API token or any other scoped token.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /api/v2/apiTokens (the `CreateAPIToken` operationId).
CreateAPIToken(ctx context.Context, body CreateAPITokenJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// RevokeAPIToken Revoke an API token (Dexaflow)
//
// Revokes one of the caller's API tokens, or any token of the tenant for a caller who may manage accounts (write:user). The token stops working on its next request. Revoking a revoked token succeeds. Audited as api_token.revoke. Not callable with an API token or any other scoped token.
//
// Corresponds with DELETE /api/v2/apiTokens/{token_id} (the `RevokeAPIToken` operationId).
RevokeAPIToken(ctx context.Context, tokenId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// RenewToken Renew a still-valid JWT into a fresh short-lived token
//
// Transparent renewal: given a still-valid user bearer, re-mints the same identity with a fresh short TTL, bounded by a server-side max_lifetime measured from first login. Lets a long CLI/dev session avoid re-logging in every token TTL while keeping the access token short-lived. Returns 401 when the presented token is invalid, expired, or past max_lifetime, in which case the client must log in again.
//
// Corresponds with POST /api/v2/auth/token/renew (the `RenewToken` operationId).
RenewToken(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListConnections List connections
//
// Lists the tenant's Airflow-style connections. Passwords are write-only and
// never returned; secret-bearing keys inside `extra` are masked server-side.
// Requires the read:connection permission.
//
// Corresponds with GET /api/v2/connections (the `ListConnections` operationId).
ListConnections(ctx context.Context, params *ListConnectionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateConnectionWithBody Create or replace a connection (upsert)
//
// Upserts a connection: creates it, or replaces an existing one with the same
// connection_id. The password is write-only and never returned. Requires the
// write:connection permission and a configured encryption key.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /api/v2/connections (the `CreateConnection` operationId).
CreateConnectionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateConnection Create or replace a connection (upsert)
//
// Upserts a connection: creates it, or replaces an existing one with the same
// connection_id. The password is write-only and never returned. Requires the
// write:connection permission and a configured encryption key.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /api/v2/connections (the `CreateConnection` operationId).
CreateConnection(ctx context.Context, body CreateConnectionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteConnection Delete a connection
//
// Corresponds with DELETE /api/v2/connections/{connection_id} (the `DeleteConnection` operationId).
DeleteConnection(ctx context.Context, connectionId ConnectionID, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetConnection Get a connection
//
// Corresponds with GET /api/v2/connections/{connection_id} (the `GetConnection` operationId).
GetConnection(ctx context.Context, connectionId ConnectionID, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateConnectionWithBody Update a connection
//
// Takes any type of body and a specified content type.
//
// Corresponds with PATCH /api/v2/connections/{connection_id} (the `UpdateConnection` operationId).
UpdateConnectionWithBody(ctx context.Context, connectionId ConnectionID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateConnection Update a connection
//
// Takes a body of the `application/json` content type.
//
// Corresponds with PATCH /api/v2/connections/{connection_id} (the `UpdateConnection` operationId).
UpdateConnection(ctx context.Context, connectionId ConnectionID, body UpdateConnectionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetDagSource Get a DAG's source (the dag.py text)
//
// The source registered with one version of the DAG, as in Airflow 3.2: version_number selects the version, and without it (or with 0) the newest version is served. After a rollback the newest version is not the current one. A version the DAG does not have is a 404, and a version_number that is not an integer is a 400.
//
// Corresponds with GET /api/v2/dagSources/{dag_id} (the `GetDagSource` operationId).
GetDagSource(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListDags List DAGs
//
// Corresponds with GET /api/v2/dags (the `ListDags` operationId).
ListDags(ctx context.Context, params *ListDagsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetDag Get a DAG
//
// Corresponds with GET /api/v2/dags/{dag_id} (the `GetDag` operationId).
GetDag(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateDagWithBody Update DAG (typically pause/unpause)
//
// Sets is_paused. A change is audited as dag.pause or dag.unpause with the acting user; asking for the state the DAG is already in records nothing.
//
// Takes any type of body and a specified content type.
//
// Corresponds with PATCH /api/v2/dags/{dag_id} (the `UpdateDag` operationId).
UpdateDagWithBody(ctx context.Context, dagId DagID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateDag Update DAG (typically pause/unpause)
//
// Sets is_paused. A change is audited as dag.pause or dag.unpause with the acting user; asking for the state the DAG is already in records nothing.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with PATCH /api/v2/dags/{dag_id} (the `UpdateDag` operationId).
UpdateDag(ctx context.Context, dagId DagID, body UpdateDagJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ClearTaskInstancesWithBody Clear task instances (queue them for re-run)
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /api/v2/dags/{dag_id}/clearTaskInstances (the `ClearTaskInstances` operationId).
ClearTaskInstancesWithBody(ctx context.Context, dagId DagID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// ClearTaskInstances Clear task instances (queue them for re-run)
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /api/v2/dags/{dag_id}/clearTaskInstances (the `ClearTaskInstances` operationId).
ClearTaskInstances(ctx context.Context, dagId DagID, body ClearTaskInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// SetDagCurrentVersionWithBody Make a registered version current (Dexaflow)
//
// Makes a registered version of the DAG the one new runs are created with, by label or by version_number: a rollback, or a roll forward. The DAG's schedule and metadata become that version's, in the same transaction. Runs that already exist keep their version, and is_paused is never changed. The version must pass the checks a register of it would pass today. Naming the current version changes nothing (changed false). Audited as dag.version.set_current. Needs deploy or write on dags (scope dexaflow:deploy). Under the server setting deploy.require_digest, a version whose image is not pinned by a full sha256 digest is made current with a warning in warnings (warn), or refused with 400 (enforce).
//
// Takes any type of body and a specified content type.
//
// Corresponds with PUT /api/v2/dags/{dag_id}/currentVersion (the `SetDagCurrentVersion` operationId).
SetDagCurrentVersionWithBody(ctx context.Context, dagId DagID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// SetDagCurrentVersion Make a registered version current (Dexaflow)
//
// Makes a registered version of the DAG the one new runs are created with, by label or by version_number: a rollback, or a roll forward. The DAG's schedule and metadata become that version's, in the same transaction. Runs that already exist keep their version, and is_paused is never changed. The version must pass the checks a register of it would pass today. Naming the current version changes nothing (changed false). Audited as dag.version.set_current. Needs deploy or write on dags (scope dexaflow:deploy). Under the server setting deploy.require_digest, a version whose image is not pinned by a full sha256 digest is made current with a warning in warnings (warn), or refused with 400 (enforce).
//
// Takes a body of the `application/json` content type.
//
// Corresponds with PUT /api/v2/dags/{dag_id}/currentVersion (the `SetDagCurrentVersion` operationId).
SetDagCurrentVersion(ctx context.Context, dagId DagID, body SetDagCurrentVersionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListDagRuns List DAG runs
//
// Corresponds with GET /api/v2/dags/{dag_id}/dagRuns (the `ListDagRuns` operationId).
ListDagRuns(ctx context.Context, dagId DagID, params *ListDagRunsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// TriggerDagRunWithBody Trigger a DAG run
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /api/v2/dags/{dag_id}/dagRuns (the `TriggerDagRun` operationId).
TriggerDagRunWithBody(ctx context.Context, dagId DagID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// TriggerDagRun Trigger a DAG run
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /api/v2/dags/{dag_id}/dagRuns (the `TriggerDagRun` operationId).
TriggerDagRun(ctx context.Context, dagId DagID, body TriggerDagRunJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetDagRun Get a DAG run
//
// Corresponds with GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id} (the `GetDagRun` operationId).
GetDagRun(ctx context.Context, dagId DagID, dagRunId DagRunID, reqEditors ...RequestEditorFn) (*http.Response, error)
// ClearDagRunWithBody Clear a whole DAG run (queue its task instances for re-run)
//
// The run page's Clear action. A dry run (the default) answers the task instances the clear would reset. The clear itself resets them, re-queues the run and answers the run.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/clear (the `ClearDagRun` operationId).
ClearDagRunWithBody(ctx context.Context, dagId DagID, dagRunId DagRunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// ClearDagRun Clear a whole DAG run (queue its task instances for re-run)
//
// The run page's Clear action. A dry run (the default) answers the task instances the clear would reset. The clear itself resets them, re-queues the run and answers the run.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/clear (the `ClearDagRun` operationId).
ClearDagRun(ctx context.Context, dagId DagID, dagRunId DagRunID, body ClearDagRunJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListTaskInstances List task instances of a DAG run
//
// Pages with the same limit, offset and cursor query parameters as the DAG run list (they are not declared on this operation so the generated client keeps its signature). A request that carries cursor gets next_cursor and previous_cursor in the body; only the offset cursors this list issues are accepted, any other is refused with 400.
//
// Corresponds with GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances (the `ListTaskInstances` operationId).
ListTaskInstances(ctx context.Context, dagId DagID, dagRunId DagRunID, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetTaskInstance Get a task instance
//
// Corresponds with GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} (the `GetTaskInstance` operationId).
GetTaskInstance(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, reqEditors ...RequestEditorFn) (*http.Response, error)
// PatchTaskInstanceWithBody Mark a task instance as success, failed or skipped
//
// Sets the task instance's state, as the UI's Mark as action does. The answer is the affected set, a collection holding the updated task instance, as Apache Airflow declares it.
//
// Takes any type of body and a specified content type.
//
// Corresponds with PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} (the `PatchTaskInstance` operationId).
PatchTaskInstanceWithBody(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// PatchTaskInstance Mark a task instance as success, failed or skipped
//
// Sets the task instance's state, as the UI's Mark as action does. The answer is the affected set, a collection holding the updated task instance, as Apache Airflow declares it.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} (the `PatchTaskInstance` operationId).
PatchTaskInstance(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, body PatchTaskInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// PatchTaskInstanceDryRunWithBody Preview marking a task instance
//
// Answers the task instance with the state the PATCH would set, without changing anything.
//
// Takes any type of body and a specified content type.
//
// Corresponds with PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/dry_run (the `PatchTaskInstanceDryRun` operationId).
PatchTaskInstanceDryRunWithBody(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// PatchTaskInstanceDryRun Preview marking a task instance
//
// Answers the task instance with the state the PATCH would set, without changing anything.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/dry_run (the `PatchTaskInstanceDryRun` operationId).
PatchTaskInstanceDryRun(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, body PatchTaskInstanceDryRunJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetTaskLogs Get task logs
//
// Corresponds with GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{try_number} (the `GetTaskLogs` operationId).
GetTaskLogs(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, tryNumber int, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListDagVersions List a DAG's registered versions
//
// Corresponds with GET /api/v2/dags/{dag_id}/dagVersions (the `ListDagVersions` operationId).
ListDagVersions(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetDagVersion Get a specific registered DAG version
//
// Corresponds with GET /api/v2/dags/{dag_id}/dagVersions/{version_number} (the `GetDagVersion` operationId).
GetDagVersion(ctx context.Context, dagId DagID, versionNumber int, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetDagSpec Get a DAG's compiled spec (the dag.json artifact)
//
// Corresponds with GET /api/v2/dags/{dag_id}/spec (the `GetDagSpec` operationId).
GetDagSpec(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*http.Response, error)
// RegisterDagVersionWithBody Register a compiled DAG version (Dexaflow)
//
// Registers a compiled dag.json as a new version of the DAG and makes it current. Re-registering content that is already registered (same spec hash) is a no-op answered with 200 and created false, and leaves the current version as it is. The same label with other content is refused with 409. Needs deploy or write on dags (scope dexaflow:deploy).
// Without is_paused, a DAG the register creates starts paused per its is_paused_upon_creation, else the server's dags_are_paused_at_creation, and an existing DAG keeps its state. With is_paused, the DAG ends the register in that state whether it is created, gets a new version or already had this content; a change to an existing DAG is audited as dag.pause or dag.unpause in the same transaction. Pausing is a run-state write: sending is_paused also needs write on dags, and a scoped token needs dexaflow:run as well as dexaflow:deploy, else the register is refused with 403.
// Under the server setting deploy.require_digest, an image that is not pinned by a full digest (repository@sha256: and 64 hex characters) is registered with a warning in warnings (warn), or refused with 400 (enforce). Off, the default, accepts any image.
// POST /api/v2/dags/{dag_id}/versions/dry_run runs the same checks and writes nothing.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /api/v2/dags/{dag_id}/versions (the `RegisterDagVersion` operationId).
RegisterDagVersionWithBody(ctx context.Context, dagId DagID, params *RegisterDagVersionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// RegisterDagVersion Register a compiled DAG version (Dexaflow)
//
// Registers a compiled dag.json as a new version of the DAG and makes it current. Re-registering content that is already registered (same spec hash) is a no-op answered with 200 and created false, and leaves the current version as it is. The same label with other content is refused with 409. Needs deploy or write on dags (scope dexaflow:deploy).
// Without is_paused, a DAG the register creates starts paused per its is_paused_upon_creation, else the server's dags_are_paused_at_creation, and an existing DAG keeps its state. With is_paused, the DAG ends the register in that state whether it is created, gets a new version or already had this content; a change to an existing DAG is audited as dag.pause or dag.unpause in the same transaction. Pausing is a run-state write: sending is_paused also needs write on dags, and a scoped token needs dexaflow:run as well as dexaflow:deploy, else the register is refused with 403.
// Under the server setting deploy.require_digest, an image that is not pinned by a full digest (repository@sha256: and 64 hex characters) is registered with a warning in warnings (warn), or refused with 400 (enforce). Off, the default, accepts any image.
// POST /api/v2/dags/{dag_id}/versions/dry_run runs the same checks and writes nothing.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /api/v2/dags/{dag_id}/versions (the `RegisterDagVersion` operationId).
RegisterDagVersion(ctx context.Context, dagId DagID, params *RegisterDagVersionParams, body RegisterDagVersionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetMonitorExecutor Executor capability and configuration
//
// Corresponds with GET /api/v2/monitor/executor (the `GetMonitorExecutor` operationId).
GetMonitorExecutor(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetMonitorHealth Control-plane health (Airflow HealthInfoResponse shape)
//
// Corresponds with GET /api/v2/monitor/health (the `GetMonitorHealth` operationId).
GetMonitorHealth(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListUsers List users
//
// Lists the tenant's control-plane accounts, newest first. Each entry
// carries the full set of roles the user holds; the password and its hash
// are write-only and never returned. Requires the read:user permission.
//
// Corresponds with GET /api/v2/users (the `ListUsers` operationId).
ListUsers(ctx context.Context, params *ListUsersParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateUserWithBody Create a user
//
// Admin-only. Creates a control-plane account with the given email and
// password and grants the requested roles. The password is write-only and
// is never returned. Requires the write:user permission.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /api/v2/users (the `CreateUser` operationId).
CreateUserWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateUser Create a user
//
// Admin-only. Creates a control-plane account with the given email and
// password and grants the requested roles. The password is write-only and
// is never returned. Requires the write:user permission.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /api/v2/users (the `CreateUser` operationId).
CreateUser(ctx context.Context, body CreateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ListVariables List variables
//
// Lists the tenant's Airflow-style variables. Values of secret-ish keys are
// masked server-side. Requires the read:variable permission.
//
// Corresponds with GET /api/v2/variables (the `ListVariables` operationId).
ListVariables(ctx context.Context, params *ListVariablesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateVariableWithBody Create or replace a variable (upsert)
//
// Upserts a variable: creates it, or replaces an existing one with the same
// key. Requires the write:variable permission.
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /api/v2/variables (the `CreateVariable` operationId).
CreateVariableWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateVariable Create or replace a variable (upsert)
//
// Upserts a variable: creates it, or replaces an existing one with the same
// key. Requires the write:variable permission.
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /api/v2/variables (the `CreateVariable` operationId).
CreateVariable(ctx context.Context, body CreateVariableJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteVariable Delete a variable
//
// Corresponds with DELETE /api/v2/variables/{variable_key} (the `DeleteVariable` operationId).
DeleteVariable(ctx context.Context, variableKey VariableKey, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetVariable Get a variable
//
// Corresponds with GET /api/v2/variables/{variable_key} (the `GetVariable` operationId).
GetVariable(ctx context.Context, variableKey VariableKey, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetVersion Control-plane version (Airflow VersionInfo shape)
//
// Corresponds with GET /api/v2/version (the `GetVersion` operationId).
GetVersion(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetXcomEntry Read XCom value (read-only proxy for the Redis backend)
//
// Corresponds with GET /api/v2/xcoms/{dag_id}/{dag_run_id}/{task_id}/{key} (the `GetXcomEntry` operationId).
GetXcomEntry(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, key string, reqEditors ...RequestEditorFn) (*http.Response, error)
// IssueTokenWithBody Issue a JWT for username/password credentials
//
// Takes any type of body and a specified content type.
//
// Corresponds with POST /auth/token (the `IssueToken` operationId).
IssueTokenWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// IssueToken Issue a JWT for username/password credentials
//
// Takes a body of the `application/json` content type.
//
// Corresponds with POST /auth/token (the `IssueToken` operationId).
IssueToken(ctx context.Context, body IssueTokenJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetHealthz Liveness probe
//
// Corresponds with GET /healthz (the `GetHealthz` operationId).
GetHealthz(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetReadyz Readiness probe
//
// Corresponds with GET /readyz (the `GetReadyz` operationId).
GetReadyz(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
}
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func New ¶
func New(baseURL, token string, opts ...ClientOption) (*ClientWithResponses, error)
New builds a typed /api/v2 client for the control plane at baseURL (an origin such as "http://localhost:8080", with or without a trailing slash). When token is non-empty every request carries "Authorization: Bearer <token>"; the MCP and CLI pass the caller's JWT through unchanged and never mint one (ADR 0050 D9). An empty token leaves requests unauthenticated, for dev/loopback use. Extra ClientOptions (e.g. WithHTTPClient) are applied after the auth editor.
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) ClearDagRunWithBodyWithResponse ¶ added in v0.5.4
func (c *ClientWithResponses) ClearDagRunWithBodyWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ClearDagRunResponse, error)
ClearDagRunWithBodyWithResponse Clear a whole DAG run (queue its task instances for re-run)
The run page's Clear action. A dry run (the default) answers the task instances the clear would reset. The clear itself resets them, re-queues the run and answers the run.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/clear (the `ClearDagRun` operationId).
func (*ClientWithResponses) ClearDagRunWithResponse ¶ added in v0.5.4
func (c *ClientWithResponses) ClearDagRunWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, body ClearDagRunJSONRequestBody, reqEditors ...RequestEditorFn) (*ClearDagRunResponse, error)
ClearDagRunWithResponse Clear a whole DAG run (queue its task instances for re-run)
The run page's Clear action. A dry run (the default) answers the task instances the clear would reset. The clear itself resets them, re-queues the run and answers the run.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/clear (the `ClearDagRun` operationId).
func (*ClientWithResponses) ClearTaskInstancesWithBodyWithResponse ¶
func (c *ClientWithResponses) ClearTaskInstancesWithBodyWithResponse(ctx context.Context, dagId DagID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ClearTaskInstancesResponse, error)
ClearTaskInstancesWithBodyWithResponse Clear task instances (queue them for re-run)
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v2/dags/{dag_id}/clearTaskInstances (the `ClearTaskInstances` operationId).
func (*ClientWithResponses) ClearTaskInstancesWithResponse ¶
func (c *ClientWithResponses) ClearTaskInstancesWithResponse(ctx context.Context, dagId DagID, body ClearTaskInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*ClearTaskInstancesResponse, error)
ClearTaskInstancesWithResponse Clear task instances (queue them for re-run)
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v2/dags/{dag_id}/clearTaskInstances (the `ClearTaskInstances` operationId).
func (*ClientWithResponses) CreateAPITokenWithBodyWithResponse ¶ added in v0.5.4
func (c *ClientWithResponses) CreateAPITokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAPITokenResponse, error)
CreateAPITokenWithBodyWithResponse Create an API token (Dexaflow)
Creates a long-lived, named API token owned by the caller (ADR 0074). The response carries the token once; the server keeps only its SHA-256 hash. The token authenticates as its owner, with the owner's current roles narrowed to the token's scopes: deploy carries dexaflow:deploy alone (it registers versions, sets the current version, and reads the DAG list, DAGs, their details and versions, and nothing else), read carries dexaflow:read. The caller's roles must allow what the scope does (deploy needs deploy or write on dags, read needs read on dags). An account holds at most 50 live tokens. Audited as api_token.create. Reusing the name of an expired token retires that token, audited as api_token.retire_expired. Not callable with an API token or any other scoped token.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v2/apiTokens (the `CreateAPIToken` operationId).
func (*ClientWithResponses) CreateAPITokenWithResponse ¶ added in v0.5.4
func (c *ClientWithResponses) CreateAPITokenWithResponse(ctx context.Context, body CreateAPITokenJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAPITokenResponse, error)
CreateAPITokenWithResponse Create an API token (Dexaflow)
Creates a long-lived, named API token owned by the caller (ADR 0074). The response carries the token once; the server keeps only its SHA-256 hash. The token authenticates as its owner, with the owner's current roles narrowed to the token's scopes: deploy carries dexaflow:deploy alone (it registers versions, sets the current version, and reads the DAG list, DAGs, their details and versions, and nothing else), read carries dexaflow:read. The caller's roles must allow what the scope does (deploy needs deploy or write on dags, read needs read on dags). An account holds at most 50 live tokens. Audited as api_token.create. Reusing the name of an expired token retires that token, audited as api_token.retire_expired. Not callable with an API token or any other scoped token.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v2/apiTokens (the `CreateAPIToken` operationId).
func (*ClientWithResponses) CreateConnectionWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateConnectionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateConnectionResponse, error)
CreateConnectionWithBodyWithResponse Create or replace a connection (upsert)
Upserts a connection: creates it, or replaces an existing one with the same connection_id. The password is write-only and never returned. Requires the write:connection permission and a configured encryption key.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v2/connections (the `CreateConnection` operationId).
func (*ClientWithResponses) CreateConnectionWithResponse ¶
func (c *ClientWithResponses) CreateConnectionWithResponse(ctx context.Context, body CreateConnectionJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateConnectionResponse, error)
CreateConnectionWithResponse Create or replace a connection (upsert)
Upserts a connection: creates it, or replaces an existing one with the same connection_id. The password is write-only and never returned. Requires the write:connection permission and a configured encryption key.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v2/connections (the `CreateConnection` operationId).
func (*ClientWithResponses) CreateUserWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateUserWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateUserResponse, error)
CreateUserWithBodyWithResponse Create a user
Admin-only. Creates a control-plane account with the given email and password and grants the requested roles. The password is write-only and is never returned. Requires the write:user permission.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v2/users (the `CreateUser` operationId).
func (*ClientWithResponses) CreateUserWithResponse ¶
func (c *ClientWithResponses) CreateUserWithResponse(ctx context.Context, body CreateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateUserResponse, error)
CreateUserWithResponse Create a user
Admin-only. Creates a control-plane account with the given email and password and grants the requested roles. The password is write-only and is never returned. Requires the write:user permission.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v2/users (the `CreateUser` operationId).
func (*ClientWithResponses) CreateVariableWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateVariableWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVariableResponse, error)
CreateVariableWithBodyWithResponse Create or replace a variable (upsert)
Upserts a variable: creates it, or replaces an existing one with the same key. Requires the write:variable permission.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v2/variables (the `CreateVariable` operationId).
func (*ClientWithResponses) CreateVariableWithResponse ¶
func (c *ClientWithResponses) CreateVariableWithResponse(ctx context.Context, body CreateVariableJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVariableResponse, error)
CreateVariableWithResponse Create or replace a variable (upsert)
Upserts a variable: creates it, or replaces an existing one with the same key. Requires the write:variable permission.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v2/variables (the `CreateVariable` operationId).
func (*ClientWithResponses) DeleteConnectionWithResponse ¶
func (c *ClientWithResponses) DeleteConnectionWithResponse(ctx context.Context, connectionId ConnectionID, reqEditors ...RequestEditorFn) (*DeleteConnectionResponse, error)
DeleteConnectionWithResponse Delete a connection
Returns a wrapper object for the known response body format(s).
Corresponds with DELETE /api/v2/connections/{connection_id} (the `DeleteConnection` operationId).
func (*ClientWithResponses) DeleteVariableWithResponse ¶
func (c *ClientWithResponses) DeleteVariableWithResponse(ctx context.Context, variableKey VariableKey, reqEditors ...RequestEditorFn) (*DeleteVariableResponse, error)
DeleteVariableWithResponse Delete a variable
Returns a wrapper object for the known response body format(s).
Corresponds with DELETE /api/v2/variables/{variable_key} (the `DeleteVariable` operationId).
func (*ClientWithResponses) GetConnectionWithResponse ¶
func (c *ClientWithResponses) GetConnectionWithResponse(ctx context.Context, connectionId ConnectionID, reqEditors ...RequestEditorFn) (*GetConnectionResponse, error)
GetConnectionWithResponse Get a connection
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/connections/{connection_id} (the `GetConnection` operationId).
func (*ClientWithResponses) GetDagRunWithResponse ¶
func (c *ClientWithResponses) GetDagRunWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, reqEditors ...RequestEditorFn) (*GetDagRunResponse, error)
GetDagRunWithResponse Get a DAG run
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id} (the `GetDagRun` operationId).
func (*ClientWithResponses) GetDagSourceWithResponse ¶
func (c *ClientWithResponses) GetDagSourceWithResponse(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*GetDagSourceResponse, error)
GetDagSourceWithResponse Get a DAG's source (the dag.py text)
The source registered with one version of the DAG, as in Airflow 3.2: version_number selects the version, and without it (or with 0) the newest version is served. After a rollback the newest version is not the current one. A version the DAG does not have is a 404, and a version_number that is not an integer is a 400.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/dagSources/{dag_id} (the `GetDagSource` operationId).
func (*ClientWithResponses) GetDagSpecWithResponse ¶
func (c *ClientWithResponses) GetDagSpecWithResponse(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*GetDagSpecResponse, error)
GetDagSpecWithResponse Get a DAG's compiled spec (the dag.json artifact)
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/dags/{dag_id}/spec (the `GetDagSpec` operationId).
func (*ClientWithResponses) GetDagVersionWithResponse ¶
func (c *ClientWithResponses) GetDagVersionWithResponse(ctx context.Context, dagId DagID, versionNumber int, reqEditors ...RequestEditorFn) (*GetDagVersionResponse, error)
GetDagVersionWithResponse Get a specific registered DAG version
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/dags/{dag_id}/dagVersions/{version_number} (the `GetDagVersion` operationId).
func (*ClientWithResponses) GetDagWithResponse ¶
func (c *ClientWithResponses) GetDagWithResponse(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*GetDagResponse, error)
GetDagWithResponse Get a DAG
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/dags/{dag_id} (the `GetDag` operationId).
func (*ClientWithResponses) GetHealthzWithResponse ¶
func (c *ClientWithResponses) GetHealthzWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetHealthzResponse, error)
GetHealthzWithResponse Liveness probe
Returns a wrapper object for the known response body format(s).
Corresponds with GET /healthz (the `GetHealthz` operationId).
func (*ClientWithResponses) GetMonitorExecutorWithResponse ¶
func (c *ClientWithResponses) GetMonitorExecutorWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetMonitorExecutorResponse, error)
GetMonitorExecutorWithResponse Executor capability and configuration
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/monitor/executor (the `GetMonitorExecutor` operationId).
func (*ClientWithResponses) GetMonitorHealthWithResponse ¶
func (c *ClientWithResponses) GetMonitorHealthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetMonitorHealthResponse, error)
GetMonitorHealthWithResponse Control-plane health (Airflow HealthInfoResponse shape)
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/monitor/health (the `GetMonitorHealth` operationId).
func (*ClientWithResponses) GetReadyzWithResponse ¶
func (c *ClientWithResponses) GetReadyzWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetReadyzResponse, error)
GetReadyzWithResponse Readiness probe
Returns a wrapper object for the known response body format(s).
Corresponds with GET /readyz (the `GetReadyz` operationId).
func (*ClientWithResponses) GetTaskInstanceWithResponse ¶
func (c *ClientWithResponses) GetTaskInstanceWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, reqEditors ...RequestEditorFn) (*GetTaskInstanceResponse, error)
GetTaskInstanceWithResponse Get a task instance
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} (the `GetTaskInstance` operationId).
func (*ClientWithResponses) GetTaskLogsWithResponse ¶
func (c *ClientWithResponses) GetTaskLogsWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, tryNumber int, reqEditors ...RequestEditorFn) (*GetTaskLogsResponse, error)
GetTaskLogsWithResponse Get task logs
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{try_number} (the `GetTaskLogs` operationId).
func (*ClientWithResponses) GetVariableWithResponse ¶
func (c *ClientWithResponses) GetVariableWithResponse(ctx context.Context, variableKey VariableKey, reqEditors ...RequestEditorFn) (*GetVariableResponse, error)
GetVariableWithResponse Get a variable
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/variables/{variable_key} (the `GetVariable` operationId).
func (*ClientWithResponses) GetVersionWithResponse ¶
func (c *ClientWithResponses) GetVersionWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetVersionResponse, error)
GetVersionWithResponse Control-plane version (Airflow VersionInfo shape)
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/version (the `GetVersion` operationId).
func (*ClientWithResponses) GetXcomEntryWithResponse ¶
func (c *ClientWithResponses) GetXcomEntryWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, key string, reqEditors ...RequestEditorFn) (*GetXcomEntryResponse, error)
GetXcomEntryWithResponse Read XCom value (read-only proxy for the Redis backend)
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/xcoms/{dag_id}/{dag_run_id}/{task_id}/{key} (the `GetXcomEntry` operationId).
func (*ClientWithResponses) IssueTokenWithBodyWithResponse ¶
func (c *ClientWithResponses) IssueTokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*IssueTokenResponse, error)
IssueTokenWithBodyWithResponse Issue a JWT for username/password credentials
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /auth/token (the `IssueToken` operationId).
func (*ClientWithResponses) IssueTokenWithResponse ¶
func (c *ClientWithResponses) IssueTokenWithResponse(ctx context.Context, body IssueTokenJSONRequestBody, reqEditors ...RequestEditorFn) (*IssueTokenResponse, error)
IssueTokenWithResponse Issue a JWT for username/password credentials
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /auth/token (the `IssueToken` operationId).
func (*ClientWithResponses) ListAPITokensWithResponse ¶ added in v0.5.4
func (c *ClientWithResponses) ListAPITokensWithResponse(ctx context.Context, params *ListAPITokensParams, reqEditors ...RequestEditorFn) (*ListAPITokensResponse, error)
ListAPITokensWithResponse List API tokens (Dexaflow)
Lists the caller's unrevoked API tokens, newest first, expired ones included. A caller who may manage accounts (write:user) sees every token of the tenant. The token itself and its hash are never returned. Not callable with an API token or any other scoped token (ADR 0074).
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/apiTokens (the `ListAPITokens` operationId).
func (*ClientWithResponses) ListConnectionsWithResponse ¶
func (c *ClientWithResponses) ListConnectionsWithResponse(ctx context.Context, params *ListConnectionsParams, reqEditors ...RequestEditorFn) (*ListConnectionsResponse, error)
ListConnectionsWithResponse List connections
Lists the tenant's Airflow-style connections. Passwords are write-only and never returned; secret-bearing keys inside `extra` are masked server-side. Requires the read:connection permission.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/connections (the `ListConnections` operationId).
func (*ClientWithResponses) ListDagRunsWithResponse ¶
func (c *ClientWithResponses) ListDagRunsWithResponse(ctx context.Context, dagId DagID, params *ListDagRunsParams, reqEditors ...RequestEditorFn) (*ListDagRunsResponse, error)
ListDagRunsWithResponse List DAG runs
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/dags/{dag_id}/dagRuns (the `ListDagRuns` operationId).
func (*ClientWithResponses) ListDagVersionsWithResponse ¶
func (c *ClientWithResponses) ListDagVersionsWithResponse(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*ListDagVersionsResponse, error)
ListDagVersionsWithResponse List a DAG's registered versions
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/dags/{dag_id}/dagVersions (the `ListDagVersions` operationId).
func (*ClientWithResponses) ListDagsWithResponse ¶
func (c *ClientWithResponses) ListDagsWithResponse(ctx context.Context, params *ListDagsParams, reqEditors ...RequestEditorFn) (*ListDagsResponse, error)
ListDagsWithResponse List DAGs
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/dags (the `ListDags` operationId).
func (*ClientWithResponses) ListTaskInstancesWithResponse ¶
func (c *ClientWithResponses) ListTaskInstancesWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, reqEditors ...RequestEditorFn) (*ListTaskInstancesResponse, error)
ListTaskInstancesWithResponse List task instances of a DAG run
Pages with the same limit, offset and cursor query parameters as the DAG run list (they are not declared on this operation so the generated client keeps its signature). A request that carries cursor gets next_cursor and previous_cursor in the body; only the offset cursors this list issues are accepted, any other is refused with 400.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances (the `ListTaskInstances` operationId).
func (*ClientWithResponses) ListUsersWithResponse ¶
func (c *ClientWithResponses) ListUsersWithResponse(ctx context.Context, params *ListUsersParams, reqEditors ...RequestEditorFn) (*ListUsersResponse, error)
ListUsersWithResponse List users
Lists the tenant's control-plane accounts, newest first. Each entry carries the full set of roles the user holds; the password and its hash are write-only and never returned. Requires the read:user permission.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/users (the `ListUsers` operationId).
func (*ClientWithResponses) ListVariablesWithResponse ¶
func (c *ClientWithResponses) ListVariablesWithResponse(ctx context.Context, params *ListVariablesParams, reqEditors ...RequestEditorFn) (*ListVariablesResponse, error)
ListVariablesWithResponse List variables
Lists the tenant's Airflow-style variables. Values of secret-ish keys are masked server-side. Requires the read:variable permission.
Returns a wrapper object for the known response body format(s).
Corresponds with GET /api/v2/variables (the `ListVariables` operationId).
func (*ClientWithResponses) PatchTaskInstanceDryRunWithBodyWithResponse ¶ added in v0.5.4
func (c *ClientWithResponses) PatchTaskInstanceDryRunWithBodyWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchTaskInstanceDryRunResponse, error)
PatchTaskInstanceDryRunWithBodyWithResponse Preview marking a task instance
Answers the task instance with the state the PATCH would set, without changing anything.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/dry_run (the `PatchTaskInstanceDryRun` operationId).
func (*ClientWithResponses) PatchTaskInstanceDryRunWithResponse ¶ added in v0.5.4
func (c *ClientWithResponses) PatchTaskInstanceDryRunWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, body PatchTaskInstanceDryRunJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchTaskInstanceDryRunResponse, error)
PatchTaskInstanceDryRunWithResponse Preview marking a task instance
Answers the task instance with the state the PATCH would set, without changing anything.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/dry_run (the `PatchTaskInstanceDryRun` operationId).
func (*ClientWithResponses) PatchTaskInstanceWithBodyWithResponse ¶ added in v0.5.4
func (c *ClientWithResponses) PatchTaskInstanceWithBodyWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchTaskInstanceResponse, error)
PatchTaskInstanceWithBodyWithResponse Mark a task instance as success, failed or skipped
Sets the task instance's state, as the UI's Mark as action does. The answer is the affected set, a collection holding the updated task instance, as Apache Airflow declares it.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} (the `PatchTaskInstance` operationId).
func (*ClientWithResponses) PatchTaskInstanceWithResponse ¶ added in v0.5.4
func (c *ClientWithResponses) PatchTaskInstanceWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, body PatchTaskInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchTaskInstanceResponse, error)
PatchTaskInstanceWithResponse Mark a task instance as success, failed or skipped
Sets the task instance's state, as the UI's Mark as action does. The answer is the affected set, a collection holding the updated task instance, as Apache Airflow declares it.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} (the `PatchTaskInstance` operationId).
func (*ClientWithResponses) RegisterDagVersionWithBodyWithResponse ¶ added in v0.5.4
func (c *ClientWithResponses) RegisterDagVersionWithBodyWithResponse(ctx context.Context, dagId DagID, params *RegisterDagVersionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterDagVersionResponse, error)
RegisterDagVersionWithBodyWithResponse Register a compiled DAG version (Dexaflow)
Registers a compiled dag.json as a new version of the DAG and makes it current. Re-registering content that is already registered (same spec hash) is a no-op answered with 200 and created false, and leaves the current version as it is. The same label with other content is refused with 409. Needs deploy or write on dags (scope dexaflow:deploy). Without is_paused, a DAG the register creates starts paused per its is_paused_upon_creation, else the server's dags_are_paused_at_creation, and an existing DAG keeps its state. With is_paused, the DAG ends the register in that state whether it is created, gets a new version or already had this content; a change to an existing DAG is audited as dag.pause or dag.unpause in the same transaction. Pausing is a run-state write: sending is_paused also needs write on dags, and a scoped token needs dexaflow:run as well as dexaflow:deploy, else the register is refused with 403. Under the server setting deploy.require_digest, an image that is not pinned by a full digest (repository@sha256: and 64 hex characters) is registered with a warning in warnings (warn), or refused with 400 (enforce). Off, the default, accepts any image. POST /api/v2/dags/{dag_id}/versions/dry_run runs the same checks and writes nothing.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v2/dags/{dag_id}/versions (the `RegisterDagVersion` operationId).
func (*ClientWithResponses) RegisterDagVersionWithResponse ¶ added in v0.5.4
func (c *ClientWithResponses) RegisterDagVersionWithResponse(ctx context.Context, dagId DagID, params *RegisterDagVersionParams, body RegisterDagVersionJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterDagVersionResponse, error)
RegisterDagVersionWithResponse Register a compiled DAG version (Dexaflow)
Registers a compiled dag.json as a new version of the DAG and makes it current. Re-registering content that is already registered (same spec hash) is a no-op answered with 200 and created false, and leaves the current version as it is. The same label with other content is refused with 409. Needs deploy or write on dags (scope dexaflow:deploy). Without is_paused, a DAG the register creates starts paused per its is_paused_upon_creation, else the server's dags_are_paused_at_creation, and an existing DAG keeps its state. With is_paused, the DAG ends the register in that state whether it is created, gets a new version or already had this content; a change to an existing DAG is audited as dag.pause or dag.unpause in the same transaction. Pausing is a run-state write: sending is_paused also needs write on dags, and a scoped token needs dexaflow:run as well as dexaflow:deploy, else the register is refused with 403. Under the server setting deploy.require_digest, an image that is not pinned by a full digest (repository@sha256: and 64 hex characters) is registered with a warning in warnings (warn), or refused with 400 (enforce). Off, the default, accepts any image. POST /api/v2/dags/{dag_id}/versions/dry_run runs the same checks and writes nothing.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v2/dags/{dag_id}/versions (the `RegisterDagVersion` operationId).
func (*ClientWithResponses) RenewTokenWithResponse ¶
func (c *ClientWithResponses) RenewTokenWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RenewTokenResponse, error)
RenewTokenWithResponse Renew a still-valid JWT into a fresh short-lived token
Transparent renewal: given a still-valid user bearer, re-mints the same identity with a fresh short TTL, bounded by a server-side max_lifetime measured from first login. Lets a long CLI/dev session avoid re-logging in every token TTL while keeping the access token short-lived. Returns 401 when the presented token is invalid, expired, or past max_lifetime, in which case the client must log in again.
Returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v2/auth/token/renew (the `RenewToken` operationId).
func (*ClientWithResponses) RevokeAPITokenWithResponse ¶ added in v0.5.4
func (c *ClientWithResponses) RevokeAPITokenWithResponse(ctx context.Context, tokenId string, reqEditors ...RequestEditorFn) (*RevokeAPITokenResponse, error)
RevokeAPITokenWithResponse Revoke an API token (Dexaflow)
Revokes one of the caller's API tokens, or any token of the tenant for a caller who may manage accounts (write:user). The token stops working on its next request. Revoking a revoked token succeeds. Audited as api_token.revoke. Not callable with an API token or any other scoped token.
Returns a wrapper object for the known response body format(s).
Corresponds with DELETE /api/v2/apiTokens/{token_id} (the `RevokeAPIToken` operationId).
func (*ClientWithResponses) SetDagCurrentVersionWithBodyWithResponse ¶ added in v0.5.4
func (c *ClientWithResponses) SetDagCurrentVersionWithBodyWithResponse(ctx context.Context, dagId DagID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetDagCurrentVersionResponse, error)
SetDagCurrentVersionWithBodyWithResponse Make a registered version current (Dexaflow)
Makes a registered version of the DAG the one new runs are created with, by label or by version_number: a rollback, or a roll forward. The DAG's schedule and metadata become that version's, in the same transaction. Runs that already exist keep their version, and is_paused is never changed. The version must pass the checks a register of it would pass today. Naming the current version changes nothing (changed false). Audited as dag.version.set_current. Needs deploy or write on dags (scope dexaflow:deploy). Under the server setting deploy.require_digest, a version whose image is not pinned by a full sha256 digest is made current with a warning in warnings (warn), or refused with 400 (enforce).
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with PUT /api/v2/dags/{dag_id}/currentVersion (the `SetDagCurrentVersion` operationId).
func (*ClientWithResponses) SetDagCurrentVersionWithResponse ¶ added in v0.5.4
func (c *ClientWithResponses) SetDagCurrentVersionWithResponse(ctx context.Context, dagId DagID, body SetDagCurrentVersionJSONRequestBody, reqEditors ...RequestEditorFn) (*SetDagCurrentVersionResponse, error)
SetDagCurrentVersionWithResponse Make a registered version current (Dexaflow)
Makes a registered version of the DAG the one new runs are created with, by label or by version_number: a rollback, or a roll forward. The DAG's schedule and metadata become that version's, in the same transaction. Runs that already exist keep their version, and is_paused is never changed. The version must pass the checks a register of it would pass today. Naming the current version changes nothing (changed false). Audited as dag.version.set_current. Needs deploy or write on dags (scope dexaflow:deploy). Under the server setting deploy.require_digest, a version whose image is not pinned by a full sha256 digest is made current with a warning in warnings (warn), or refused with 400 (enforce).
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with PUT /api/v2/dags/{dag_id}/currentVersion (the `SetDagCurrentVersion` operationId).
func (*ClientWithResponses) TriggerDagRunWithBodyWithResponse ¶
func (c *ClientWithResponses) TriggerDagRunWithBodyWithResponse(ctx context.Context, dagId DagID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*TriggerDagRunResponse, error)
TriggerDagRunWithBodyWithResponse Trigger a DAG run
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v2/dags/{dag_id}/dagRuns (the `TriggerDagRun` operationId).
func (*ClientWithResponses) TriggerDagRunWithResponse ¶
func (c *ClientWithResponses) TriggerDagRunWithResponse(ctx context.Context, dagId DagID, body TriggerDagRunJSONRequestBody, reqEditors ...RequestEditorFn) (*TriggerDagRunResponse, error)
TriggerDagRunWithResponse Trigger a DAG run
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with POST /api/v2/dags/{dag_id}/dagRuns (the `TriggerDagRun` operationId).
func (*ClientWithResponses) UpdateConnectionWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateConnectionWithBodyWithResponse(ctx context.Context, connectionId ConnectionID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateConnectionResponse, error)
UpdateConnectionWithBodyWithResponse Update a connection
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with PATCH /api/v2/connections/{connection_id} (the `UpdateConnection` operationId).
func (*ClientWithResponses) UpdateConnectionWithResponse ¶
func (c *ClientWithResponses) UpdateConnectionWithResponse(ctx context.Context, connectionId ConnectionID, body UpdateConnectionJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateConnectionResponse, error)
UpdateConnectionWithResponse Update a connection
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with PATCH /api/v2/connections/{connection_id} (the `UpdateConnection` operationId).
func (*ClientWithResponses) UpdateDagWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateDagWithBodyWithResponse(ctx context.Context, dagId DagID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDagResponse, error)
UpdateDagWithBodyWithResponse Update DAG (typically pause/unpause)
Sets is_paused. A change is audited as dag.pause or dag.unpause with the acting user; asking for the state the DAG is already in records nothing.
Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
Corresponds with PATCH /api/v2/dags/{dag_id} (the `UpdateDag` operationId).
func (*ClientWithResponses) UpdateDagWithResponse ¶
func (c *ClientWithResponses) UpdateDagWithResponse(ctx context.Context, dagId DagID, body UpdateDagJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDagResponse, error)
UpdateDagWithResponse Update DAG (typically pause/unpause)
Sets is_paused. A change is audited as dag.pause or dag.unpause with the acting user; asking for the state the DAG is already in records nothing.
Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
Corresponds with PATCH /api/v2/dags/{dag_id} (the `UpdateDag` operationId).
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// ListAPITokensWithResponse List API tokens (Dexaflow)
//
// Lists the caller's unrevoked API tokens, newest first, expired ones included. A caller who may manage accounts (write:user) sees every token of the tenant. The token itself and its hash are never returned. Not callable with an API token or any other scoped token (ADR 0074).
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/apiTokens (the `ListAPITokens` operationId).
ListAPITokensWithResponse(ctx context.Context, params *ListAPITokensParams, reqEditors ...RequestEditorFn) (*ListAPITokensResponse, error)
// CreateAPITokenWithBodyWithResponse Create an API token (Dexaflow)
//
// Creates a long-lived, named API token owned by the caller (ADR 0074). The response carries the token once; the server keeps only its SHA-256 hash. The token authenticates as its owner, with the owner's current roles narrowed to the token's scopes: deploy carries dexaflow:deploy alone (it registers versions, sets the current version, and reads the DAG list, DAGs, their details and versions, and nothing else), read carries dexaflow:read. The caller's roles must allow what the scope does (deploy needs deploy or write on dags, read needs read on dags). An account holds at most 50 live tokens. Audited as api_token.create. Reusing the name of an expired token retires that token, audited as api_token.retire_expired. Not callable with an API token or any other scoped token.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v2/apiTokens (the `CreateAPIToken` operationId).
CreateAPITokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateAPITokenResponse, error)
// CreateAPITokenWithResponse Create an API token (Dexaflow)
//
// Creates a long-lived, named API token owned by the caller (ADR 0074). The response carries the token once; the server keeps only its SHA-256 hash. The token authenticates as its owner, with the owner's current roles narrowed to the token's scopes: deploy carries dexaflow:deploy alone (it registers versions, sets the current version, and reads the DAG list, DAGs, their details and versions, and nothing else), read carries dexaflow:read. The caller's roles must allow what the scope does (deploy needs deploy or write on dags, read needs read on dags). An account holds at most 50 live tokens. Audited as api_token.create. Reusing the name of an expired token retires that token, audited as api_token.retire_expired. Not callable with an API token or any other scoped token.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v2/apiTokens (the `CreateAPIToken` operationId).
CreateAPITokenWithResponse(ctx context.Context, body CreateAPITokenJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateAPITokenResponse, error)
// RevokeAPITokenWithResponse Revoke an API token (Dexaflow)
//
// Revokes one of the caller's API tokens, or any token of the tenant for a caller who may manage accounts (write:user). The token stops working on its next request. Revoking a revoked token succeeds. Audited as api_token.revoke. Not callable with an API token or any other scoped token.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with DELETE /api/v2/apiTokens/{token_id} (the `RevokeAPIToken` operationId).
RevokeAPITokenWithResponse(ctx context.Context, tokenId string, reqEditors ...RequestEditorFn) (*RevokeAPITokenResponse, error)
// RenewTokenWithResponse Renew a still-valid JWT into a fresh short-lived token
//
// Transparent renewal: given a still-valid user bearer, re-mints the same identity with a fresh short TTL, bounded by a server-side max_lifetime measured from first login. Lets a long CLI/dev session avoid re-logging in every token TTL while keeping the access token short-lived. Returns 401 when the presented token is invalid, expired, or past max_lifetime, in which case the client must log in again.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v2/auth/token/renew (the `RenewToken` operationId).
RenewTokenWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*RenewTokenResponse, error)
// ListConnectionsWithResponse List connections
//
// Lists the tenant's Airflow-style connections. Passwords are write-only and
// never returned; secret-bearing keys inside `extra` are masked server-side.
// Requires the read:connection permission.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/connections (the `ListConnections` operationId).
ListConnectionsWithResponse(ctx context.Context, params *ListConnectionsParams, reqEditors ...RequestEditorFn) (*ListConnectionsResponse, error)
// CreateConnectionWithBodyWithResponse Create or replace a connection (upsert)
//
// Upserts a connection: creates it, or replaces an existing one with the same
// connection_id. The password is write-only and never returned. Requires the
// write:connection permission and a configured encryption key.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v2/connections (the `CreateConnection` operationId).
CreateConnectionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateConnectionResponse, error)
// CreateConnectionWithResponse Create or replace a connection (upsert)
//
// Upserts a connection: creates it, or replaces an existing one with the same
// connection_id. The password is write-only and never returned. Requires the
// write:connection permission and a configured encryption key.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v2/connections (the `CreateConnection` operationId).
CreateConnectionWithResponse(ctx context.Context, body CreateConnectionJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateConnectionResponse, error)
// DeleteConnectionWithResponse Delete a connection
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with DELETE /api/v2/connections/{connection_id} (the `DeleteConnection` operationId).
DeleteConnectionWithResponse(ctx context.Context, connectionId ConnectionID, reqEditors ...RequestEditorFn) (*DeleteConnectionResponse, error)
// GetConnectionWithResponse Get a connection
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/connections/{connection_id} (the `GetConnection` operationId).
GetConnectionWithResponse(ctx context.Context, connectionId ConnectionID, reqEditors ...RequestEditorFn) (*GetConnectionResponse, error)
// UpdateConnectionWithBodyWithResponse Update a connection
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PATCH /api/v2/connections/{connection_id} (the `UpdateConnection` operationId).
UpdateConnectionWithBodyWithResponse(ctx context.Context, connectionId ConnectionID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateConnectionResponse, error)
// UpdateConnectionWithResponse Update a connection
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PATCH /api/v2/connections/{connection_id} (the `UpdateConnection` operationId).
UpdateConnectionWithResponse(ctx context.Context, connectionId ConnectionID, body UpdateConnectionJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateConnectionResponse, error)
// GetDagSourceWithResponse Get a DAG's source (the dag.py text)
//
// The source registered with one version of the DAG, as in Airflow 3.2: version_number selects the version, and without it (or with 0) the newest version is served. After a rollback the newest version is not the current one. A version the DAG does not have is a 404, and a version_number that is not an integer is a 400.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/dagSources/{dag_id} (the `GetDagSource` operationId).
GetDagSourceWithResponse(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*GetDagSourceResponse, error)
// ListDagsWithResponse List DAGs
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/dags (the `ListDags` operationId).
ListDagsWithResponse(ctx context.Context, params *ListDagsParams, reqEditors ...RequestEditorFn) (*ListDagsResponse, error)
// GetDagWithResponse Get a DAG
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/dags/{dag_id} (the `GetDag` operationId).
GetDagWithResponse(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*GetDagResponse, error)
// UpdateDagWithBodyWithResponse Update DAG (typically pause/unpause)
//
// Sets is_paused. A change is audited as dag.pause or dag.unpause with the acting user; asking for the state the DAG is already in records nothing.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PATCH /api/v2/dags/{dag_id} (the `UpdateDag` operationId).
UpdateDagWithBodyWithResponse(ctx context.Context, dagId DagID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDagResponse, error)
// UpdateDagWithResponse Update DAG (typically pause/unpause)
//
// Sets is_paused. A change is audited as dag.pause or dag.unpause with the acting user; asking for the state the DAG is already in records nothing.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PATCH /api/v2/dags/{dag_id} (the `UpdateDag` operationId).
UpdateDagWithResponse(ctx context.Context, dagId DagID, body UpdateDagJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateDagResponse, error)
// ClearTaskInstancesWithBodyWithResponse Clear task instances (queue them for re-run)
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v2/dags/{dag_id}/clearTaskInstances (the `ClearTaskInstances` operationId).
ClearTaskInstancesWithBodyWithResponse(ctx context.Context, dagId DagID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ClearTaskInstancesResponse, error)
// ClearTaskInstancesWithResponse Clear task instances (queue them for re-run)
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v2/dags/{dag_id}/clearTaskInstances (the `ClearTaskInstances` operationId).
ClearTaskInstancesWithResponse(ctx context.Context, dagId DagID, body ClearTaskInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*ClearTaskInstancesResponse, error)
// SetDagCurrentVersionWithBodyWithResponse Make a registered version current (Dexaflow)
//
// Makes a registered version of the DAG the one new runs are created with, by label or by version_number: a rollback, or a roll forward. The DAG's schedule and metadata become that version's, in the same transaction. Runs that already exist keep their version, and is_paused is never changed. The version must pass the checks a register of it would pass today. Naming the current version changes nothing (changed false). Audited as dag.version.set_current. Needs deploy or write on dags (scope dexaflow:deploy). Under the server setting deploy.require_digest, a version whose image is not pinned by a full sha256 digest is made current with a warning in warnings (warn), or refused with 400 (enforce).
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PUT /api/v2/dags/{dag_id}/currentVersion (the `SetDagCurrentVersion` operationId).
SetDagCurrentVersionWithBodyWithResponse(ctx context.Context, dagId DagID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetDagCurrentVersionResponse, error)
// SetDagCurrentVersionWithResponse Make a registered version current (Dexaflow)
//
// Makes a registered version of the DAG the one new runs are created with, by label or by version_number: a rollback, or a roll forward. The DAG's schedule and metadata become that version's, in the same transaction. Runs that already exist keep their version, and is_paused is never changed. The version must pass the checks a register of it would pass today. Naming the current version changes nothing (changed false). Audited as dag.version.set_current. Needs deploy or write on dags (scope dexaflow:deploy). Under the server setting deploy.require_digest, a version whose image is not pinned by a full sha256 digest is made current with a warning in warnings (warn), or refused with 400 (enforce).
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PUT /api/v2/dags/{dag_id}/currentVersion (the `SetDagCurrentVersion` operationId).
SetDagCurrentVersionWithResponse(ctx context.Context, dagId DagID, body SetDagCurrentVersionJSONRequestBody, reqEditors ...RequestEditorFn) (*SetDagCurrentVersionResponse, error)
// ListDagRunsWithResponse List DAG runs
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/dags/{dag_id}/dagRuns (the `ListDagRuns` operationId).
ListDagRunsWithResponse(ctx context.Context, dagId DagID, params *ListDagRunsParams, reqEditors ...RequestEditorFn) (*ListDagRunsResponse, error)
// TriggerDagRunWithBodyWithResponse Trigger a DAG run
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v2/dags/{dag_id}/dagRuns (the `TriggerDagRun` operationId).
TriggerDagRunWithBodyWithResponse(ctx context.Context, dagId DagID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*TriggerDagRunResponse, error)
// TriggerDagRunWithResponse Trigger a DAG run
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v2/dags/{dag_id}/dagRuns (the `TriggerDagRun` operationId).
TriggerDagRunWithResponse(ctx context.Context, dagId DagID, body TriggerDagRunJSONRequestBody, reqEditors ...RequestEditorFn) (*TriggerDagRunResponse, error)
// GetDagRunWithResponse Get a DAG run
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id} (the `GetDagRun` operationId).
GetDagRunWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, reqEditors ...RequestEditorFn) (*GetDagRunResponse, error)
// ClearDagRunWithBodyWithResponse Clear a whole DAG run (queue its task instances for re-run)
//
// The run page's Clear action. A dry run (the default) answers the task instances the clear would reset. The clear itself resets them, re-queues the run and answers the run.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/clear (the `ClearDagRun` operationId).
ClearDagRunWithBodyWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ClearDagRunResponse, error)
// ClearDagRunWithResponse Clear a whole DAG run (queue its task instances for re-run)
//
// The run page's Clear action. A dry run (the default) answers the task instances the clear would reset. The clear itself resets them, re-queues the run and answers the run.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/clear (the `ClearDagRun` operationId).
ClearDagRunWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, body ClearDagRunJSONRequestBody, reqEditors ...RequestEditorFn) (*ClearDagRunResponse, error)
// ListTaskInstancesWithResponse List task instances of a DAG run
//
// Pages with the same limit, offset and cursor query parameters as the DAG run list (they are not declared on this operation so the generated client keeps its signature). A request that carries cursor gets next_cursor and previous_cursor in the body; only the offset cursors this list issues are accepted, any other is refused with 400.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances (the `ListTaskInstances` operationId).
ListTaskInstancesWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, reqEditors ...RequestEditorFn) (*ListTaskInstancesResponse, error)
// GetTaskInstanceWithResponse Get a task instance
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} (the `GetTaskInstance` operationId).
GetTaskInstanceWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, reqEditors ...RequestEditorFn) (*GetTaskInstanceResponse, error)
// PatchTaskInstanceWithBodyWithResponse Mark a task instance as success, failed or skipped
//
// Sets the task instance's state, as the UI's Mark as action does. The answer is the affected set, a collection holding the updated task instance, as Apache Airflow declares it.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} (the `PatchTaskInstance` operationId).
PatchTaskInstanceWithBodyWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchTaskInstanceResponse, error)
// PatchTaskInstanceWithResponse Mark a task instance as success, failed or skipped
//
// Sets the task instance's state, as the UI's Mark as action does. The answer is the affected set, a collection holding the updated task instance, as Apache Airflow declares it.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} (the `PatchTaskInstance` operationId).
PatchTaskInstanceWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, body PatchTaskInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchTaskInstanceResponse, error)
// PatchTaskInstanceDryRunWithBodyWithResponse Preview marking a task instance
//
// Answers the task instance with the state the PATCH would set, without changing anything.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/dry_run (the `PatchTaskInstanceDryRun` operationId).
PatchTaskInstanceDryRunWithBodyWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchTaskInstanceDryRunResponse, error)
// PatchTaskInstanceDryRunWithResponse Preview marking a task instance
//
// Answers the task instance with the state the PATCH would set, without changing anything.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/dry_run (the `PatchTaskInstanceDryRun` operationId).
PatchTaskInstanceDryRunWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, body PatchTaskInstanceDryRunJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchTaskInstanceDryRunResponse, error)
// GetTaskLogsWithResponse Get task logs
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{try_number} (the `GetTaskLogs` operationId).
GetTaskLogsWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, tryNumber int, reqEditors ...RequestEditorFn) (*GetTaskLogsResponse, error)
// ListDagVersionsWithResponse List a DAG's registered versions
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/dags/{dag_id}/dagVersions (the `ListDagVersions` operationId).
ListDagVersionsWithResponse(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*ListDagVersionsResponse, error)
// GetDagVersionWithResponse Get a specific registered DAG version
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/dags/{dag_id}/dagVersions/{version_number} (the `GetDagVersion` operationId).
GetDagVersionWithResponse(ctx context.Context, dagId DagID, versionNumber int, reqEditors ...RequestEditorFn) (*GetDagVersionResponse, error)
// GetDagSpecWithResponse Get a DAG's compiled spec (the dag.json artifact)
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/dags/{dag_id}/spec (the `GetDagSpec` operationId).
GetDagSpecWithResponse(ctx context.Context, dagId DagID, reqEditors ...RequestEditorFn) (*GetDagSpecResponse, error)
// RegisterDagVersionWithBodyWithResponse Register a compiled DAG version (Dexaflow)
//
// Registers a compiled dag.json as a new version of the DAG and makes it current. Re-registering content that is already registered (same spec hash) is a no-op answered with 200 and created false, and leaves the current version as it is. The same label with other content is refused with 409. Needs deploy or write on dags (scope dexaflow:deploy).
// Without is_paused, a DAG the register creates starts paused per its is_paused_upon_creation, else the server's dags_are_paused_at_creation, and an existing DAG keeps its state. With is_paused, the DAG ends the register in that state whether it is created, gets a new version or already had this content; a change to an existing DAG is audited as dag.pause or dag.unpause in the same transaction. Pausing is a run-state write: sending is_paused also needs write on dags, and a scoped token needs dexaflow:run as well as dexaflow:deploy, else the register is refused with 403.
// Under the server setting deploy.require_digest, an image that is not pinned by a full digest (repository@sha256: and 64 hex characters) is registered with a warning in warnings (warn), or refused with 400 (enforce). Off, the default, accepts any image.
// POST /api/v2/dags/{dag_id}/versions/dry_run runs the same checks and writes nothing.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v2/dags/{dag_id}/versions (the `RegisterDagVersion` operationId).
RegisterDagVersionWithBodyWithResponse(ctx context.Context, dagId DagID, params *RegisterDagVersionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterDagVersionResponse, error)
// RegisterDagVersionWithResponse Register a compiled DAG version (Dexaflow)
//
// Registers a compiled dag.json as a new version of the DAG and makes it current. Re-registering content that is already registered (same spec hash) is a no-op answered with 200 and created false, and leaves the current version as it is. The same label with other content is refused with 409. Needs deploy or write on dags (scope dexaflow:deploy).
// Without is_paused, a DAG the register creates starts paused per its is_paused_upon_creation, else the server's dags_are_paused_at_creation, and an existing DAG keeps its state. With is_paused, the DAG ends the register in that state whether it is created, gets a new version or already had this content; a change to an existing DAG is audited as dag.pause or dag.unpause in the same transaction. Pausing is a run-state write: sending is_paused also needs write on dags, and a scoped token needs dexaflow:run as well as dexaflow:deploy, else the register is refused with 403.
// Under the server setting deploy.require_digest, an image that is not pinned by a full digest (repository@sha256: and 64 hex characters) is registered with a warning in warnings (warn), or refused with 400 (enforce). Off, the default, accepts any image.
// POST /api/v2/dags/{dag_id}/versions/dry_run runs the same checks and writes nothing.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v2/dags/{dag_id}/versions (the `RegisterDagVersion` operationId).
RegisterDagVersionWithResponse(ctx context.Context, dagId DagID, params *RegisterDagVersionParams, body RegisterDagVersionJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterDagVersionResponse, error)
// GetMonitorExecutorWithResponse Executor capability and configuration
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/monitor/executor (the `GetMonitorExecutor` operationId).
GetMonitorExecutorWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetMonitorExecutorResponse, error)
// GetMonitorHealthWithResponse Control-plane health (Airflow HealthInfoResponse shape)
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/monitor/health (the `GetMonitorHealth` operationId).
GetMonitorHealthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetMonitorHealthResponse, error)
// ListUsersWithResponse List users
//
// Lists the tenant's control-plane accounts, newest first. Each entry
// carries the full set of roles the user holds; the password and its hash
// are write-only and never returned. Requires the read:user permission.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/users (the `ListUsers` operationId).
ListUsersWithResponse(ctx context.Context, params *ListUsersParams, reqEditors ...RequestEditorFn) (*ListUsersResponse, error)
// CreateUserWithBodyWithResponse Create a user
//
// Admin-only. Creates a control-plane account with the given email and
// password and grants the requested roles. The password is write-only and
// is never returned. Requires the write:user permission.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v2/users (the `CreateUser` operationId).
CreateUserWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateUserResponse, error)
// CreateUserWithResponse Create a user
//
// Admin-only. Creates a control-plane account with the given email and
// password and grants the requested roles. The password is write-only and
// is never returned. Requires the write:user permission.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v2/users (the `CreateUser` operationId).
CreateUserWithResponse(ctx context.Context, body CreateUserJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateUserResponse, error)
// ListVariablesWithResponse List variables
//
// Lists the tenant's Airflow-style variables. Values of secret-ish keys are
// masked server-side. Requires the read:variable permission.
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/variables (the `ListVariables` operationId).
ListVariablesWithResponse(ctx context.Context, params *ListVariablesParams, reqEditors ...RequestEditorFn) (*ListVariablesResponse, error)
// CreateVariableWithBodyWithResponse Create or replace a variable (upsert)
//
// Upserts a variable: creates it, or replaces an existing one with the same
// key. Requires the write:variable permission.
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v2/variables (the `CreateVariable` operationId).
CreateVariableWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateVariableResponse, error)
// CreateVariableWithResponse Create or replace a variable (upsert)
//
// Upserts a variable: creates it, or replaces an existing one with the same
// key. Requires the write:variable permission.
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /api/v2/variables (the `CreateVariable` operationId).
CreateVariableWithResponse(ctx context.Context, body CreateVariableJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateVariableResponse, error)
// DeleteVariableWithResponse Delete a variable
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with DELETE /api/v2/variables/{variable_key} (the `DeleteVariable` operationId).
DeleteVariableWithResponse(ctx context.Context, variableKey VariableKey, reqEditors ...RequestEditorFn) (*DeleteVariableResponse, error)
// GetVariableWithResponse Get a variable
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/variables/{variable_key} (the `GetVariable` operationId).
GetVariableWithResponse(ctx context.Context, variableKey VariableKey, reqEditors ...RequestEditorFn) (*GetVariableResponse, error)
// GetVersionWithResponse Control-plane version (Airflow VersionInfo shape)
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/version (the `GetVersion` operationId).
GetVersionWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetVersionResponse, error)
// GetXcomEntryWithResponse Read XCom value (read-only proxy for the Redis backend)
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /api/v2/xcoms/{dag_id}/{dag_run_id}/{task_id}/{key} (the `GetXcomEntry` operationId).
GetXcomEntryWithResponse(ctx context.Context, dagId DagID, dagRunId DagRunID, taskId TaskID, key string, reqEditors ...RequestEditorFn) (*GetXcomEntryResponse, error)
// IssueTokenWithBodyWithResponse Issue a JWT for username/password credentials
//
// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /auth/token (the `IssueToken` operationId).
IssueTokenWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*IssueTokenResponse, error)
// IssueTokenWithResponse Issue a JWT for username/password credentials
//
// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
//
// Corresponds with POST /auth/token (the `IssueToken` operationId).
IssueTokenWithResponse(ctx context.Context, body IssueTokenJSONRequestBody, reqEditors ...RequestEditorFn) (*IssueTokenResponse, error)
// GetHealthzWithResponse Liveness probe
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /healthz (the `GetHealthz` operationId).
GetHealthzWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetHealthzResponse, error)
// GetReadyzWithResponse Readiness probe
//
// Returns a wrapper object for the known response body format(s).
//
// Corresponds with GET /readyz (the `GetReadyz` operationId).
GetReadyzWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetReadyzResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type ComponentHealth ¶
type ComponentHealth struct {
LatestDagProcessorHeartbeat *string `json:"latest_dag_processor_heartbeat,omitempty"`
LatestSchedulerHeartbeat *string `json:"latest_scheduler_heartbeat,omitempty"`
LatestTriggererHeartbeat *string `json:"latest_triggerer_heartbeat,omitempty"`
Status *string `json:"status,omitempty"`
}
ComponentHealth defines model for ComponentHealth.
type Connection ¶
type Connection struct {
ConnType string `json:"conn_type"`
ConnectionId string `json:"connection_id"`
Description *string `json:"description,omitempty"`
Extra *string `json:"extra,omitempty"`
// ExtraUnreadable Present and true in a listing when the extra is encrypted with a secret key the server does not have (for example after a key rotation that dropped the old key). The extra is then null, so a client that parses it as JSON still can. Reading the connection alone, or updating it, answers 500 with a message naming it, and the stored extra is kept.
ExtraUnreadable *bool `json:"extra_unreadable,omitempty"`
Host *string `json:"host,omitempty"`
Login *string `json:"login,omitempty"`
Port *int `json:"port,omitempty"`
Schema *string `json:"schema,omitempty"`
}
Connection An Airflow-style connection. The password is write-only and never returned; secret-bearing keys inside `extra` are masked server-side.
type ConnectionBody ¶
type ConnectionBody struct {
ConnType string `json:"conn_type"`
ConnectionId *string `json:"connection_id,omitempty"`
Description *string `json:"description,omitempty"`
Extra *string `json:"extra,omitempty"`
Host *string `json:"host,omitempty"`
Login *string `json:"login,omitempty"`
Password *string `json:"password,omitempty"`
Port *int `json:"port,omitempty"`
Schema *string `json:"schema,omitempty"`
}
ConnectionBody Connection create/replace payload. connection_id is required on POST (taken from the path on PATCH). password and extra are write-only. Every optional field is tri-state: omit the key to preserve the stored value (a partial write never wipes a field it does not mention, so the unreadable password survives a `--host`-only edit), send an empty string to clear the field, or send a value to set it. A password equal to the mask `***`, and any key inside `extra` whose value is exactly `***`, is treated as "unchanged" — so re-submitting a connection read back from GET (whose secrets are masked) never overwrites the real secret with the mask.
type ConnectionCollection ¶
type ConnectionCollection struct {
Connections *[]Connection `json:"connections,omitempty"`
TotalEntries *int `json:"total_entries,omitempty"`
}
ConnectionCollection defines model for ConnectionCollection.
type CreateAPITokenJSONRequestBody ¶ added in v0.5.4
type CreateAPITokenJSONRequestBody = CreateAPITokenRequest
CreateAPITokenJSONRequestBody defines body for CreateAPIToken for application/json ContentType.
type CreateAPITokenRequest ¶ added in v0.5.4
type CreateAPITokenRequest struct {
// ExpiresInSeconds Lifetime of the token. Defaults to 7776000 (90 days).
ExpiresInSeconds *int64 `json:"expires_in_seconds,omitempty"`
// Name A name for the token, unique among the caller's live tokens: 1 to 64 letters, digits, dots, dashes or underscores, starting with a letter or digit.
Name string `json:"name"`
// Scope deploy registers versions, sets the current version and reads DAGs; read only reads.
Scope CreateAPITokenRequestScope `json:"scope"`
}
CreateAPITokenRequest defines model for CreateAPITokenRequest.
type CreateAPITokenRequestScope ¶ added in v0.5.4
type CreateAPITokenRequestScope string
CreateAPITokenRequestScope deploy registers versions, sets the current version and reads DAGs; read only reads.
const ( Deploy CreateAPITokenRequestScope = "deploy" Read CreateAPITokenRequestScope = "read" )
Defines values for CreateAPITokenRequestScope.
func (CreateAPITokenRequestScope) Valid ¶ added in v0.5.4
func (e CreateAPITokenRequestScope) Valid() bool
Valid indicates whether the value is a known member of the CreateAPITokenRequestScope enum.
type CreateAPITokenResponse ¶ added in v0.5.4
type CreateAPITokenResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON201 the response for an HTTP 201 `application/json` response
JSON201 *CreatedAPIToken
// JSON400 the response for an HTTP 400 `application/json` response
JSON400 *Error
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *Error
// JSON409 the response for an HTTP 409 `application/json` response
JSON409 *Error
}
func ParseCreateAPITokenResponse ¶ added in v0.5.4
func ParseCreateAPITokenResponse(rsp *http.Response) (*CreateAPITokenResponse, error)
ParseCreateAPITokenResponse parses an HTTP response from a CreateAPITokenWithResponse call
func (CreateAPITokenResponse) ContentType ¶ added in v0.5.4
func (r CreateAPITokenResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (CreateAPITokenResponse) GetBody ¶ added in v0.5.4
func (r CreateAPITokenResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (CreateAPITokenResponse) GetJSON201 ¶ added in v0.5.4
func (r CreateAPITokenResponse) GetJSON201() *CreatedAPIToken
GetJSON201 returns the response for an HTTP 201 `application/json` response
func (CreateAPITokenResponse) GetJSON400 ¶ added in v0.5.4
func (r CreateAPITokenResponse) GetJSON400() *Error
GetJSON400 returns the response for an HTTP 400 `application/json` response
func (CreateAPITokenResponse) GetJSON401 ¶ added in v0.5.4
func (r CreateAPITokenResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (CreateAPITokenResponse) GetJSON403 ¶ added in v0.5.4
func (r CreateAPITokenResponse) GetJSON403() *Error
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (CreateAPITokenResponse) GetJSON409 ¶ added in v0.5.4
func (r CreateAPITokenResponse) GetJSON409() *Error
GetJSON409 returns the response for an HTTP 409 `application/json` response
func (CreateAPITokenResponse) Status ¶ added in v0.5.4
func (r CreateAPITokenResponse) Status() string
Status returns HTTPResponse.Status
func (CreateAPITokenResponse) StatusCode ¶ added in v0.5.4
func (r CreateAPITokenResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateConnectionJSONRequestBody ¶
type CreateConnectionJSONRequestBody = ConnectionBody
CreateConnectionJSONRequestBody defines body for CreateConnection for application/json ContentType.
type CreateConnectionResponse ¶
type CreateConnectionResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON201 the response for an HTTP 201 `application/json` response
JSON201 *Connection
// JSON400 the response for an HTTP 400 `application/json` response
JSON400 *Error
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
// JSON503 the response for an HTTP 503 `application/json` response
JSON503 *EncryptionUnavailable
}
func ParseCreateConnectionResponse ¶
func ParseCreateConnectionResponse(rsp *http.Response) (*CreateConnectionResponse, error)
ParseCreateConnectionResponse parses an HTTP response from a CreateConnectionWithResponse call
func (CreateConnectionResponse) ContentType ¶
func (r CreateConnectionResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (CreateConnectionResponse) GetBody ¶
func (r CreateConnectionResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (CreateConnectionResponse) GetJSON201 ¶
func (r CreateConnectionResponse) GetJSON201() *Connection
GetJSON201 returns the response for an HTTP 201 `application/json` response
func (CreateConnectionResponse) GetJSON400 ¶
func (r CreateConnectionResponse) GetJSON400() *Error
GetJSON400 returns the response for an HTTP 400 `application/json` response
func (CreateConnectionResponse) GetJSON401 ¶
func (r CreateConnectionResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (CreateConnectionResponse) GetJSON503 ¶
func (r CreateConnectionResponse) GetJSON503() *EncryptionUnavailable
GetJSON503 returns the response for an HTTP 503 `application/json` response
func (CreateConnectionResponse) Status ¶
func (r CreateConnectionResponse) Status() string
Status returns HTTPResponse.Status
func (CreateConnectionResponse) StatusCode ¶
func (r CreateConnectionResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateUserJSONRequestBody ¶
type CreateUserJSONRequestBody = CreateUserRequest
CreateUserJSONRequestBody defines body for CreateUser for application/json ContentType.
type CreateUserRequest ¶
type CreateUserRequest struct {
// Email Login email. Normalized to lowercase, so it is unique case-insensitively within the tenant.
Email string `json:"email"`
// Password Plaintext password (write-only; never returned). Must be at least 8 characters — the server rejects anything shorter with 400.
Password *string `json:"password,omitempty"`
// Roles Names of existing roles to grant; omit or empty to grant none.
Roles *[]string `json:"roles,omitempty"`
}
CreateUserRequest defines model for CreateUserRequest.
type CreateUserResponse ¶
type CreateUserResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON201 the response for an HTTP 201 `application/json` response
JSON201 *User
// JSON400 the response for an HTTP 400 `application/json` response
JSON400 *Error
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
// JSON409 the response for an HTTP 409 `application/json` response
JSON409 *Error
}
func ParseCreateUserResponse ¶
func ParseCreateUserResponse(rsp *http.Response) (*CreateUserResponse, error)
ParseCreateUserResponse parses an HTTP response from a CreateUserWithResponse call
func (CreateUserResponse) ContentType ¶
func (r CreateUserResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (CreateUserResponse) GetBody ¶
func (r CreateUserResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (CreateUserResponse) GetJSON201 ¶
func (r CreateUserResponse) GetJSON201() *User
GetJSON201 returns the response for an HTTP 201 `application/json` response
func (CreateUserResponse) GetJSON400 ¶
func (r CreateUserResponse) GetJSON400() *Error
GetJSON400 returns the response for an HTTP 400 `application/json` response
func (CreateUserResponse) GetJSON401 ¶
func (r CreateUserResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (CreateUserResponse) GetJSON409 ¶
func (r CreateUserResponse) GetJSON409() *Error
GetJSON409 returns the response for an HTTP 409 `application/json` response
func (CreateUserResponse) Status ¶
func (r CreateUserResponse) Status() string
Status returns HTTPResponse.Status
func (CreateUserResponse) StatusCode ¶
func (r CreateUserResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateVariableJSONRequestBody ¶
type CreateVariableJSONRequestBody = VariableBody
CreateVariableJSONRequestBody defines body for CreateVariable for application/json ContentType.
type CreateVariableResponse ¶
type CreateVariableResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON201 the response for an HTTP 201 `application/json` response
JSON201 *Variable
// JSON400 the response for an HTTP 400 `application/json` response
JSON400 *Error
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
}
func ParseCreateVariableResponse ¶
func ParseCreateVariableResponse(rsp *http.Response) (*CreateVariableResponse, error)
ParseCreateVariableResponse parses an HTTP response from a CreateVariableWithResponse call
func (CreateVariableResponse) ContentType ¶
func (r CreateVariableResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (CreateVariableResponse) GetBody ¶
func (r CreateVariableResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (CreateVariableResponse) GetJSON201 ¶
func (r CreateVariableResponse) GetJSON201() *Variable
GetJSON201 returns the response for an HTTP 201 `application/json` response
func (CreateVariableResponse) GetJSON400 ¶
func (r CreateVariableResponse) GetJSON400() *Error
GetJSON400 returns the response for an HTTP 400 `application/json` response
func (CreateVariableResponse) GetJSON401 ¶
func (r CreateVariableResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (CreateVariableResponse) Status ¶
func (r CreateVariableResponse) Status() string
Status returns HTTPResponse.Status
func (CreateVariableResponse) StatusCode ¶
func (r CreateVariableResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreatedAPIToken ¶ added in v0.5.4
type CreatedAPIToken struct {
CreatedAt time.Time `json:"created_at"`
ExpiresAt time.Time `json:"expires_at"`
Id string `json:"id"`
// LastUsedAt When the token last authenticated a request, recorded at most once every five minutes; null when it was never used.
LastUsedAt *time.Time `json:"last_used_at,omitempty"`
Name string `json:"name"`
// OwnerEmail Email of the token's owner (in lists).
OwnerEmail *string `json:"owner_email,omitempty"`
Scopes []string `json:"scopes"`
// Token The token, starting with dxf_. It is shown only in this response and cannot be read again.
Token string `json:"token"`
}
CreatedAPIToken defines model for CreatedAPIToken.
type DAG ¶
type DAG struct {
Catchup *bool `json:"catchup,omitempty"`
DagDisplayName *string `json:"dag_display_name,omitempty"`
DagId *string `json:"dag_id,omitempty"`
Description *string `json:"description,omitempty"`
Fileloc *string `json:"fileloc,omitempty"`
HasTaskConcurrencyLimits *bool `json:"has_task_concurrency_limits,omitempty"`
IsActive *bool `json:"is_active,omitempty"`
IsPaused *bool `json:"is_paused,omitempty"`
LastParsedTime *time.Time `json:"last_parsed_time,omitempty"`
MaxActiveRuns *int `json:"max_active_runs,omitempty"`
NextDagrun *time.Time `json:"next_dagrun,omitempty"`
Owners *[]string `json:"owners,omitempty"`
ScheduleInterval *map[string]interface{} `json:"schedule_interval,omitempty"`
Tags *[]struct {
Name *string `json:"name,omitempty"`
} `json:"tags,omitempty"`
TimetableDescription *string `json:"timetable_description,omitempty"`
}
DAG defines model for DAG.
type DAGCollection ¶
type DAGCollection struct {
Dags *[]DAG `json:"dags,omitempty"`
TotalEntries *int `json:"total_entries,omitempty"`
}
DAGCollection defines model for DAGCollection.
type DAGRun ¶
type DAGRun struct {
Conf *map[string]interface{} `json:"conf,omitempty"`
DagId *string `json:"dag_id,omitempty"`
DagRunId *string `json:"dag_run_id,omitempty"`
DataIntervalEnd *time.Time `json:"data_interval_end,omitempty"`
DataIntervalStart *time.Time `json:"data_interval_start,omitempty"`
EndDate *time.Time `json:"end_date,omitempty"`
LogicalDate *time.Time `json:"logical_date,omitempty"`
Note *string `json:"note,omitempty"`
QueuedAt *time.Time `json:"queued_at,omitempty"`
// RunOnLatestVersionNotApplied Dexaflow-only. The runs a clear with run_on_latest_version keeps on their own version, each with the reason (ADR 0086): only a finished run with no task instance queued or running moves to the current version. The clear still applies to these runs, on their version. Left out when every run moved or the option was not asked, and on every response other than the two clear routes.
RunOnLatestVersionNotApplied *ClearVersionNotApplied `json:"run_on_latest_version_not_applied,omitempty"`
RunType *DAGRunRunType `json:"run_type,omitempty"`
StartDate *time.Time `json:"start_date,omitempty"`
State *DAGRunState `json:"state,omitempty"`
}
DAGRun defines model for DAGRun.
type DAGRunClearRequest ¶ added in v0.5.4
type DAGRunClearRequest struct {
// DryRun Return the task instances that WOULD be cleared, without clearing them. Defaults to true, matching Apache Airflow. Send false to execute.
DryRun *bool `json:"dry_run,omitempty"`
// Note Accepted and not stored (run notes are not editable yet).
Note *string `json:"note,omitempty"`
// OnlyFailed Restrict the clear to the run's task instances in a failed state. false (the default, matching Apache Airflow) takes every task instance of the run.
OnlyFailed *bool `json:"only_failed,omitempty"`
// OnlyNew Not supported. Sending true is refused with 400: Dexaflow cannot yet tell which tasks a newer DAG version added.
OnlyNew *bool `json:"only_new,omitempty"`
// RunOnLatestVersion Which version the re-run executes. Unset or false keeps the version the run was created with. true moves a finished run (success or failed, with no task instance queued or running) to the DAG's current registered version, creating the task instances of the tasks that version adds and marking removed the ones of the tasks it dropped. A run that has not finished keeps its version, as in Airflow; the response then lists it in run_on_latest_version_not_applied with the reason (ADR 0086).
RunOnLatestVersion *bool `json:"run_on_latest_version,omitempty"`
}
DAGRunClearRequest defines model for DAGRunClearRequest.
type DAGRunCollection ¶
type DAGRunCollection struct {
DagRuns *[]DAGRun `json:"dag_runs,omitempty"`
// NextCursor Cursor of the next page. Present only when the request carried cursor and a next page exists.
NextCursor *string `json:"next_cursor,omitempty"`
// PreviousCursor Cursor of the previous page. Present only when the request carried cursor and the page is not the first.
PreviousCursor *string `json:"previous_cursor,omitempty"`
TotalEntries *int `json:"total_entries,omitempty"`
}
DAGRunCollection defines model for DAGRunCollection.
type DAGRunCreate ¶
type DAGRunCreate struct {
Conf *map[string]interface{} `json:"conf,omitempty"`
DagRunId *string `json:"dag_run_id,omitempty"`
LogicalDate *time.Time `json:"logical_date,omitempty"`
Note *string `json:"note,omitempty"`
}
DAGRunCreate defines model for DAGRunCreate.
type DAGRunRunType ¶
type DAGRunRunType string
DAGRunRunType defines model for DAGRun.RunType.
const ( DAGRunRunTypeBackfill DAGRunRunType = "backfill" DAGRunRunTypeDatasetTriggered DAGRunRunType = "dataset_triggered" DAGRunRunTypeManual DAGRunRunType = "manual" DAGRunRunTypeScheduled DAGRunRunType = "scheduled" )
Defines values for DAGRunRunType.
func (DAGRunRunType) Valid ¶
func (e DAGRunRunType) Valid() bool
Valid indicates whether the value is a known member of the DAGRunRunType enum.
type DAGRunState ¶
type DAGRunState string
DAGRunState defines model for DAGRun.State.
const ( DAGRunStateFailed DAGRunState = "failed" DAGRunStateQueued DAGRunState = "queued" DAGRunStateRunning DAGRunState = "running" DAGRunStateSuccess DAGRunState = "success" )
Defines values for DAGRunState.
func (DAGRunState) Valid ¶
func (e DAGRunState) Valid() bool
Valid indicates whether the value is a known member of the DAGRunState enum.
type DAGUpdate ¶
type DAGUpdate struct {
IsPaused *bool `json:"is_paused,omitempty"`
}
DAGUpdate is_paused must be present; a body without it is refused with 400. It is not listed under required so the generated Go client keeps the field a pointer.
type DagCurrentVersionChange ¶ added in v0.5.4
type DagCurrentVersionChange struct {
// Changed False when the version was already current.
Changed bool `json:"changed"`
DagId string `json:"dag_id"`
// From The version that was current before; null when none was.
From *DagVersion `json:"from"`
To DagVersion `json:"to"`
// Warnings What the change let through with a warning (a task that does not fit its size under executor.unit.enforce=warn, an image not pinned by digest under deploy.require_digest=warn). Absent when there is none.
Warnings *[]string `json:"warnings,omitempty"`
}
DagCurrentVersionChange defines model for DagCurrentVersionChange.
type DagCurrentVersionRequest ¶ added in v0.5.4
type DagCurrentVersionRequest struct {
// Version The version label (bundle_version).
Version *string `json:"version,omitempty"`
VersionNumber *int `json:"version_number,omitempty"`
}
DagCurrentVersionRequest Exactly one of version and version_number.
type DagSource ¶
type DagSource struct {
// Content The dag.py source text (compiled-spec JSON fallback for pre-source-capture versions).
Content *string `json:"content,omitempty"`
DagDisplayName *string `json:"dag_display_name,omitempty"`
DagId *string `json:"dag_id,omitempty"`
// VersionNumber The version whose source this is.
VersionNumber *int `json:"version_number,omitempty"`
}
DagSource defines model for DagSource.
type DagSpec ¶ added in v0.5.4
type DagSpec struct {
DagId string `json:"dag_id"`
DagVersion string `json:"dag_version"`
Image string `json:"image"`
SchemaVersion string `json:"schema_version"`
Tasks []map[string]interface{} `json:"tasks"`
AdditionalProperties map[string]interface{} `json:"-"`
}
DagSpec A compiled dag.json, as described by docs/api/dag-schema.json.
func (DagSpec) Get ¶ added in v0.5.4
Getter for additional properties for DagSpec. Returns the specified element and whether it was found
func (DagSpec) MarshalJSON ¶ added in v0.5.4
Override default JSON handling for DagSpec to handle AdditionalProperties
func (*DagSpec) UnmarshalJSON ¶ added in v0.5.4
Override default JSON handling for DagSpec to handle AdditionalProperties
type DagVersion ¶
type DagVersion struct {
// BuildInfo Dexaflow. Where the version was built, as its register sent it in the build_* parameters; null when it sent none. Served by the dagVersions routes and the currentVersion answer; the dag_version copies embedded in task instance, run and DAG details answers leave it out.
BuildInfo *BuildInfo `json:"build_info,omitempty"`
BundleName *string `json:"bundle_name,omitempty"`
BundleUrl *string `json:"bundle_url,omitempty"`
BundleVersion *string `json:"bundle_version,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
// CreatedBy Dexaflow. Id of the user who registered the version (not an email, since every reader of the DAG sees it); null when none was recorded.
CreatedBy *string `json:"created_by,omitempty"`
DagDisplayName *string `json:"dag_display_name,omitempty"`
DagId *string `json:"dag_id,omitempty"`
Id *string `json:"id,omitempty"`
// Image Dexaflow. The image the version runs, pinned by digest when the deploy resolved one.
Image *string `json:"image,omitempty"`
// IsCurrent Dexaflow. Whether new runs are created with this version.
IsCurrent *bool `json:"is_current,omitempty"`
// SpecHash Dexaflow. The canonical hash of the version's dag.json.
SpecHash *string `json:"spec_hash,omitempty"`
VersionNumber *int `json:"version_number,omitempty"`
}
DagVersion defines model for DagVersion.
type DagVersionCollection ¶
type DagVersionCollection struct {
DagVersions *[]DagVersion `json:"dag_versions,omitempty"`
TotalEntries *int `json:"total_entries,omitempty"`
}
DagVersionCollection defines model for DagVersionCollection.
type DeleteConnectionResponse ¶
type DeleteConnectionResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *NotFound
}
func ParseDeleteConnectionResponse ¶
func ParseDeleteConnectionResponse(rsp *http.Response) (*DeleteConnectionResponse, error)
ParseDeleteConnectionResponse parses an HTTP response from a DeleteConnectionWithResponse call
func (DeleteConnectionResponse) ContentType ¶
func (r DeleteConnectionResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (DeleteConnectionResponse) GetBody ¶
func (r DeleteConnectionResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (DeleteConnectionResponse) GetJSON401 ¶
func (r DeleteConnectionResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (DeleteConnectionResponse) GetJSON404 ¶
func (r DeleteConnectionResponse) GetJSON404() *NotFound
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (DeleteConnectionResponse) Status ¶
func (r DeleteConnectionResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteConnectionResponse) StatusCode ¶
func (r DeleteConnectionResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteVariableResponse ¶
type DeleteVariableResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *NotFound
}
func ParseDeleteVariableResponse ¶
func ParseDeleteVariableResponse(rsp *http.Response) (*DeleteVariableResponse, error)
ParseDeleteVariableResponse parses an HTTP response from a DeleteVariableWithResponse call
func (DeleteVariableResponse) ContentType ¶
func (r DeleteVariableResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (DeleteVariableResponse) GetBody ¶
func (r DeleteVariableResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (DeleteVariableResponse) GetJSON401 ¶
func (r DeleteVariableResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (DeleteVariableResponse) GetJSON404 ¶
func (r DeleteVariableResponse) GetJSON404() *NotFound
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (DeleteVariableResponse) Status ¶
func (r DeleteVariableResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteVariableResponse) StatusCode ¶
func (r DeleteVariableResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeployBuildKit ¶ added in v0.5.5
type DeployBuildKit struct {
// Namespace is the namespace of the builder.
Namespace string `json:"namespace,omitempty"`
// PodSelector is the label selector of the builder pod; empty selects
// app.kubernetes.io/component=builder.
PodSelector string `json:"pod_selector,omitempty"`
}
DeployBuildKit is the in-cluster BuildKit backend of DeployRemoteBuilder.
type DeployCIOIDC ¶ added in v0.5.5
type DeployCIOIDC struct {
// Issuers are the entries, in the server's order.
Issuers []DeployCIOIDCIssuer `json:"issuers"`
}
DeployCIOIDC is the ci_oidc of DeployDefaults.
type DeployCIOIDCIssuer ¶ added in v0.5.5
type DeployCIOIDCIssuer struct {
Name string `json:"name"`
Provider string `json:"provider"`
Issuer string `json:"issuer"`
Audience string `json:"audience"`
}
DeployCIOIDCIssuer is one CI OIDC issuer: its entry name, its provider (github, gitlab, cloudbuild or other), the iss of its tokens and the audience a pipeline asks its token for.
type DeployCloudBuild ¶ added in v0.5.5
type DeployCloudBuild struct {
// Project is the Google Cloud project the build runs in.
Project string `json:"project,omitempty"`
// Region is the Cloud Build region, such as us-central1.
Region string `json:"region,omitempty"`
// WorkerPool is a private pool,
// projects/<project>/locations/<region>/workerPools/<name>.
WorkerPool string `json:"worker_pool,omitempty"`
// ServiceAccount is the account the build runs as,
// projects/<project>/serviceAccounts/<email>.
ServiceAccount string `json:"service_account,omitempty"`
}
DeployCloudBuild is the Cloud Build backend of DeployRemoteBuilder. An unset field is empty.
type DeployDefaults ¶ added in v0.5.4
type DeployDefaults struct {
// Registry is the image prefix a deploy pushes to, such as ghcr.io/acme.
Registry string `json:"registry"`
// Platforms are the platforms a deploy builds for (os/arch[/variant]).
Platforms []string `json:"platforms"`
// BaseImage is the base image for projects that set none.
BaseImage string `json:"base_image"`
// SourceModeImage is the runtime image a deploy registers a DAG's
// dag.py on, with no build, when nothing local names one (source mode,
// #1772). Empty when the cluster advertises none, or from a server
// that predates the field.
SourceModeImage string `json:"source_mode_image,omitempty"`
// RemoteBuilder is the remote builder a deploy uses for builds no
// daemonless path covers, when nothing local names one (#1890). Nil when
// the cluster advertises none, or from a server that predates the field.
RemoteBuilder *DeployRemoteBuilder `json:"remote_builder,omitempty"`
// TaskServiceAccount is the ServiceAccount task pods run as when a task
// sets no execution.service_account (#1890). Empty when the cluster
// advertises none, or from a server that predates the field.
TaskServiceAccount string `json:"task_service_account,omitempty"`
// WarmPools are the cluster's warm pool settings (#1890). Nil when the
// cluster advertises none, or from a server that predates the field.
WarmPools *DeployWarmPools `json:"warm_pools,omitempty"`
// CIOIDC lists the CI OIDC issuers of the caller's tenant (ADR 0092),
// which `dexaflow ci init` writes a tokenless pipeline for. Nil when the
// tenant has none, or from a server that predates the field.
CIOIDC *DeployCIOIDC `json:"ci_oidc,omitempty"`
}
DeployDefaults are the cluster deploy defaults GET /api/v2/deployDefaults serves: what a deploy uses for the registry prefix, the build platforms, the base image, the source mode runtime image and the remote builder when nothing local sets them, and what it reports about the task service account and the warm pools. An unset field is empty or nil.
type DeployRemoteBuilder ¶ added in v0.5.5
type DeployRemoteBuilder struct {
// CloudBuild builds on Google Cloud Build.
CloudBuild *DeployCloudBuild `json:"cloud_build,omitempty"`
// BuildKit builds on the in-cluster BuildKit daemon the Helm chart runs
// (builder.enabled, #1883). Nil from a server that predates it.
BuildKit *DeployBuildKit `json:"buildkit,omitempty"`
}
DeployRemoteBuilder is the remote_builder of DeployDefaults: its backend.
type DeployWarmPools ¶ added in v0.5.5
type DeployWarmPools struct {
// Enabled says whether the cluster keeps warm workers at all.
Enabled bool `json:"enabled"`
// MinIdleWorkers is the cluster's idle worker floor per version.
MinIdleWorkers int `json:"min_idle_workers"`
// MaxPoolSize caps one version's pool.
MaxPoolSize int `json:"max_pool_size"`
}
DeployWarmPools is the warm_pools of DeployDefaults: a DAG that declares no min_idle_workers gets MinIdleWorkers, every value is capped at MaxPoolSize (0 sets no cap), and nothing is kept warm unless Enabled.
type EncryptionUnavailable ¶
type EncryptionUnavailable = Error
EncryptionUnavailable defines model for EncryptionUnavailable.
type Error ¶
type Error struct {
Detail *string `json:"detail,omitempty"`
Instance *string `json:"instance,omitempty"`
Status *int `json:"status,omitempty"`
Title *string `json:"title,omitempty"`
Type *string `json:"type,omitempty"`
}
Error defines model for Error.
type ExecutionReport ¶ added in v0.5.4
type ExecutionReport struct {
Pool WarmPoolReport `json:"pool"`
Tasks []TaskExecution `json:"tasks"`
// WarmPools execution.warm_pools_enabled on the server.
WarmPools bool `json:"warm_pools"`
}
ExecutionReport Where the version's tasks run (Dexaflow), from the same decision dispatch places an attempt with: on a warm worker of the version (warm pools, ADR 0058) or on a dedicated pod. Sent by the register and its dry run. A task is warm-eligible; it still takes a dedicated pod when no warm worker is free. A task the dispatcher would offer to a warm worker is reported dedicated when no warm worker of its version can exist (no idle worker kept, or a server that runs none).
type ExecutorInfo ¶
type ExecutorInfo struct {
AgentControlPlaneAddr *string `json:"agent_control_plane_addr,omitempty"`
ExecutionModes *[]string `json:"execution_modes,omitempty"`
PodDispatchEnabled *bool `json:"pod_dispatch_enabled,omitempty"`
TaskNamespace *string `json:"task_namespace,omitempty"`
}
ExecutorInfo defines model for ExecutorInfo.
type GetConnectionResponse ¶
type GetConnectionResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *Connection
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *NotFound
}
func ParseGetConnectionResponse ¶
func ParseGetConnectionResponse(rsp *http.Response) (*GetConnectionResponse, error)
ParseGetConnectionResponse parses an HTTP response from a GetConnectionWithResponse call
func (GetConnectionResponse) ContentType ¶
func (r GetConnectionResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetConnectionResponse) GetBody ¶
func (r GetConnectionResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetConnectionResponse) GetJSON200 ¶
func (r GetConnectionResponse) GetJSON200() *Connection
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetConnectionResponse) GetJSON401 ¶
func (r GetConnectionResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (GetConnectionResponse) GetJSON404 ¶
func (r GetConnectionResponse) GetJSON404() *NotFound
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (GetConnectionResponse) Status ¶
func (r GetConnectionResponse) Status() string
Status returns HTTPResponse.Status
func (GetConnectionResponse) StatusCode ¶
func (r GetConnectionResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetDagResponse ¶
type GetDagResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *DAG
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *NotFound
}
func ParseGetDagResponse ¶
func ParseGetDagResponse(rsp *http.Response) (*GetDagResponse, error)
ParseGetDagResponse parses an HTTP response from a GetDagWithResponse call
func (GetDagResponse) ContentType ¶
func (r GetDagResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetDagResponse) GetBody ¶
func (r GetDagResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetDagResponse) GetJSON200 ¶
func (r GetDagResponse) GetJSON200() *DAG
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetDagResponse) GetJSON404 ¶
func (r GetDagResponse) GetJSON404() *NotFound
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (GetDagResponse) Status ¶
func (r GetDagResponse) Status() string
Status returns HTTPResponse.Status
func (GetDagResponse) StatusCode ¶
func (r GetDagResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetDagRunResponse ¶
type GetDagRunResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *DAGRun
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *NotFound
}
func ParseGetDagRunResponse ¶
func ParseGetDagRunResponse(rsp *http.Response) (*GetDagRunResponse, error)
ParseGetDagRunResponse parses an HTTP response from a GetDagRunWithResponse call
func (GetDagRunResponse) ContentType ¶
func (r GetDagRunResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetDagRunResponse) GetBody ¶
func (r GetDagRunResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetDagRunResponse) GetJSON200 ¶
func (r GetDagRunResponse) GetJSON200() *DAGRun
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetDagRunResponse) GetJSON404 ¶
func (r GetDagRunResponse) GetJSON404() *NotFound
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (GetDagRunResponse) Status ¶
func (r GetDagRunResponse) Status() string
Status returns HTTPResponse.Status
func (GetDagRunResponse) StatusCode ¶
func (r GetDagRunResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetDagSourceResponse ¶
type GetDagSourceResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *DagSource
// JSON400 the response for an HTTP 400 `application/json` response
JSON400 *Error
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *NotFound
}
func ParseGetDagSourceResponse ¶
func ParseGetDagSourceResponse(rsp *http.Response) (*GetDagSourceResponse, error)
ParseGetDagSourceResponse parses an HTTP response from a GetDagSourceWithResponse call
func (GetDagSourceResponse) ContentType ¶
func (r GetDagSourceResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetDagSourceResponse) GetBody ¶
func (r GetDagSourceResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetDagSourceResponse) GetJSON200 ¶
func (r GetDagSourceResponse) GetJSON200() *DagSource
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetDagSourceResponse) GetJSON400 ¶ added in v0.5.4
func (r GetDagSourceResponse) GetJSON400() *Error
GetJSON400 returns the response for an HTTP 400 `application/json` response
func (GetDagSourceResponse) GetJSON404 ¶
func (r GetDagSourceResponse) GetJSON404() *NotFound
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (GetDagSourceResponse) Status ¶
func (r GetDagSourceResponse) Status() string
Status returns HTTPResponse.Status
func (GetDagSourceResponse) StatusCode ¶
func (r GetDagSourceResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetDagSpecResponse ¶
type GetDagSpecResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *map[string]interface{}
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *NotFound
}
func ParseGetDagSpecResponse ¶
func ParseGetDagSpecResponse(rsp *http.Response) (*GetDagSpecResponse, error)
ParseGetDagSpecResponse parses an HTTP response from a GetDagSpecWithResponse call
func (GetDagSpecResponse) ContentType ¶
func (r GetDagSpecResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetDagSpecResponse) GetBody ¶
func (r GetDagSpecResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetDagSpecResponse) GetJSON200 ¶
func (r GetDagSpecResponse) GetJSON200() *map[string]interface{}
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetDagSpecResponse) GetJSON404 ¶
func (r GetDagSpecResponse) GetJSON404() *NotFound
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (GetDagSpecResponse) Status ¶
func (r GetDagSpecResponse) Status() string
Status returns HTTPResponse.Status
func (GetDagSpecResponse) StatusCode ¶
func (r GetDagSpecResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetDagVersionResponse ¶
type GetDagVersionResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *DagVersion
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *NotFound
}
func ParseGetDagVersionResponse ¶
func ParseGetDagVersionResponse(rsp *http.Response) (*GetDagVersionResponse, error)
ParseGetDagVersionResponse parses an HTTP response from a GetDagVersionWithResponse call
func (GetDagVersionResponse) ContentType ¶
func (r GetDagVersionResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetDagVersionResponse) GetBody ¶
func (r GetDagVersionResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetDagVersionResponse) GetJSON200 ¶
func (r GetDagVersionResponse) GetJSON200() *DagVersion
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetDagVersionResponse) GetJSON404 ¶
func (r GetDagVersionResponse) GetJSON404() *NotFound
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (GetDagVersionResponse) Status ¶
func (r GetDagVersionResponse) Status() string
Status returns HTTPResponse.Status
func (GetDagVersionResponse) StatusCode ¶
func (r GetDagVersionResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetHealthzResponse ¶
func ParseGetHealthzResponse ¶
func ParseGetHealthzResponse(rsp *http.Response) (*GetHealthzResponse, error)
ParseGetHealthzResponse parses an HTTP response from a GetHealthzWithResponse call
func (GetHealthzResponse) ContentType ¶
func (r GetHealthzResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetHealthzResponse) GetBody ¶
func (r GetHealthzResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetHealthzResponse) Status ¶
func (r GetHealthzResponse) Status() string
Status returns HTTPResponse.Status
func (GetHealthzResponse) StatusCode ¶
func (r GetHealthzResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetMonitorExecutorResponse ¶
type GetMonitorExecutorResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *ExecutorInfo
}
func ParseGetMonitorExecutorResponse ¶
func ParseGetMonitorExecutorResponse(rsp *http.Response) (*GetMonitorExecutorResponse, error)
ParseGetMonitorExecutorResponse parses an HTTP response from a GetMonitorExecutorWithResponse call
func (GetMonitorExecutorResponse) ContentType ¶
func (r GetMonitorExecutorResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetMonitorExecutorResponse) GetBody ¶
func (r GetMonitorExecutorResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetMonitorExecutorResponse) GetJSON200 ¶
func (r GetMonitorExecutorResponse) GetJSON200() *ExecutorInfo
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetMonitorExecutorResponse) Status ¶
func (r GetMonitorExecutorResponse) Status() string
Status returns HTTPResponse.Status
func (GetMonitorExecutorResponse) StatusCode ¶
func (r GetMonitorExecutorResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetMonitorHealthResponse ¶
type GetMonitorHealthResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *HealthInfo
}
func ParseGetMonitorHealthResponse ¶
func ParseGetMonitorHealthResponse(rsp *http.Response) (*GetMonitorHealthResponse, error)
ParseGetMonitorHealthResponse parses an HTTP response from a GetMonitorHealthWithResponse call
func (GetMonitorHealthResponse) ContentType ¶
func (r GetMonitorHealthResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetMonitorHealthResponse) GetBody ¶
func (r GetMonitorHealthResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetMonitorHealthResponse) GetJSON200 ¶
func (r GetMonitorHealthResponse) GetJSON200() *HealthInfo
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetMonitorHealthResponse) Status ¶
func (r GetMonitorHealthResponse) Status() string
Status returns HTTPResponse.Status
func (GetMonitorHealthResponse) StatusCode ¶
func (r GetMonitorHealthResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetReadyzResponse ¶
func ParseGetReadyzResponse ¶
func ParseGetReadyzResponse(rsp *http.Response) (*GetReadyzResponse, error)
ParseGetReadyzResponse parses an HTTP response from a GetReadyzWithResponse call
func (GetReadyzResponse) ContentType ¶
func (r GetReadyzResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetReadyzResponse) GetBody ¶
func (r GetReadyzResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetReadyzResponse) Status ¶
func (r GetReadyzResponse) Status() string
Status returns HTTPResponse.Status
func (GetReadyzResponse) StatusCode ¶
func (r GetReadyzResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetTaskInstanceResponse ¶
type GetTaskInstanceResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *TaskInstance
}
func ParseGetTaskInstanceResponse ¶
func ParseGetTaskInstanceResponse(rsp *http.Response) (*GetTaskInstanceResponse, error)
ParseGetTaskInstanceResponse parses an HTTP response from a GetTaskInstanceWithResponse call
func (GetTaskInstanceResponse) ContentType ¶
func (r GetTaskInstanceResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetTaskInstanceResponse) GetBody ¶
func (r GetTaskInstanceResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetTaskInstanceResponse) GetJSON200 ¶
func (r GetTaskInstanceResponse) GetJSON200() *TaskInstance
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetTaskInstanceResponse) Status ¶
func (r GetTaskInstanceResponse) Status() string
Status returns HTTPResponse.Status
func (GetTaskInstanceResponse) StatusCode ¶
func (r GetTaskInstanceResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetTaskLogsResponse ¶
func ParseGetTaskLogsResponse ¶
func ParseGetTaskLogsResponse(rsp *http.Response) (*GetTaskLogsResponse, error)
ParseGetTaskLogsResponse parses an HTTP response from a GetTaskLogsWithResponse call
func (GetTaskLogsResponse) ContentType ¶
func (r GetTaskLogsResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetTaskLogsResponse) GetBody ¶
func (r GetTaskLogsResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetTaskLogsResponse) Status ¶
func (r GetTaskLogsResponse) Status() string
Status returns HTTPResponse.Status
func (GetTaskLogsResponse) StatusCode ¶
func (r GetTaskLogsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetVariableResponse ¶
type GetVariableResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *Variable
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *NotFound
}
func ParseGetVariableResponse ¶
func ParseGetVariableResponse(rsp *http.Response) (*GetVariableResponse, error)
ParseGetVariableResponse parses an HTTP response from a GetVariableWithResponse call
func (GetVariableResponse) ContentType ¶
func (r GetVariableResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetVariableResponse) GetBody ¶
func (r GetVariableResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetVariableResponse) GetJSON200 ¶
func (r GetVariableResponse) GetJSON200() *Variable
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetVariableResponse) GetJSON401 ¶
func (r GetVariableResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (GetVariableResponse) GetJSON404 ¶
func (r GetVariableResponse) GetJSON404() *NotFound
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (GetVariableResponse) Status ¶
func (r GetVariableResponse) Status() string
Status returns HTTPResponse.Status
func (GetVariableResponse) StatusCode ¶
func (r GetVariableResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetVersionResponse ¶
type GetVersionResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *VersionInfo
}
func ParseGetVersionResponse ¶
func ParseGetVersionResponse(rsp *http.Response) (*GetVersionResponse, error)
ParseGetVersionResponse parses an HTTP response from a GetVersionWithResponse call
func (GetVersionResponse) ContentType ¶
func (r GetVersionResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetVersionResponse) GetBody ¶
func (r GetVersionResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetVersionResponse) GetJSON200 ¶
func (r GetVersionResponse) GetJSON200() *VersionInfo
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetVersionResponse) Status ¶
func (r GetVersionResponse) Status() string
Status returns HTTPResponse.Status
func (GetVersionResponse) StatusCode ¶
func (r GetVersionResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetXcomEntryResponse ¶
type GetXcomEntryResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *XComEntry
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *NotFound
}
func ParseGetXcomEntryResponse ¶
func ParseGetXcomEntryResponse(rsp *http.Response) (*GetXcomEntryResponse, error)
ParseGetXcomEntryResponse parses an HTTP response from a GetXcomEntryWithResponse call
func (GetXcomEntryResponse) ContentType ¶
func (r GetXcomEntryResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (GetXcomEntryResponse) GetBody ¶
func (r GetXcomEntryResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (GetXcomEntryResponse) GetJSON200 ¶
func (r GetXcomEntryResponse) GetJSON200() *XComEntry
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (GetXcomEntryResponse) GetJSON404 ¶
func (r GetXcomEntryResponse) GetJSON404() *NotFound
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (GetXcomEntryResponse) Status ¶
func (r GetXcomEntryResponse) Status() string
Status returns HTTPResponse.Status
func (GetXcomEntryResponse) StatusCode ¶
func (r GetXcomEntryResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type HealthInfo ¶
type HealthInfo struct {
DagProcessor *ComponentHealth `json:"dag_processor,omitempty"`
Metadatabase *ComponentHealth `json:"metadatabase,omitempty"`
Scheduler *ComponentHealth `json:"scheduler,omitempty"`
Triggerer *ComponentHealth `json:"triggerer,omitempty"`
}
HealthInfo defines model for HealthInfo.
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type IssueTokenJSONRequestBody ¶
type IssueTokenJSONRequestBody = TokenRequest
IssueTokenJSONRequestBody defines body for IssueToken for application/json ContentType.
type IssueTokenResponse ¶
type IssueTokenResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *TokenResponse
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
// Headers200 the parsed response headers for an HTTP 200 response
Headers200 *IssueTokenResponse200Headers
}
func ParseIssueTokenResponse ¶
func ParseIssueTokenResponse(rsp *http.Response) (*IssueTokenResponse, error)
ParseIssueTokenResponse parses an HTTP response from a IssueTokenWithResponse call
func (IssueTokenResponse) ContentType ¶
func (r IssueTokenResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (IssueTokenResponse) GetBody ¶
func (r IssueTokenResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (IssueTokenResponse) GetJSON200 ¶
func (r IssueTokenResponse) GetJSON200() *TokenResponse
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (IssueTokenResponse) GetJSON401 ¶
func (r IssueTokenResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (IssueTokenResponse) Status ¶
func (r IssueTokenResponse) Status() string
Status returns HTTPResponse.Status
func (IssueTokenResponse) StatusCode ¶
func (r IssueTokenResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type IssueTokenResponse200Headers ¶
type IssueTokenResponse200Headers struct {
SetCookie *string
}
IssueTokenResponse200Headers the declared response headers of an HTTP 200 response for IssueToken
type ListAPITokensParams ¶ added in v0.5.4
type ListAPITokensParams struct {
Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"`
Offset *Offset `form:"offset,omitempty" json:"offset,omitempty"`
}
ListAPITokensParams defines parameters for ListAPITokens.
type ListAPITokensResponse ¶ added in v0.5.4
type ListAPITokensResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *APITokenCollection
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *Error
}
func ParseListAPITokensResponse ¶ added in v0.5.4
func ParseListAPITokensResponse(rsp *http.Response) (*ListAPITokensResponse, error)
ParseListAPITokensResponse parses an HTTP response from a ListAPITokensWithResponse call
func (ListAPITokensResponse) ContentType ¶ added in v0.5.4
func (r ListAPITokensResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (ListAPITokensResponse) GetBody ¶ added in v0.5.4
func (r ListAPITokensResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (ListAPITokensResponse) GetJSON200 ¶ added in v0.5.4
func (r ListAPITokensResponse) GetJSON200() *APITokenCollection
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (ListAPITokensResponse) GetJSON401 ¶ added in v0.5.4
func (r ListAPITokensResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (ListAPITokensResponse) GetJSON403 ¶ added in v0.5.4
func (r ListAPITokensResponse) GetJSON403() *Error
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (ListAPITokensResponse) Status ¶ added in v0.5.4
func (r ListAPITokensResponse) Status() string
Status returns HTTPResponse.Status
func (ListAPITokensResponse) StatusCode ¶ added in v0.5.4
func (r ListAPITokensResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListConnectionsParams ¶
type ListConnectionsParams struct {
Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"`
Offset *Offset `form:"offset,omitempty" json:"offset,omitempty"`
}
ListConnectionsParams defines parameters for ListConnections.
type ListConnectionsResponse ¶
type ListConnectionsResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *ConnectionCollection
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
}
func ParseListConnectionsResponse ¶
func ParseListConnectionsResponse(rsp *http.Response) (*ListConnectionsResponse, error)
ParseListConnectionsResponse parses an HTTP response from a ListConnectionsWithResponse call
func (ListConnectionsResponse) ContentType ¶
func (r ListConnectionsResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (ListConnectionsResponse) GetBody ¶
func (r ListConnectionsResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (ListConnectionsResponse) GetJSON200 ¶
func (r ListConnectionsResponse) GetJSON200() *ConnectionCollection
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (ListConnectionsResponse) GetJSON401 ¶
func (r ListConnectionsResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (ListConnectionsResponse) Status ¶
func (r ListConnectionsResponse) Status() string
Status returns HTTPResponse.Status
func (ListConnectionsResponse) StatusCode ¶
func (r ListConnectionsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListDagRunsParams ¶
type ListDagRunsParams struct {
Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"`
Offset *Offset `form:"offset,omitempty" json:"offset,omitempty"`
// Cursor Opaque cursor, as Apache Airflow 3.3 pages its lists. Send it empty for the first page, then the next_cursor or previous_cursor the previous body named. Whenever the request carries cursor, the body names next_cursor (absent on the last page) and previous_cursor (absent on the first page); a request without cursor gets the body without those fields. A cursor that is not one this server issued is refused with 400. Dexaflow also accepts the keyset cursor of the Dexaflow-Next-Cursor response header on the DAG run list: the page then holds the runs after the cursor in the same order, at the cost of the first page whatever the depth. With a state filter, offset paging filters the newest 10000 runs and counts total_entries within them, while keyset paging filters and counts every run of the DAG, so the two modes can report different totals for a DAG with more runs than that.
Cursor *Cursor `form:"cursor,omitempty" json:"cursor,omitempty"`
State *[]ListDagRunsParamsState `form:"state,omitempty" json:"state,omitempty"`
}
ListDagRunsParams defines parameters for ListDagRuns.
type ListDagRunsParamsState ¶
type ListDagRunsParamsState string
ListDagRunsParamsState defines parameters for ListDagRuns.
const ( ListDagRunsParamsStateFailed ListDagRunsParamsState = "failed" ListDagRunsParamsStateQueued ListDagRunsParamsState = "queued" ListDagRunsParamsStateRunning ListDagRunsParamsState = "running" ListDagRunsParamsStateSuccess ListDagRunsParamsState = "success" )
Defines values for ListDagRunsParamsState.
func (ListDagRunsParamsState) Valid ¶
func (e ListDagRunsParamsState) Valid() bool
Valid indicates whether the value is a known member of the ListDagRunsParamsState enum.
type ListDagRunsResponse ¶
type ListDagRunsResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *DAGRunCollection
}
func ParseListDagRunsResponse ¶
func ParseListDagRunsResponse(rsp *http.Response) (*ListDagRunsResponse, error)
ParseListDagRunsResponse parses an HTTP response from a ListDagRunsWithResponse call
func (ListDagRunsResponse) ContentType ¶
func (r ListDagRunsResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (ListDagRunsResponse) GetBody ¶
func (r ListDagRunsResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (ListDagRunsResponse) GetJSON200 ¶
func (r ListDagRunsResponse) GetJSON200() *DAGRunCollection
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (ListDagRunsResponse) Status ¶
func (r ListDagRunsResponse) Status() string
Status returns HTTPResponse.Status
func (ListDagRunsResponse) StatusCode ¶
func (r ListDagRunsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListDagVersionsResponse ¶
type ListDagVersionsResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *DagVersionCollection
}
func ParseListDagVersionsResponse ¶
func ParseListDagVersionsResponse(rsp *http.Response) (*ListDagVersionsResponse, error)
ParseListDagVersionsResponse parses an HTTP response from a ListDagVersionsWithResponse call
func (ListDagVersionsResponse) ContentType ¶
func (r ListDagVersionsResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (ListDagVersionsResponse) GetBody ¶
func (r ListDagVersionsResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (ListDagVersionsResponse) GetJSON200 ¶
func (r ListDagVersionsResponse) GetJSON200() *DagVersionCollection
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (ListDagVersionsResponse) Status ¶
func (r ListDagVersionsResponse) Status() string
Status returns HTTPResponse.Status
func (ListDagVersionsResponse) StatusCode ¶
func (r ListDagVersionsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListDagsParams ¶
type ListDagsParams struct {
Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"`
Offset *Offset `form:"offset,omitempty" json:"offset,omitempty"`
Tags *[]string `form:"tags,omitempty" json:"tags,omitempty"`
OnlyActive *bool `form:"only_active,omitempty" json:"only_active,omitempty"`
Paused *bool `form:"paused,omitempty" json:"paused,omitempty"`
}
ListDagsParams defines parameters for ListDags.
type ListDagsResponse ¶
type ListDagsResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *DAGCollection
}
func ParseListDagsResponse ¶
func ParseListDagsResponse(rsp *http.Response) (*ListDagsResponse, error)
ParseListDagsResponse parses an HTTP response from a ListDagsWithResponse call
func (ListDagsResponse) ContentType ¶
func (r ListDagsResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (ListDagsResponse) GetBody ¶
func (r ListDagsResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (ListDagsResponse) GetJSON200 ¶
func (r ListDagsResponse) GetJSON200() *DAGCollection
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (ListDagsResponse) Status ¶
func (r ListDagsResponse) Status() string
Status returns HTTPResponse.Status
func (ListDagsResponse) StatusCode ¶
func (r ListDagsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListTaskInstancesResponse ¶
type ListTaskInstancesResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *TaskInstanceCollection
}
func ParseListTaskInstancesResponse ¶
func ParseListTaskInstancesResponse(rsp *http.Response) (*ListTaskInstancesResponse, error)
ParseListTaskInstancesResponse parses an HTTP response from a ListTaskInstancesWithResponse call
func (ListTaskInstancesResponse) ContentType ¶
func (r ListTaskInstancesResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (ListTaskInstancesResponse) GetBody ¶
func (r ListTaskInstancesResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (ListTaskInstancesResponse) GetJSON200 ¶
func (r ListTaskInstancesResponse) GetJSON200() *TaskInstanceCollection
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (ListTaskInstancesResponse) Status ¶
func (r ListTaskInstancesResponse) Status() string
Status returns HTTPResponse.Status
func (ListTaskInstancesResponse) StatusCode ¶
func (r ListTaskInstancesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListUsersParams ¶
type ListUsersParams struct {
Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"`
Offset *Offset `form:"offset,omitempty" json:"offset,omitempty"`
}
ListUsersParams defines parameters for ListUsers.
type ListUsersResponse ¶
type ListUsersResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *UserCollection
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
}
func ParseListUsersResponse ¶
func ParseListUsersResponse(rsp *http.Response) (*ListUsersResponse, error)
ParseListUsersResponse parses an HTTP response from a ListUsersWithResponse call
func (ListUsersResponse) ContentType ¶
func (r ListUsersResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (ListUsersResponse) GetBody ¶
func (r ListUsersResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (ListUsersResponse) GetJSON200 ¶
func (r ListUsersResponse) GetJSON200() *UserCollection
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (ListUsersResponse) GetJSON401 ¶
func (r ListUsersResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (ListUsersResponse) Status ¶
func (r ListUsersResponse) Status() string
Status returns HTTPResponse.Status
func (ListUsersResponse) StatusCode ¶
func (r ListUsersResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListVariablesParams ¶
type ListVariablesParams struct {
Limit *Limit `form:"limit,omitempty" json:"limit,omitempty"`
Offset *Offset `form:"offset,omitempty" json:"offset,omitempty"`
}
ListVariablesParams defines parameters for ListVariables.
type ListVariablesResponse ¶
type ListVariablesResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *VariableCollection
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
}
func ParseListVariablesResponse ¶
func ParseListVariablesResponse(rsp *http.Response) (*ListVariablesResponse, error)
ParseListVariablesResponse parses an HTTP response from a ListVariablesWithResponse call
func (ListVariablesResponse) ContentType ¶
func (r ListVariablesResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (ListVariablesResponse) GetBody ¶
func (r ListVariablesResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (ListVariablesResponse) GetJSON200 ¶
func (r ListVariablesResponse) GetJSON200() *VariableCollection
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (ListVariablesResponse) GetJSON401 ¶
func (r ListVariablesResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (ListVariablesResponse) Status ¶
func (r ListVariablesResponse) Status() string
Status returns HTTPResponse.Status
func (ListVariablesResponse) StatusCode ¶
func (r ListVariablesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PatchTaskInstanceDryRunJSONRequestBody ¶ added in v0.5.4
type PatchTaskInstanceDryRunJSONRequestBody = TaskInstanceStateUpdate
PatchTaskInstanceDryRunJSONRequestBody defines body for PatchTaskInstanceDryRun for application/json ContentType.
type PatchTaskInstanceDryRunResponse ¶ added in v0.5.4
type PatchTaskInstanceDryRunResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *TaskInstanceCollection
// JSON400 the response for an HTTP 400 `application/json` response
JSON400 *Error
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *NotFound
}
func ParsePatchTaskInstanceDryRunResponse ¶ added in v0.5.4
func ParsePatchTaskInstanceDryRunResponse(rsp *http.Response) (*PatchTaskInstanceDryRunResponse, error)
ParsePatchTaskInstanceDryRunResponse parses an HTTP response from a PatchTaskInstanceDryRunWithResponse call
func (PatchTaskInstanceDryRunResponse) ContentType ¶ added in v0.5.4
func (r PatchTaskInstanceDryRunResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (PatchTaskInstanceDryRunResponse) GetBody ¶ added in v0.5.4
func (r PatchTaskInstanceDryRunResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (PatchTaskInstanceDryRunResponse) GetJSON200 ¶ added in v0.5.4
func (r PatchTaskInstanceDryRunResponse) GetJSON200() *TaskInstanceCollection
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (PatchTaskInstanceDryRunResponse) GetJSON400 ¶ added in v0.5.4
func (r PatchTaskInstanceDryRunResponse) GetJSON400() *Error
GetJSON400 returns the response for an HTTP 400 `application/json` response
func (PatchTaskInstanceDryRunResponse) GetJSON404 ¶ added in v0.5.4
func (r PatchTaskInstanceDryRunResponse) GetJSON404() *NotFound
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (PatchTaskInstanceDryRunResponse) Status ¶ added in v0.5.4
func (r PatchTaskInstanceDryRunResponse) Status() string
Status returns HTTPResponse.Status
func (PatchTaskInstanceDryRunResponse) StatusCode ¶ added in v0.5.4
func (r PatchTaskInstanceDryRunResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PatchTaskInstanceJSONRequestBody ¶ added in v0.5.4
type PatchTaskInstanceJSONRequestBody = TaskInstanceStateUpdate
PatchTaskInstanceJSONRequestBody defines body for PatchTaskInstance for application/json ContentType.
type PatchTaskInstanceResponse ¶ added in v0.5.4
type PatchTaskInstanceResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *TaskInstanceCollection
// JSON400 the response for an HTTP 400 `application/json` response
JSON400 *Error
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *NotFound
}
func ParsePatchTaskInstanceResponse ¶ added in v0.5.4
func ParsePatchTaskInstanceResponse(rsp *http.Response) (*PatchTaskInstanceResponse, error)
ParsePatchTaskInstanceResponse parses an HTTP response from a PatchTaskInstanceWithResponse call
func (PatchTaskInstanceResponse) ContentType ¶ added in v0.5.4
func (r PatchTaskInstanceResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (PatchTaskInstanceResponse) GetBody ¶ added in v0.5.4
func (r PatchTaskInstanceResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (PatchTaskInstanceResponse) GetJSON200 ¶ added in v0.5.4
func (r PatchTaskInstanceResponse) GetJSON200() *TaskInstanceCollection
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (PatchTaskInstanceResponse) GetJSON400 ¶ added in v0.5.4
func (r PatchTaskInstanceResponse) GetJSON400() *Error
GetJSON400 returns the response for an HTTP 400 `application/json` response
func (PatchTaskInstanceResponse) GetJSON404 ¶ added in v0.5.4
func (r PatchTaskInstanceResponse) GetJSON404() *NotFound
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (PatchTaskInstanceResponse) Status ¶ added in v0.5.4
func (r PatchTaskInstanceResponse) Status() string
Status returns HTTPResponse.Status
func (PatchTaskInstanceResponse) StatusCode ¶ added in v0.5.4
func (r PatchTaskInstanceResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RegisterDagVersionJSONRequestBody ¶ added in v0.5.4
type RegisterDagVersionJSONRequestBody = DagSpec
RegisterDagVersionJSONRequestBody defines body for RegisterDagVersion for application/json ContentType.
type RegisterDagVersionParams ¶ added in v0.5.4
type RegisterDagVersionParams struct {
// IsPaused Sets the DAG's is_paused for this register (true or false). Any other value is refused with 400. Sending it needs write on dags, and a scoped token also needs the dexaflow:run scope (403 otherwise).
IsPaused *bool `form:"is_paused,omitempty" json:"is_paused,omitempty"`
// PromotedFrom Marks the register as a promotion (`dexaflow promote`): the name of the target the version was read from, recorded with promoted_from_server under promoted_from in the register's audit entry. It is the caller's claim, recorded as sent and not verified. A target name: lower case letters, digits, _ and -, starting with a letter or digit, at most 63 characters; anything else is refused with 400.
PromotedFrom *string `form:"promoted_from,omitempty" json:"promoted_from,omitempty"`
// PromotedFromServer The URL of the control plane the version was promoted from, as the caller claims it (not verified): an absolute http or https URL without credentials and with no control or format character, at most 2048 bytes. It needs promoted_from (400 otherwise).
PromotedFromServer *string `form:"promoted_from_server,omitempty" json:"promoted_from_server,omitempty"`
// BuildCommit Where the version was built (#1702), with the other build_* parameters: the git commit of its sources, 7 to 64 lower case hex characters. The build_* parameters are metadata of the register, not part of dag.json: they change neither the spec, its hash nor the version label. They are stored with the version the register creates (build_info in DagVersion) and recorded in its audit entry; a register of content already registered keeps the build info of its first register. They are the caller's claim, recorded as sent and not verified. A value that is empty or breaks its rule is refused with 400.
BuildCommit *string `form:"build_commit,omitempty" json:"build_commit,omitempty"`
// BuildRepo The repository of the sources: an absolute http or https URL without credentials, query string or fragment, valid UTF-8 with no control or format character, at most 2048 bytes.
BuildRepo *string `form:"build_repo,omitempty" json:"build_repo,omitempty"`
// BuildPipelineUrl The CI pipeline run that built the version: an absolute http or https URL without credentials, query string or fragment, valid UTF-8 with no control or format character, at most 2048 bytes.
BuildPipelineUrl *string `form:"build_pipeline_url,omitempty" json:"build_pipeline_url,omitempty"`
// BuildBuilder The builder that produced the image, at most 255 bytes, with no control or format character.
BuildBuilder *string `form:"build_builder,omitempty" json:"build_builder,omitempty"`
// BuildBaseImage The base image the DAG image was built from (it carries the task agent), at most 512 bytes, with no space, control or format character.
BuildBaseImage *string `form:"build_base_image,omitempty" json:"build_base_image,omitempty"`
// BuildCliVersion The version of the CLI that built and registered the version, at most 128 bytes, with no space, control or format character.
BuildCliVersion *string `form:"build_cli_version,omitempty" json:"build_cli_version,omitempty"`
}
RegisterDagVersionParams defines parameters for RegisterDagVersion.
type RegisterDagVersionResponse ¶ added in v0.5.4
type RegisterDagVersionResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *VersionRegistration
// JSON201 the response for an HTTP 201 `application/json` response
JSON201 *VersionRegistration
// JSON400 the response for an HTTP 400 `application/json` response
JSON400 *Error
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *Error
// JSON409 the response for an HTTP 409 `application/json` response
JSON409 *Error
// Headers403 the parsed response headers for an HTTP 403 response
Headers403 *RegisterDagVersionResponse403Headers
}
func ParseRegisterDagVersionResponse ¶ added in v0.5.4
func ParseRegisterDagVersionResponse(rsp *http.Response) (*RegisterDagVersionResponse, error)
ParseRegisterDagVersionResponse parses an HTTP response from a RegisterDagVersionWithResponse call
func (RegisterDagVersionResponse) ContentType ¶ added in v0.5.4
func (r RegisterDagVersionResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (RegisterDagVersionResponse) GetBody ¶ added in v0.5.4
func (r RegisterDagVersionResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (RegisterDagVersionResponse) GetJSON200 ¶ added in v0.5.4
func (r RegisterDagVersionResponse) GetJSON200() *VersionRegistration
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (RegisterDagVersionResponse) GetJSON201 ¶ added in v0.5.4
func (r RegisterDagVersionResponse) GetJSON201() *VersionRegistration
GetJSON201 returns the response for an HTTP 201 `application/json` response
func (RegisterDagVersionResponse) GetJSON400 ¶ added in v0.5.4
func (r RegisterDagVersionResponse) GetJSON400() *Error
GetJSON400 returns the response for an HTTP 400 `application/json` response
func (RegisterDagVersionResponse) GetJSON401 ¶ added in v0.5.4
func (r RegisterDagVersionResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (RegisterDagVersionResponse) GetJSON403 ¶ added in v0.5.4
func (r RegisterDagVersionResponse) GetJSON403() *Error
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (RegisterDagVersionResponse) GetJSON409 ¶ added in v0.5.4
func (r RegisterDagVersionResponse) GetJSON409() *Error
GetJSON409 returns the response for an HTTP 409 `application/json` response
func (RegisterDagVersionResponse) Status ¶ added in v0.5.4
func (r RegisterDagVersionResponse) Status() string
Status returns HTTPResponse.Status
func (RegisterDagVersionResponse) StatusCode ¶ added in v0.5.4
func (r RegisterDagVersionResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RegisterDagVersionResponse403Headers ¶ added in v0.5.5
type RegisterDagVersionResponse403Headers struct {
DexaflowDeployVia *string
}
RegisterDagVersionResponse403Headers the declared response headers of an HTTP 403 response for RegisterDagVersion
type RenewTokenResponse ¶
type RenewTokenResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *TokenResponse
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
}
func ParseRenewTokenResponse ¶
func ParseRenewTokenResponse(rsp *http.Response) (*RenewTokenResponse, error)
ParseRenewTokenResponse parses an HTTP response from a RenewTokenWithResponse call
func (RenewTokenResponse) ContentType ¶
func (r RenewTokenResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (RenewTokenResponse) GetBody ¶
func (r RenewTokenResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (RenewTokenResponse) GetJSON200 ¶
func (r RenewTokenResponse) GetJSON200() *TokenResponse
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (RenewTokenResponse) GetJSON401 ¶
func (r RenewTokenResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (RenewTokenResponse) Status ¶
func (r RenewTokenResponse) Status() string
Status returns HTTPResponse.Status
func (RenewTokenResponse) StatusCode ¶
func (r RenewTokenResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
func WithDagSourceVersion ¶ added in v0.5.4
func WithDagSourceVersion(n int) RequestEditorFn
WithDagSourceVersion returns a request editor that asks GET /api/v2/dagSources/{dag_id} for the source of the DAG version numbered n (its version_number in the dagVersions listing) instead of the newest one:
c.GetDagSourceWithResponse(ctx, dagID, client.WithDagSourceVersion(n))
The generated GetDagSource does not take the parameter itself, so that its signature stays compatible (see overlay.yaml).
type RevokeAPITokenResponse ¶ added in v0.5.4
type RevokeAPITokenResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *Error
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *NotFound
}
func ParseRevokeAPITokenResponse ¶ added in v0.5.4
func ParseRevokeAPITokenResponse(rsp *http.Response) (*RevokeAPITokenResponse, error)
ParseRevokeAPITokenResponse parses an HTTP response from a RevokeAPITokenWithResponse call
func (RevokeAPITokenResponse) ContentType ¶ added in v0.5.4
func (r RevokeAPITokenResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (RevokeAPITokenResponse) GetBody ¶ added in v0.5.4
func (r RevokeAPITokenResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (RevokeAPITokenResponse) GetJSON401 ¶ added in v0.5.4
func (r RevokeAPITokenResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (RevokeAPITokenResponse) GetJSON403 ¶ added in v0.5.4
func (r RevokeAPITokenResponse) GetJSON403() *Error
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (RevokeAPITokenResponse) GetJSON404 ¶ added in v0.5.4
func (r RevokeAPITokenResponse) GetJSON404() *NotFound
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (RevokeAPITokenResponse) Status ¶ added in v0.5.4
func (r RevokeAPITokenResponse) Status() string
Status returns HTTPResponse.Status
func (RevokeAPITokenResponse) StatusCode ¶ added in v0.5.4
func (r RevokeAPITokenResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SetDagCurrentVersionJSONRequestBody ¶ added in v0.5.4
type SetDagCurrentVersionJSONRequestBody = DagCurrentVersionRequest
SetDagCurrentVersionJSONRequestBody defines body for SetDagCurrentVersion for application/json ContentType.
type SetDagCurrentVersionResponse ¶ added in v0.5.4
type SetDagCurrentVersionResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *DagCurrentVersionChange
// JSON400 the response for an HTTP 400 `application/json` response
JSON400 *Error
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
// JSON403 the response for an HTTP 403 `application/json` response
JSON403 *Error
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *NotFound
// Headers403 the parsed response headers for an HTTP 403 response
Headers403 *SetDagCurrentVersionResponse403Headers
}
func ParseSetDagCurrentVersionResponse ¶ added in v0.5.4
func ParseSetDagCurrentVersionResponse(rsp *http.Response) (*SetDagCurrentVersionResponse, error)
ParseSetDagCurrentVersionResponse parses an HTTP response from a SetDagCurrentVersionWithResponse call
func (SetDagCurrentVersionResponse) ContentType ¶ added in v0.5.4
func (r SetDagCurrentVersionResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (SetDagCurrentVersionResponse) GetBody ¶ added in v0.5.4
func (r SetDagCurrentVersionResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (SetDagCurrentVersionResponse) GetJSON200 ¶ added in v0.5.4
func (r SetDagCurrentVersionResponse) GetJSON200() *DagCurrentVersionChange
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (SetDagCurrentVersionResponse) GetJSON400 ¶ added in v0.5.4
func (r SetDagCurrentVersionResponse) GetJSON400() *Error
GetJSON400 returns the response for an HTTP 400 `application/json` response
func (SetDagCurrentVersionResponse) GetJSON401 ¶ added in v0.5.4
func (r SetDagCurrentVersionResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (SetDagCurrentVersionResponse) GetJSON403 ¶ added in v0.5.4
func (r SetDagCurrentVersionResponse) GetJSON403() *Error
GetJSON403 returns the response for an HTTP 403 `application/json` response
func (SetDagCurrentVersionResponse) GetJSON404 ¶ added in v0.5.4
func (r SetDagCurrentVersionResponse) GetJSON404() *NotFound
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (SetDagCurrentVersionResponse) Status ¶ added in v0.5.4
func (r SetDagCurrentVersionResponse) Status() string
Status returns HTTPResponse.Status
func (SetDagCurrentVersionResponse) StatusCode ¶ added in v0.5.4
func (r SetDagCurrentVersionResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SetDagCurrentVersionResponse403Headers ¶ added in v0.5.5
type SetDagCurrentVersionResponse403Headers struct {
DexaflowDeployVia *string
}
SetDagCurrentVersionResponse403Headers the declared response headers of an HTTP 403 response for SetDagCurrentVersion
type StatusError ¶ added in v0.5.4
type StatusError struct {
// Path is the route that was called.
Path string
// StatusCode is the HTTP status of the answer.
StatusCode int
// Body is the answer's body.
Body []byte
}
StatusError is the answer of a hand-written call when the server answers with a status the call does not expect: the status and the body as served (bounded), so the caller can tell one refusal from another.
func (*StatusError) Error ¶ added in v0.5.4
func (e *StatusError) Error() string
Error names the route and the status.
type TaskExecution ¶ added in v0.5.4
type TaskExecution struct {
Mode TaskExecutionMode `json:"mode"`
// Reason Why the task takes a dedicated pod, absent when warm-eligible: warm pools off, staging enabled, source mode, service_account set, a placement field set (node_selector set, tolerations set, ...), a size larger than a warm pod, no idle warm workers kept for this DAG, or a server that runs no warm workers.
Reason *string `json:"reason,omitempty"`
TaskId string `json:"task_id"`
}
TaskExecution defines model for TaskExecution.
type TaskExecutionMode ¶ added in v0.5.4
type TaskExecutionMode string
TaskExecutionMode defines model for TaskExecution.Mode.
const ( TaskExecutionModeDedicated TaskExecutionMode = "dedicated" TaskExecutionModeWarm TaskExecutionMode = "warm" )
Defines values for TaskExecutionMode.
func (TaskExecutionMode) Valid ¶ added in v0.5.4
func (e TaskExecutionMode) Valid() bool
Valid indicates whether the value is a known member of the TaskExecutionMode enum.
type TaskInstance ¶
type TaskInstance struct {
DagId *string `json:"dag_id,omitempty"`
DagRunId *string `json:"dag_run_id,omitempty"`
Duration *float32 `json:"duration,omitempty"`
EndDate *time.Time `json:"end_date,omitempty"`
// FailureReason Dexaflow extension (not part of the Airflow API). A short, human-readable cause for a terminal failure, recorded by whichever component observed it: the task's own report, the reconciler reading the pod (image pull, OOM, exit code), a reaper declaring the pod or agent lost, or the agent's classification of a failure that happened before it could register. It answers "why did this fail?" for an attempt that streamed no logs because its agent never started. Null when no cause was observed. Best-effort and diagnostic: it carries a classification, never a credential or a raw internal error.
//
// Example: the control plane rejected this pod's projected ServiceAccount token; check the control plane's RBAC for tokenreviews and the configured token audience.
FailureReason *string `json:"failure_reason,omitempty"`
Hostname *string `json:"hostname,omitempty"`
MapIndex *int `json:"map_index,omitempty"`
MaxTries *int `json:"max_tries,omitempty"`
Operator *string `json:"operator,omitempty"`
Pool *string `json:"pool,omitempty"`
StartDate *time.Time `json:"start_date,omitempty"`
State *TaskInstanceState `json:"state,omitempty"`
TaskId *string `json:"task_id,omitempty"`
TryNumber *int `json:"try_number,omitempty"`
}
TaskInstance defines model for TaskInstance.
type TaskInstanceCollection ¶
type TaskInstanceCollection struct {
// NextCursor Cursor of the next page. Present only when the request carried cursor and a next page exists.
NextCursor *string `json:"next_cursor,omitempty"`
// PreviousCursor Cursor of the previous page. Present only when the request carried cursor and the page is not the first.
PreviousCursor *string `json:"previous_cursor,omitempty"`
// RunOnLatestVersionNotApplied Dexaflow-only. The runs a clear with run_on_latest_version keeps on their own version, each with the reason (ADR 0086): only a finished run with no task instance queued or running moves to the current version. The clear still applies to these runs, on their version. Left out when every run moved or the option was not asked, and on every response other than the two clear routes.
RunOnLatestVersionNotApplied *ClearVersionNotApplied `json:"run_on_latest_version_not_applied,omitempty"`
TaskInstances *[]TaskInstance `json:"task_instances,omitempty"`
TotalEntries *int `json:"total_entries,omitempty"`
}
TaskInstanceCollection defines model for TaskInstanceCollection.
type TaskInstanceState ¶
type TaskInstanceState string
TaskInstanceState defines model for TaskInstance.State.
const ( TaskInstanceStateFailed TaskInstanceState = "failed" TaskInstanceStateNone TaskInstanceState = "none" TaskInstanceStateQueued TaskInstanceState = "queued" TaskInstanceStateRemoved TaskInstanceState = "removed" TaskInstanceStateRunning TaskInstanceState = "running" TaskInstanceStateScheduled TaskInstanceState = "scheduled" TaskInstanceStateSkipped TaskInstanceState = "skipped" TaskInstanceStateSuccess TaskInstanceState = "success" TaskInstanceStateUpForRetry TaskInstanceState = "up_for_retry" TaskInstanceStateUpstreamFailed TaskInstanceState = "upstream_failed" )
Defines values for TaskInstanceState.
func (TaskInstanceState) Valid ¶
func (e TaskInstanceState) Valid() bool
Valid indicates whether the value is a known member of the TaskInstanceState enum.
type TaskInstanceStateUpdate ¶ added in v0.5.4
type TaskInstanceStateUpdate struct {
NewState TaskInstanceStateUpdateNewState `json:"new_state"`
}
TaskInstanceStateUpdate defines model for TaskInstanceStateUpdate.
type TaskInstanceStateUpdateNewState ¶ added in v0.5.4
type TaskInstanceStateUpdateNewState string
TaskInstanceStateUpdateNewState defines model for TaskInstanceStateUpdate.NewState.
const ( TaskInstanceStateUpdateNewStateFailed TaskInstanceStateUpdateNewState = "failed" TaskInstanceStateUpdateNewStateSkipped TaskInstanceStateUpdateNewState = "skipped" TaskInstanceStateUpdateNewStateSuccess TaskInstanceStateUpdateNewState = "success" )
Defines values for TaskInstanceStateUpdateNewState.
func (TaskInstanceStateUpdateNewState) Valid ¶ added in v0.5.4
func (e TaskInstanceStateUpdateNewState) Valid() bool
Valid indicates whether the value is a known member of the TaskInstanceStateUpdateNewState enum.
type TaskPodsReport ¶ added in v0.5.5
type TaskPodsReport struct {
// RunAsNonRoot True when task pods refuse an image that runs as root or as a user name rather than a number (executor.run_tasks_as_non_root).
RunAsNonRoot bool `json:"run_as_non_root"`
// ServiceAccounts Each ServiceAccount a task pod of the version would run as (the task's execution.service_account, else executor.task_service_account, else the namespace's default), sorted by name. A dry run looks up at most 8.
ServiceAccounts []TaskServiceAccountCheck `json:"service_accounts"`
}
TaskPodsReport What the version's task pods would run as (Dexaflow), sent by the dry run route only, absent from a register. A server that starts no task pods sends run_as_non_root false and no service account.
type TaskServiceAccountCheck ¶ added in v0.5.5
type TaskServiceAccountCheck struct {
// Detail Why it is unchecked, or why a missing name is not valid.
Detail *string `json:"detail,omitempty"`
// ImagePullSecrets How many imagePullSecrets it carries; sent with state found.
ImagePullSecrets *int `json:"image_pull_secrets,omitempty"`
Name string `json:"name"`
// State One of found, missing or unchecked. found: it exists in the task namespace. missing: it does not, and the pods of these tasks would not be created; when its name is not a valid ServiceAccount name (a DNS-1123 subdomain), it is not looked up and detail says so. unchecked: the server could not look it up (detail says why).
State string `json:"state"`
// Tasks The tasks whose pods run as it.
Tasks []string `json:"tasks"`
}
TaskServiceAccountCheck defines model for TaskServiceAccountCheck.
type TokenRequest ¶
TokenRequest defines model for TokenRequest.
type TokenResponse ¶
type TokenResponse struct {
AccessToken *string `json:"access_token,omitempty"`
// ExpiresIn Example: 3600
ExpiresIn *int `json:"expires_in,omitempty"`
// TokenType Example: bearer
TokenType *string `json:"token_type,omitempty"`
}
TokenResponse defines model for TokenResponse.
type TriggerDagRunJSONRequestBody ¶
type TriggerDagRunJSONRequestBody = DAGRunCreate
TriggerDagRunJSONRequestBody defines body for TriggerDagRun for application/json ContentType.
type TriggerDagRunResponse ¶
type TriggerDagRunResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *DAGRun
}
func ParseTriggerDagRunResponse ¶
func ParseTriggerDagRunResponse(rsp *http.Response) (*TriggerDagRunResponse, error)
ParseTriggerDagRunResponse parses an HTTP response from a TriggerDagRunWithResponse call
func (TriggerDagRunResponse) ContentType ¶
func (r TriggerDagRunResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (TriggerDagRunResponse) GetBody ¶
func (r TriggerDagRunResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (TriggerDagRunResponse) GetJSON200 ¶
func (r TriggerDagRunResponse) GetJSON200() *DAGRun
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (TriggerDagRunResponse) Status ¶
func (r TriggerDagRunResponse) Status() string
Status returns HTTPResponse.Status
func (TriggerDagRunResponse) StatusCode ¶
func (r TriggerDagRunResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateConnectionJSONRequestBody ¶
type UpdateConnectionJSONRequestBody = ConnectionBody
UpdateConnectionJSONRequestBody defines body for UpdateConnection for application/json ContentType.
type UpdateConnectionResponse ¶
type UpdateConnectionResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *Connection
// JSON400 the response for an HTTP 400 `application/json` response
JSON400 *Error
// JSON401 the response for an HTTP 401 `application/json` response
JSON401 *Unauthorized
// JSON404 the response for an HTTP 404 `application/json` response
JSON404 *NotFound
// JSON503 the response for an HTTP 503 `application/json` response
JSON503 *EncryptionUnavailable
}
func ParseUpdateConnectionResponse ¶
func ParseUpdateConnectionResponse(rsp *http.Response) (*UpdateConnectionResponse, error)
ParseUpdateConnectionResponse parses an HTTP response from a UpdateConnectionWithResponse call
func (UpdateConnectionResponse) ContentType ¶
func (r UpdateConnectionResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (UpdateConnectionResponse) GetBody ¶
func (r UpdateConnectionResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (UpdateConnectionResponse) GetJSON200 ¶
func (r UpdateConnectionResponse) GetJSON200() *Connection
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (UpdateConnectionResponse) GetJSON400 ¶
func (r UpdateConnectionResponse) GetJSON400() *Error
GetJSON400 returns the response for an HTTP 400 `application/json` response
func (UpdateConnectionResponse) GetJSON401 ¶
func (r UpdateConnectionResponse) GetJSON401() *Unauthorized
GetJSON401 returns the response for an HTTP 401 `application/json` response
func (UpdateConnectionResponse) GetJSON404 ¶
func (r UpdateConnectionResponse) GetJSON404() *NotFound
GetJSON404 returns the response for an HTTP 404 `application/json` response
func (UpdateConnectionResponse) GetJSON503 ¶
func (r UpdateConnectionResponse) GetJSON503() *EncryptionUnavailable
GetJSON503 returns the response for an HTTP 503 `application/json` response
func (UpdateConnectionResponse) Status ¶
func (r UpdateConnectionResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateConnectionResponse) StatusCode ¶
func (r UpdateConnectionResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type UpdateDagJSONRequestBody ¶
type UpdateDagJSONRequestBody = DAGUpdate
UpdateDagJSONRequestBody defines body for UpdateDag for application/json ContentType.
type UpdateDagResponse ¶
type UpdateDagResponse struct {
Body []byte
HTTPResponse *http.Response
// JSON200 the response for an HTTP 200 `application/json` response
JSON200 *DAG
// JSON400 the response for an HTTP 400 `application/json` response
JSON400 *Error
}
func ParseUpdateDagResponse ¶
func ParseUpdateDagResponse(rsp *http.Response) (*UpdateDagResponse, error)
ParseUpdateDagResponse parses an HTTP response from a UpdateDagWithResponse call
func (UpdateDagResponse) ContentType ¶
func (r UpdateDagResponse) ContentType() string
ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers
func (UpdateDagResponse) GetBody ¶
func (r UpdateDagResponse) GetBody() []byte
GetBody returns the raw response body bytes
func (UpdateDagResponse) GetJSON200 ¶
func (r UpdateDagResponse) GetJSON200() *DAG
GetJSON200 returns the response for an HTTP 200 `application/json` response
func (UpdateDagResponse) GetJSON400 ¶ added in v0.5.3
func (r UpdateDagResponse) GetJSON400() *Error
GetJSON400 returns the response for an HTTP 400 `application/json` response
func (UpdateDagResponse) Status ¶
func (r UpdateDagResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateDagResponse) StatusCode ¶
func (r UpdateDagResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type User ¶
type User struct {
CreatedAt time.Time `json:"created_at"`
Email string `json:"email"`
Id string `json:"id"`
IsActive bool `json:"is_active"`
Roles []string `json:"roles"`
}
User defines model for User.
type UserCollection ¶
type UserCollection struct {
TotalEntries *int `json:"total_entries,omitempty"`
Users *[]UserListItem `json:"users,omitempty"`
}
UserCollection defines model for UserCollection.
type UserListItem ¶
type UserListItem struct {
CreatedAt time.Time `json:"created_at"`
Email string `json:"email"`
Id string `json:"id"`
IsActive bool `json:"is_active"`
Roles []string `json:"roles"`
}
UserListItem One account in the user list. Dexaflow accounts are email-keyed and carry a set of RBAC roles, so this diverges from the Airflow FAB users API (username-keyed with first_name/last_name).
type Variable ¶
type Variable struct {
Description *string `json:"description,omitempty"`
IsEncrypted bool `json:"is_encrypted"`
Key string `json:"key"`
TeamName *string `json:"team_name,omitempty"`
Value string `json:"value"`
// ValueUnreadable Present and true in a listing when the value is encrypted with a secret key the server does not have (for example after a key rotation that dropped the old key). The value is then masked. Reading the variable alone answers 500 with a message naming it.
ValueUnreadable *bool `json:"value_unreadable,omitempty"`
}
Variable An Airflow-style variable. The value is masked server-side when the key looks sensitive (secret/password/token/...).
type VariableBody ¶
type VariableBody struct {
Description *string `json:"description,omitempty"`
Key string `json:"key"`
Value *string `json:"value,omitempty"`
}
VariableBody Variable create/replace payload. value and description are tri-state: omit the key to preserve the stored value, send an empty string to clear it, or send a value to set it. A value equal to the mask `***` for a sensitive-looking key (secret/password/token/...) is treated as "unchanged", so re-submitting a variable read back from GET (whose sensitive value is masked) never overwrites the real value with the mask.
type VariableCollection ¶
type VariableCollection struct {
TotalEntries *int `json:"total_entries,omitempty"`
Variables *[]Variable `json:"variables,omitempty"`
}
VariableCollection defines model for VariableCollection.
type VersionInfo ¶
type VersionInfo struct {
GitVersion *string `json:"git_version,omitempty"`
Version *string `json:"version,omitempty"`
}
VersionInfo defines model for VersionInfo.
type VersionRegistration ¶ added in v0.5.4
type VersionRegistration struct {
// Created False when the content was already registered.
Created *bool `json:"created,omitempty"`
// DagCreated True when this register created the DAG (its first version); false for a new version of an existing DAG.
DagCreated *bool `json:"dag_created,omitempty"`
DagId *string `json:"dag_id,omitempty"`
// DryRun True on an answer of the dry run route: nothing was written, and the other fields say what the register would do. Absent from a register.
DryRun *bool `json:"dry_run,omitempty"`
// Execution Where the version's tasks run (Dexaflow), from the same decision dispatch places an attempt with: on a warm worker of the version (warm pools, ADR 0058) or on a dedicated pod. Sent by the register and its dry run. A task is warm-eligible; it still takes a dedicated pod when no warm worker is free. A task the dispatcher would offer to a warm worker is reported dedicated when no warm worker of its version can exist (no idle worker kept, or a server that runs none).
Execution *ExecutionReport `json:"execution,omitempty"`
// IsPaused The DAG's is_paused after the register.
IsPaused *bool `json:"is_paused,omitempty"`
SpecHash *string `json:"spec_hash,omitempty"`
// TaskPods What the version's task pods would run as (Dexaflow), sent by the dry run route only, absent from a register. A server that starts no task pods sends run_as_non_root false and no service account.
TaskPods *TaskPodsReport `json:"task_pods,omitempty"`
Version *string `json:"version,omitempty"`
// Warnings What the register lets through with a warning (a task that does not fit its size under executor.unit.enforce=warn, an image not pinned by digest under deploy.require_digest=warn). Always sent by the dry run route; sent by a register only when it has a warning to give.
Warnings *[]string `json:"warnings,omitempty"`
}
VersionRegistration defines model for VersionRegistration.
type WarmPoolReport ¶ added in v0.5.4
type WarmPoolReport struct {
// Detail The state in a sentence for a person.
Detail string `json:"detail"`
MaxPoolSize *int `json:"max_pool_size,omitempty"`
MinIdleWorkers *int `json:"min_idle_workers,omitempty"`
// PreviousPool draining for a new version of an existing DAG when this server keeps warm workers; the previous version's idle warm workers, if it has any, are removed, and each busy one once its attempt ends.
PreviousPool *WarmPoolReportPreviousPool `json:"previous_pool,omitempty"`
// State off: warm pools are off. none: this version gets no warm worker (staging, source mode, no idle worker kept, or a server that runs no warm workers: the subprocess executor, or pod dispatch disabled). on: the version keeps min_idle_workers idle warm workers, up to max_pool_size, while it is the DAG's current version; for a DAG that declares min_idle_workers they start at the next reconcile (when a paused DAG is unpaused), else with the version's first run.
State WarmPoolReportState `json:"state"`
}
WarmPoolReport defines model for WarmPoolReport.
type WarmPoolReportPreviousPool ¶ added in v0.5.4
type WarmPoolReportPreviousPool string
WarmPoolReportPreviousPool draining for a new version of an existing DAG when this server keeps warm workers; the previous version's idle warm workers, if it has any, are removed, and each busy one once its attempt ends.
const (
WarmPoolReportPreviousPoolDraining WarmPoolReportPreviousPool = "draining"
)
Defines values for WarmPoolReportPreviousPool.
func (WarmPoolReportPreviousPool) Valid ¶ added in v0.5.4
func (e WarmPoolReportPreviousPool) Valid() bool
Valid indicates whether the value is a known member of the WarmPoolReportPreviousPool enum.
type WarmPoolReportState ¶ added in v0.5.4
type WarmPoolReportState string
WarmPoolReportState off: warm pools are off. none: this version gets no warm worker (staging, source mode, no idle worker kept, or a server that runs no warm workers: the subprocess executor, or pod dispatch disabled). on: the version keeps min_idle_workers idle warm workers, up to max_pool_size, while it is the DAG's current version; for a DAG that declares min_idle_workers they start at the next reconcile (when a paused DAG is unpaused), else with the version's first run.
const ( WarmPoolReportStateNone WarmPoolReportState = "none" WarmPoolReportStateOff WarmPoolReportState = "off" WarmPoolReportStateOn WarmPoolReportState = "on" )
Defines values for WarmPoolReportState.
func (WarmPoolReportState) Valid ¶ added in v0.5.4
func (e WarmPoolReportState) Valid() bool
Valid indicates whether the value is a known member of the WarmPoolReportState enum.
type XComEntry ¶
type XComEntry struct {
DagId *string `json:"dag_id,omitempty"`
DagRunId *string `json:"dag_run_id,omitempty"`
Key *string `json:"key,omitempty"`
TaskId *string `json:"task_id,omitempty"`
Timestamp *time.Time `json:"timestamp,omitempty"`
Value interface{} `json:"value,omitempty"`
}
XComEntry defines model for XComEntry.