Documentation
¶
Overview ¶
SPDX-License-Identifier: GPL-3.0-or-later
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen version v1.9.0 DO NOT EDIT.
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen version v1.9.0 DO NOT EDIT.
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen version v1.9.0 DO NOT EDIT.
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen version v1.9.0 DO NOT EDIT.
Index ¶
- Constants
- func GetSwagger() (swagger *openapi3.T, err error)
- func NewCheckBlenderExePathRequest(server string, body CheckBlenderExePathJSONRequestBody) (*http.Request, error)
- func NewCheckBlenderExePathRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewCheckSharedStoragePathRequest(server string, body CheckSharedStoragePathJSONRequestBody) (*http.Request, error)
- func NewCheckSharedStoragePathRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewCreateWorkerTagRequest(server string, body CreateWorkerTagJSONRequestBody) (*http.Request, error)
- func NewCreateWorkerTagRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewDeleteJobMassRequest(server string, body DeleteJobMassJSONRequestBody) (*http.Request, error)
- func NewDeleteJobMassRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewDeleteJobRequest(server string, jobId string) (*http.Request, error)
- func NewDeleteJobWhatWouldItDoRequest(server string, jobId string) (*http.Request, error)
- func NewDeleteWorkerRequest(server string, workerId string) (*http.Request, error)
- func NewDeleteWorkerTagRequest(server string, tagId string) (*http.Request, error)
- func NewFetchGlobalLastRenderedInfoRequest(server string) (*http.Request, error)
- func NewFetchJobBlocklistRequest(server string, jobId string) (*http.Request, error)
- func NewFetchJobLastRenderedInfoRequest(server string, jobId string) (*http.Request, error)
- func NewFetchJobRequest(server string, jobId string) (*http.Request, error)
- func NewFetchJobTasksRequest(server string, jobId string) (*http.Request, error)
- func NewFetchTaskLogInfoRequest(server string, taskId string) (*http.Request, error)
- func NewFetchTaskLogTailRequest(server string, taskId string) (*http.Request, error)
- func NewFetchTaskRequest(server string, taskId string) (*http.Request, error)
- func NewFetchWorkerRequest(server string, workerId string) (*http.Request, error)
- func NewFetchWorkerSleepScheduleRequest(server string, workerId string) (*http.Request, error)
- func NewFetchWorkerTagRequest(server string, tagId string) (*http.Request, error)
- func NewFetchWorkerTagsRequest(server string) (*http.Request, error)
- func NewFetchWorkersRequest(server string) (*http.Request, error)
- func NewFindBlenderExePathRequest(server string) (*http.Request, error)
- func NewGetConfigurationFileRequest(server string) (*http.Request, error)
- func NewGetConfigurationRequest(server string) (*http.Request, error)
- func NewGetFarmStatusRequest(server string) (*http.Request, error)
- func NewGetJobTypeRequest(server string, typeName string) (*http.Request, error)
- func NewGetJobTypesRequest(server string) (*http.Request, error)
- func NewGetSharedStorageRequest(server string, audience ManagerVariableAudience, platform string) (*http.Request, error)
- func NewGetVariablesRequest(server string, audience ManagerVariableAudience, platform string) (*http.Request, error)
- func NewGetVersionRequest(server string) (*http.Request, error)
- func NewMayWorkerRunRequest(server string, taskId string) (*http.Request, error)
- func NewQueryJobsRequest(server string, body QueryJobsJSONRequestBody) (*http.Request, error)
- func NewQueryJobsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewRegisterWorkerRequest(server string, body RegisterWorkerJSONRequestBody) (*http.Request, error)
- func NewRegisterWorkerRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewRemoveJobBlocklistRequest(server string, jobId string, body RemoveJobBlocklistJSONRequestBody) (*http.Request, error)
- func NewRemoveJobBlocklistRequestWithBody(server string, jobId string, contentType string, body io.Reader) (*http.Request, error)
- func NewRequestWorkerStatusChangeRequest(server string, workerId string, body RequestWorkerStatusChangeJSONRequestBody) (*http.Request, error)
- func NewRequestWorkerStatusChangeRequestWithBody(server string, workerId string, contentType string, body io.Reader) (*http.Request, error)
- func NewSaveSetupAssistantConfigRequest(server string, body SaveSetupAssistantConfigJSONRequestBody) (*http.Request, error)
- func NewSaveSetupAssistantConfigRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewScheduleTaskRequest(server string) (*http.Request, error)
- func NewSetJobPriorityRequest(server string, jobId string, body SetJobPriorityJSONRequestBody) (*http.Request, error)
- func NewSetJobPriorityRequestWithBody(server string, jobId string, contentType string, body io.Reader) (*http.Request, error)
- func NewSetJobStatusRequest(server string, jobId string, body SetJobStatusJSONRequestBody) (*http.Request, error)
- func NewSetJobStatusRequestWithBody(server string, jobId string, contentType string, body io.Reader) (*http.Request, error)
- func NewSetTaskStatusRequest(server string, taskId string, body SetTaskStatusJSONRequestBody) (*http.Request, error)
- func NewSetTaskStatusRequestWithBody(server string, taskId string, contentType string, body io.Reader) (*http.Request, error)
- func NewSetWorkerSleepScheduleRequest(server string, workerId string, body SetWorkerSleepScheduleJSONRequestBody) (*http.Request, error)
- func NewSetWorkerSleepScheduleRequestWithBody(server string, workerId string, contentType string, body io.Reader) (*http.Request, error)
- func NewSetWorkerTagsRequest(server string, workerId string, body SetWorkerTagsJSONRequestBody) (*http.Request, error)
- func NewSetWorkerTagsRequestWithBody(server string, workerId string, contentType string, body io.Reader) (*http.Request, error)
- func NewShamanCheckoutRequest(server string, body ShamanCheckoutJSONRequestBody) (*http.Request, error)
- func NewShamanCheckoutRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewShamanCheckoutRequirementsRequest(server string, body ShamanCheckoutRequirementsJSONRequestBody) (*http.Request, error)
- func NewShamanCheckoutRequirementsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewShamanFileStoreCheckRequest(server string, checksum string, filesize int) (*http.Request, error)
- func NewShamanFileStoreRequestWithBody(server string, checksum string, filesize int, params *ShamanFileStoreParams, ...) (*http.Request, error)
- func NewSignOffRequest(server string) (*http.Request, error)
- func NewSignOnRequest(server string, body SignOnJSONRequestBody) (*http.Request, error)
- func NewSignOnRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewSubmitJobCheckRequest(server string, body SubmitJobCheckJSONRequestBody) (*http.Request, error)
- func NewSubmitJobCheckRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewSubmitJobRequest(server string, body SubmitJobJSONRequestBody) (*http.Request, error)
- func NewSubmitJobRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewTaskOutputProducedRequestWithBody(server string, taskId string, contentType string, body io.Reader) (*http.Request, error)
- func NewTaskUpdateRequest(server string, taskId string, body TaskUpdateJSONRequestBody) (*http.Request, error)
- func NewTaskUpdateRequestWithBody(server string, taskId string, contentType string, body io.Reader) (*http.Request, error)
- func NewUpdateWorkerTagRequest(server string, tagId string, body UpdateWorkerTagJSONRequestBody) (*http.Request, error)
- func NewUpdateWorkerTagRequestWithBody(server string, tagId string, contentType string, body io.Reader) (*http.Request, error)
- func NewWorkerStateChangedRequest(server string, body WorkerStateChangedJSONRequestBody) (*http.Request, error)
- func NewWorkerStateChangedRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewWorkerStateRequest(server string) (*http.Request, error)
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- func RegisterHandlers(router EchoRouter, si ServerInterface)
- func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)
- type AssignedTask
- type AvailableJobSetting
- type AvailableJobSettingSubtype
- type AvailableJobSettingType
- type AvailableJobSettingVisibility
- type AvailableJobType
- type AvailableJobTypes
- type BlenderPathCheckResult
- type BlenderPathFindResult
- type BlenderPathSource
- type CheckBlenderExePathJSONBody
- type CheckBlenderExePathJSONRequestBody
- type CheckBlenderExePathResponse
- type CheckSharedStoragePathJSONBody
- type CheckSharedStoragePathJSONRequestBody
- type CheckSharedStoragePathResponse
- type Client
- func (c *Client) CheckBlenderExePath(ctx context.Context, body CheckBlenderExePathJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) CheckBlenderExePathWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) CheckSharedStoragePath(ctx context.Context, body CheckSharedStoragePathJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) CheckSharedStoragePathWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) CreateWorkerTag(ctx context.Context, body CreateWorkerTagJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) CreateWorkerTagWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) DeleteJob(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) DeleteJobMass(ctx context.Context, body DeleteJobMassJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) DeleteJobMassWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) DeleteJobWhatWouldItDo(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) DeleteWorker(ctx context.Context, workerId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) DeleteWorkerTag(ctx context.Context, tagId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) FetchGlobalLastRenderedInfo(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) FetchJob(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) FetchJobBlocklist(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) FetchJobLastRenderedInfo(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) FetchJobTasks(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) FetchTask(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) FetchTaskLogInfo(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) FetchTaskLogTail(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) FetchWorker(ctx context.Context, workerId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) FetchWorkerSleepSchedule(ctx context.Context, workerId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) FetchWorkerTag(ctx context.Context, tagId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) FetchWorkerTags(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) FetchWorkers(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) FindBlenderExePath(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetConfiguration(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetConfigurationFile(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetFarmStatus(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetJobType(ctx context.Context, typeName string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetJobTypes(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetSharedStorage(ctx context.Context, audience ManagerVariableAudience, platform string, ...) (*http.Response, error)
- func (c *Client) GetVariables(ctx context.Context, audience ManagerVariableAudience, platform string, ...) (*http.Response, error)
- func (c *Client) GetVersion(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) MayWorkerRun(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) QueryJobs(ctx context.Context, body QueryJobsJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) QueryJobsWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) RegisterWorker(ctx context.Context, body RegisterWorkerJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) RegisterWorkerWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) RemoveJobBlocklist(ctx context.Context, jobId string, body RemoveJobBlocklistJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) RemoveJobBlocklistWithBody(ctx context.Context, jobId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) RequestWorkerStatusChange(ctx context.Context, workerId string, ...) (*http.Response, error)
- func (c *Client) RequestWorkerStatusChangeWithBody(ctx context.Context, workerId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) SaveSetupAssistantConfig(ctx context.Context, body SaveSetupAssistantConfigJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) SaveSetupAssistantConfigWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) ScheduleTask(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) SetJobPriority(ctx context.Context, jobId string, body SetJobPriorityJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) SetJobPriorityWithBody(ctx context.Context, jobId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) SetJobStatus(ctx context.Context, jobId string, body SetJobStatusJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) SetJobStatusWithBody(ctx context.Context, jobId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) SetTaskStatus(ctx context.Context, taskId string, body SetTaskStatusJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) SetTaskStatusWithBody(ctx context.Context, taskId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) SetWorkerSleepSchedule(ctx context.Context, workerId string, ...) (*http.Response, error)
- func (c *Client) SetWorkerSleepScheduleWithBody(ctx context.Context, workerId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) SetWorkerTags(ctx context.Context, workerId string, body SetWorkerTagsJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) SetWorkerTagsWithBody(ctx context.Context, workerId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) ShamanCheckout(ctx context.Context, body ShamanCheckoutJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) ShamanCheckoutRequirements(ctx context.Context, body ShamanCheckoutRequirementsJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) ShamanCheckoutRequirementsWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) ShamanCheckoutWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) ShamanFileStoreCheck(ctx context.Context, checksum string, filesize int, ...) (*http.Response, error)
- func (c *Client) ShamanFileStoreWithBody(ctx context.Context, checksum string, filesize int, ...) (*http.Response, error)
- func (c *Client) SignOff(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) SignOn(ctx context.Context, body SignOnJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) SignOnWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) SubmitJob(ctx context.Context, body SubmitJobJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) SubmitJobCheck(ctx context.Context, body SubmitJobCheckJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) SubmitJobCheckWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) SubmitJobWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) TaskOutputProducedWithBody(ctx context.Context, taskId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) TaskUpdate(ctx context.Context, taskId string, body TaskUpdateJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) TaskUpdateWithBody(ctx context.Context, taskId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) UpdateWorkerTag(ctx context.Context, tagId string, body UpdateWorkerTagJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) UpdateWorkerTagWithBody(ctx context.Context, tagId string, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) WorkerState(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) WorkerStateChanged(ctx context.Context, body WorkerStateChangedJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) WorkerStateChangedWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) CheckBlenderExePathWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CheckBlenderExePathResponse, error)
- func (c *ClientWithResponses) CheckBlenderExePathWithResponse(ctx context.Context, body CheckBlenderExePathJSONRequestBody, ...) (*CheckBlenderExePathResponse, error)
- func (c *ClientWithResponses) CheckSharedStoragePathWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CheckSharedStoragePathResponse, error)
- func (c *ClientWithResponses) CheckSharedStoragePathWithResponse(ctx context.Context, body CheckSharedStoragePathJSONRequestBody, ...) (*CheckSharedStoragePathResponse, error)
- func (c *ClientWithResponses) CreateWorkerTagWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*CreateWorkerTagResponse, error)
- func (c *ClientWithResponses) CreateWorkerTagWithResponse(ctx context.Context, body CreateWorkerTagJSONRequestBody, ...) (*CreateWorkerTagResponse, error)
- func (c *ClientWithResponses) DeleteJobMassWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*DeleteJobMassResponse, error)
- func (c *ClientWithResponses) DeleteJobMassWithResponse(ctx context.Context, body DeleteJobMassJSONRequestBody, ...) (*DeleteJobMassResponse, error)
- func (c *ClientWithResponses) DeleteJobWhatWouldItDoWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*DeleteJobWhatWouldItDoResponse, error)
- func (c *ClientWithResponses) DeleteJobWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*DeleteJobResponse, error)
- func (c *ClientWithResponses) DeleteWorkerTagWithResponse(ctx context.Context, tagId string, reqEditors ...RequestEditorFn) (*DeleteWorkerTagResponse, error)
- func (c *ClientWithResponses) DeleteWorkerWithResponse(ctx context.Context, workerId string, reqEditors ...RequestEditorFn) (*DeleteWorkerResponse, error)
- func (c *ClientWithResponses) FetchGlobalLastRenderedInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FetchGlobalLastRenderedInfoResponse, error)
- func (c *ClientWithResponses) FetchJobBlocklistWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*FetchJobBlocklistResponse, error)
- func (c *ClientWithResponses) FetchJobLastRenderedInfoWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*FetchJobLastRenderedInfoResponse, error)
- func (c *ClientWithResponses) FetchJobTasksWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*FetchJobTasksResponse, error)
- func (c *ClientWithResponses) FetchJobWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*FetchJobResponse, error)
- func (c *ClientWithResponses) FetchTaskLogInfoWithResponse(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*FetchTaskLogInfoResponse, error)
- func (c *ClientWithResponses) FetchTaskLogTailWithResponse(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*FetchTaskLogTailResponse, error)
- func (c *ClientWithResponses) FetchTaskWithResponse(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*FetchTaskResponse, error)
- func (c *ClientWithResponses) FetchWorkerSleepScheduleWithResponse(ctx context.Context, workerId string, reqEditors ...RequestEditorFn) (*FetchWorkerSleepScheduleResponse, error)
- func (c *ClientWithResponses) FetchWorkerTagWithResponse(ctx context.Context, tagId string, reqEditors ...RequestEditorFn) (*FetchWorkerTagResponse, error)
- func (c *ClientWithResponses) FetchWorkerTagsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FetchWorkerTagsResponse, error)
- func (c *ClientWithResponses) FetchWorkerWithResponse(ctx context.Context, workerId string, reqEditors ...RequestEditorFn) (*FetchWorkerResponse, error)
- func (c *ClientWithResponses) FetchWorkersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FetchWorkersResponse, error)
- func (c *ClientWithResponses) FindBlenderExePathWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FindBlenderExePathResponse, error)
- func (c *ClientWithResponses) GetConfigurationFileWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetConfigurationFileResponse, error)
- func (c *ClientWithResponses) GetConfigurationWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetConfigurationResponse, error)
- func (c *ClientWithResponses) GetFarmStatusWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetFarmStatusResponse, error)
- func (c *ClientWithResponses) GetJobTypeWithResponse(ctx context.Context, typeName string, reqEditors ...RequestEditorFn) (*GetJobTypeResponse, error)
- func (c *ClientWithResponses) GetJobTypesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetJobTypesResponse, error)
- func (c *ClientWithResponses) GetSharedStorageWithResponse(ctx context.Context, audience ManagerVariableAudience, platform string, ...) (*GetSharedStorageResponse, error)
- func (c *ClientWithResponses) GetVariablesWithResponse(ctx context.Context, audience ManagerVariableAudience, platform string, ...) (*GetVariablesResponse, error)
- func (c *ClientWithResponses) GetVersionWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetVersionResponse, error)
- func (c *ClientWithResponses) MayWorkerRunWithResponse(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*MayWorkerRunResponse, error)
- func (c *ClientWithResponses) QueryJobsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*QueryJobsResponse, error)
- func (c *ClientWithResponses) QueryJobsWithResponse(ctx context.Context, body QueryJobsJSONRequestBody, ...) (*QueryJobsResponse, error)
- func (c *ClientWithResponses) RegisterWorkerWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*RegisterWorkerResponse, error)
- func (c *ClientWithResponses) RegisterWorkerWithResponse(ctx context.Context, body RegisterWorkerJSONRequestBody, ...) (*RegisterWorkerResponse, error)
- func (c *ClientWithResponses) RemoveJobBlocklistWithBodyWithResponse(ctx context.Context, jobId string, contentType string, body io.Reader, ...) (*RemoveJobBlocklistResponse, error)
- func (c *ClientWithResponses) RemoveJobBlocklistWithResponse(ctx context.Context, jobId string, body RemoveJobBlocklistJSONRequestBody, ...) (*RemoveJobBlocklistResponse, error)
- func (c *ClientWithResponses) RequestWorkerStatusChangeWithBodyWithResponse(ctx context.Context, workerId string, contentType string, body io.Reader, ...) (*RequestWorkerStatusChangeResponse, error)
- func (c *ClientWithResponses) RequestWorkerStatusChangeWithResponse(ctx context.Context, workerId string, ...) (*RequestWorkerStatusChangeResponse, error)
- func (c *ClientWithResponses) SaveSetupAssistantConfigWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*SaveSetupAssistantConfigResponse, error)
- func (c *ClientWithResponses) SaveSetupAssistantConfigWithResponse(ctx context.Context, body SaveSetupAssistantConfigJSONRequestBody, ...) (*SaveSetupAssistantConfigResponse, error)
- func (c *ClientWithResponses) ScheduleTaskWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ScheduleTaskResponse, error)
- func (c *ClientWithResponses) SetJobPriorityWithBodyWithResponse(ctx context.Context, jobId string, contentType string, body io.Reader, ...) (*SetJobPriorityResponse, error)
- func (c *ClientWithResponses) SetJobPriorityWithResponse(ctx context.Context, jobId string, body SetJobPriorityJSONRequestBody, ...) (*SetJobPriorityResponse, error)
- func (c *ClientWithResponses) SetJobStatusWithBodyWithResponse(ctx context.Context, jobId string, contentType string, body io.Reader, ...) (*SetJobStatusResponse, error)
- func (c *ClientWithResponses) SetJobStatusWithResponse(ctx context.Context, jobId string, body SetJobStatusJSONRequestBody, ...) (*SetJobStatusResponse, error)
- func (c *ClientWithResponses) SetTaskStatusWithBodyWithResponse(ctx context.Context, taskId string, contentType string, body io.Reader, ...) (*SetTaskStatusResponse, error)
- func (c *ClientWithResponses) SetTaskStatusWithResponse(ctx context.Context, taskId string, body SetTaskStatusJSONRequestBody, ...) (*SetTaskStatusResponse, error)
- func (c *ClientWithResponses) SetWorkerSleepScheduleWithBodyWithResponse(ctx context.Context, workerId string, contentType string, body io.Reader, ...) (*SetWorkerSleepScheduleResponse, error)
- func (c *ClientWithResponses) SetWorkerSleepScheduleWithResponse(ctx context.Context, workerId string, ...) (*SetWorkerSleepScheduleResponse, error)
- func (c *ClientWithResponses) SetWorkerTagsWithBodyWithResponse(ctx context.Context, workerId string, contentType string, body io.Reader, ...) (*SetWorkerTagsResponse, error)
- func (c *ClientWithResponses) SetWorkerTagsWithResponse(ctx context.Context, workerId string, body SetWorkerTagsJSONRequestBody, ...) (*SetWorkerTagsResponse, error)
- func (c *ClientWithResponses) ShamanCheckoutRequirementsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*ShamanCheckoutRequirementsResponse, error)
- func (c *ClientWithResponses) ShamanCheckoutRequirementsWithResponse(ctx context.Context, body ShamanCheckoutRequirementsJSONRequestBody, ...) (*ShamanCheckoutRequirementsResponse, error)
- func (c *ClientWithResponses) ShamanCheckoutWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*ShamanCheckoutResponse, error)
- func (c *ClientWithResponses) ShamanCheckoutWithResponse(ctx context.Context, body ShamanCheckoutJSONRequestBody, ...) (*ShamanCheckoutResponse, error)
- func (c *ClientWithResponses) ShamanFileStoreCheckWithResponse(ctx context.Context, checksum string, filesize int, ...) (*ShamanFileStoreCheckResponse, error)
- func (c *ClientWithResponses) ShamanFileStoreWithBodyWithResponse(ctx context.Context, checksum string, filesize int, ...) (*ShamanFileStoreResponse, error)
- func (c *ClientWithResponses) SignOffWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*SignOffResponse, error)
- func (c *ClientWithResponses) SignOnWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*SignOnResponse, error)
- func (c *ClientWithResponses) SignOnWithResponse(ctx context.Context, body SignOnJSONRequestBody, reqEditors ...RequestEditorFn) (*SignOnResponse, error)
- func (c *ClientWithResponses) SubmitJobCheckWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*SubmitJobCheckResponse, error)
- func (c *ClientWithResponses) SubmitJobCheckWithResponse(ctx context.Context, body SubmitJobCheckJSONRequestBody, ...) (*SubmitJobCheckResponse, error)
- func (c *ClientWithResponses) SubmitJobWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*SubmitJobResponse, error)
- func (c *ClientWithResponses) SubmitJobWithResponse(ctx context.Context, body SubmitJobJSONRequestBody, ...) (*SubmitJobResponse, error)
- func (c *ClientWithResponses) TaskOutputProducedWithBodyWithResponse(ctx context.Context, taskId string, contentType string, body io.Reader, ...) (*TaskOutputProducedResponse, error)
- func (c *ClientWithResponses) TaskUpdateWithBodyWithResponse(ctx context.Context, taskId string, contentType string, body io.Reader, ...) (*TaskUpdateResponse, error)
- func (c *ClientWithResponses) TaskUpdateWithResponse(ctx context.Context, taskId string, body TaskUpdateJSONRequestBody, ...) (*TaskUpdateResponse, error)
- func (c *ClientWithResponses) UpdateWorkerTagWithBodyWithResponse(ctx context.Context, tagId string, contentType string, body io.Reader, ...) (*UpdateWorkerTagResponse, error)
- func (c *ClientWithResponses) UpdateWorkerTagWithResponse(ctx context.Context, tagId string, body UpdateWorkerTagJSONRequestBody, ...) (*UpdateWorkerTagResponse, error)
- func (c *ClientWithResponses) WorkerStateChangedWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*WorkerStateChangedResponse, error)
- func (c *ClientWithResponses) WorkerStateChangedWithResponse(ctx context.Context, body WorkerStateChangedJSONRequestBody, ...) (*WorkerStateChangedResponse, error)
- func (c *ClientWithResponses) WorkerStateWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*WorkerStateResponse, error)
- type ClientWithResponsesInterface
- type Command
- type CreateWorkerTagJSONBody
- type CreateWorkerTagJSONRequestBody
- type CreateWorkerTagResponse
- type DeleteJobMassJSONBody
- type DeleteJobMassJSONRequestBody
- type DeleteJobMassResponse
- type DeleteJobResponse
- type DeleteJobWhatWouldItDoResponse
- type DeleteWorkerResponse
- type DeleteWorkerTagResponse
- type EchoRouter
- type Error
- type EventFarmStatus
- type EventJobUpdate
- type EventLastRenderedUpdate
- type EventLifeCycle
- type EventTaskLogUpdate
- type EventTaskUpdate
- type EventWorkerTagUpdate
- type EventWorkerUpdate
- type FarmStatus
- type FarmStatusReport
- type FetchGlobalLastRenderedInfoResponse
- type FetchJobBlocklistResponse
- type FetchJobLastRenderedInfoResponse
- type FetchJobResponse
- type FetchJobTasksResponse
- type FetchTaskLogInfoResponse
- type FetchTaskLogTailResponse
- type FetchTaskResponse
- type FetchWorkerResponse
- type FetchWorkerSleepScheduleResponse
- type FetchWorkerTagResponse
- type FetchWorkerTagsResponse
- type FetchWorkersResponse
- type FindBlenderExePathResponse
- type FlamencoVersion
- type GetConfigurationFileResponse
- type GetConfigurationResponse
- type GetFarmStatusResponse
- type GetJobTypeResponse
- type GetJobTypesResponse
- type GetSharedStorageResponse
- type GetVariablesResponse
- type GetVersionResponse
- type HttpRequestDoer
- type Job
- type JobBlocklist
- type JobBlocklistEntry
- type JobDeletionInfo
- type JobLastRenderedImageInfo
- type JobMassDeletionSelection
- type JobMetadata
- type JobPriorityChange
- type JobSettings
- type JobStatus
- type JobStatusChange
- type JobStorageInfo
- type JobTasksSummary
- type JobsQuery
- type JobsQueryResult
- type JobsQuery_Metadata
- type JobsQuery_Settings
- type LifeCycleEventType
- type ManagerConfiguration
- type ManagerVariable
- type ManagerVariableAudience
- type ManagerVariables
- type MayKeepRunning
- type MayWorkerRunResponse
- type PathCheckInput
- type PathCheckResult
- type QueryJobsJSONBody
- type QueryJobsJSONRequestBody
- type QueryJobsResponse
- type RegisterWorkerJSONBody
- type RegisterWorkerJSONRequestBody
- type RegisterWorkerResponse
- type RegisteredWorker
- type RemoveJobBlocklistJSONBody
- type RemoveJobBlocklistJSONRequestBody
- type RemoveJobBlocklistResponse
- type RequestEditorFn
- type RequestWorkerStatusChangeJSONBody
- type RequestWorkerStatusChangeJSONRequestBody
- type RequestWorkerStatusChangeResponse
- type SaveSetupAssistantConfigJSONBody
- type SaveSetupAssistantConfigJSONRequestBody
- type SaveSetupAssistantConfigResponse
- type ScheduleTaskResponse
- type SecurityError
- type ServerInterface
- type ServerInterfaceWrapper
- func (w *ServerInterfaceWrapper) CheckBlenderExePath(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) CheckSharedStoragePath(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) CreateWorkerTag(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) DeleteJob(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) DeleteJobMass(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) DeleteJobWhatWouldItDo(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) DeleteWorker(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) DeleteWorkerTag(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) FetchGlobalLastRenderedInfo(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) FetchJob(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) FetchJobBlocklist(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) FetchJobLastRenderedInfo(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) FetchJobTasks(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) FetchTask(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) FetchTaskLogInfo(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) FetchTaskLogTail(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) FetchWorker(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) FetchWorkerSleepSchedule(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) FetchWorkerTag(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) FetchWorkerTags(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) FetchWorkers(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) FindBlenderExePath(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetConfiguration(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetConfigurationFile(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetFarmStatus(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetJobType(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetJobTypes(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetSharedStorage(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetVariables(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetVersion(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) MayWorkerRun(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) QueryJobs(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) RegisterWorker(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) RemoveJobBlocklist(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) RequestWorkerStatusChange(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) SaveSetupAssistantConfig(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) ScheduleTask(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) SetJobPriority(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) SetJobStatus(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) SetTaskStatus(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) SetWorkerSleepSchedule(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) SetWorkerTags(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) ShamanCheckout(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) ShamanCheckoutRequirements(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) ShamanFileStore(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) ShamanFileStoreCheck(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) SignOff(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) SignOn(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) SubmitJob(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) SubmitJobCheck(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) TaskOutputProduced(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) TaskUpdate(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) UpdateWorkerTag(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) WorkerState(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) WorkerStateChanged(ctx echo.Context) error
- type SetJobPriorityJSONBody
- type SetJobPriorityJSONRequestBody
- type SetJobPriorityResponse
- type SetJobStatusJSONBody
- type SetJobStatusJSONRequestBody
- type SetJobStatusResponse
- type SetTaskStatusJSONBody
- type SetTaskStatusJSONRequestBody
- type SetTaskStatusResponse
- type SetWorkerSleepScheduleJSONBody
- type SetWorkerSleepScheduleJSONRequestBody
- type SetWorkerSleepScheduleResponse
- type SetWorkerTagsJSONBody
- type SetWorkerTagsJSONRequestBody
- type SetWorkerTagsResponse
- type SetupAssistantConfig
- type ShamanCheckout
- type ShamanCheckoutJSONBody
- type ShamanCheckoutJSONRequestBody
- type ShamanCheckoutRequirementsJSONBody
- type ShamanCheckoutRequirementsJSONRequestBody
- type ShamanCheckoutRequirementsResponse
- type ShamanCheckoutResponse
- type ShamanCheckoutResult
- type ShamanFileSpec
- type ShamanFileSpecWithStatus
- type ShamanFileStatus
- type ShamanFileStoreCheckResponse
- type ShamanFileStoreParams
- type ShamanFileStoreResponse
- type ShamanRequirementsRequest
- type ShamanRequirementsResponse
- type ShamanSingleFileStatus
- type SharedStorageLocation
- type SignOffResponse
- type SignOnJSONBody
- type SignOnJSONRequestBody
- type SignOnResponse
- type SocketIOSubscription
- type SocketIOSubscriptionOperation
- type SocketIOSubscriptionType
- type SubmitJobCheckJSONBody
- type SubmitJobCheckJSONRequestBody
- type SubmitJobCheckResponse
- type SubmitJobJSONBody
- type SubmitJobJSONRequestBody
- type SubmitJobResponse
- type SubmittedJob
- type Task
- type TaskLogInfo
- type TaskOutputProducedResponse
- type TaskStatus
- type TaskStatusChange
- type TaskSummary
- type TaskUpdate
- type TaskUpdateJSONBody
- type TaskUpdateJSONRequestBody
- type TaskUpdateResponse
- type TaskWorker
- type UpdateWorkerTagJSONBody
- type UpdateWorkerTagJSONRequestBody
- type UpdateWorkerTagResponse
- type Worker
- type WorkerList
- type WorkerRegistration
- type WorkerSignOn
- type WorkerSleepSchedule
- type WorkerStateChange
- type WorkerStateChanged
- type WorkerStateChangedJSONBody
- type WorkerStateChangedJSONRequestBody
- type WorkerStateChangedResponse
- type WorkerStateResponse
- type WorkerStatus
- type WorkerStatusChangeRequest
- type WorkerSummary
- type WorkerTag
- type WorkerTagChangeRequest
- type WorkerTagList
- type WorkerTask
Constants ¶
View Source
const (
Worker_authScopes = "worker_auth.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func GetSwagger ¶
GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.
func NewCheckBlenderExePathRequest ¶
func NewCheckBlenderExePathRequest(server string, body CheckBlenderExePathJSONRequestBody) (*http.Request, error)
NewCheckBlenderExePathRequest calls the generic CheckBlenderExePath builder with application/json body
func NewCheckBlenderExePathRequestWithBody ¶
func NewCheckBlenderExePathRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewCheckBlenderExePathRequestWithBody generates requests for CheckBlenderExePath with any type of body
func NewCheckSharedStoragePathRequest ¶
func NewCheckSharedStoragePathRequest(server string, body CheckSharedStoragePathJSONRequestBody) (*http.Request, error)
NewCheckSharedStoragePathRequest calls the generic CheckSharedStoragePath builder with application/json body
func NewCheckSharedStoragePathRequestWithBody ¶
func NewCheckSharedStoragePathRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewCheckSharedStoragePathRequestWithBody generates requests for CheckSharedStoragePath with any type of body
func NewCreateWorkerTagRequest ¶
func NewCreateWorkerTagRequest(server string, body CreateWorkerTagJSONRequestBody) (*http.Request, error)
NewCreateWorkerTagRequest calls the generic CreateWorkerTag builder with application/json body
func NewCreateWorkerTagRequestWithBody ¶
func NewCreateWorkerTagRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewCreateWorkerTagRequestWithBody generates requests for CreateWorkerTag with any type of body
func NewDeleteJobMassRequest ¶
func NewDeleteJobMassRequest(server string, body DeleteJobMassJSONRequestBody) (*http.Request, error)
NewDeleteJobMassRequest calls the generic DeleteJobMass builder with application/json body
func NewDeleteJobMassRequestWithBody ¶
func NewDeleteJobMassRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewDeleteJobMassRequestWithBody generates requests for DeleteJobMass with any type of body
func NewDeleteJobRequest ¶
NewDeleteJobRequest generates requests for DeleteJob
func NewDeleteJobWhatWouldItDoRequest ¶
NewDeleteJobWhatWouldItDoRequest generates requests for DeleteJobWhatWouldItDo
func NewDeleteWorkerRequest ¶
NewDeleteWorkerRequest generates requests for DeleteWorker
func NewDeleteWorkerTagRequest ¶
NewDeleteWorkerTagRequest generates requests for DeleteWorkerTag
func NewFetchGlobalLastRenderedInfoRequest ¶
NewFetchGlobalLastRenderedInfoRequest generates requests for FetchGlobalLastRenderedInfo
func NewFetchJobBlocklistRequest ¶
NewFetchJobBlocklistRequest generates requests for FetchJobBlocklist
func NewFetchJobLastRenderedInfoRequest ¶
NewFetchJobLastRenderedInfoRequest generates requests for FetchJobLastRenderedInfo
func NewFetchJobRequest ¶
NewFetchJobRequest generates requests for FetchJob
func NewFetchJobTasksRequest ¶
NewFetchJobTasksRequest generates requests for FetchJobTasks
func NewFetchTaskLogInfoRequest ¶
NewFetchTaskLogInfoRequest generates requests for FetchTaskLogInfo
func NewFetchTaskLogTailRequest ¶
NewFetchTaskLogTailRequest generates requests for FetchTaskLogTail
func NewFetchTaskRequest ¶
NewFetchTaskRequest generates requests for FetchTask
func NewFetchWorkerRequest ¶
NewFetchWorkerRequest generates requests for FetchWorker
func NewFetchWorkerSleepScheduleRequest ¶
NewFetchWorkerSleepScheduleRequest generates requests for FetchWorkerSleepSchedule
func NewFetchWorkerTagRequest ¶
NewFetchWorkerTagRequest generates requests for FetchWorkerTag
func NewFetchWorkerTagsRequest ¶
NewFetchWorkerTagsRequest generates requests for FetchWorkerTags
func NewFetchWorkersRequest ¶
NewFetchWorkersRequest generates requests for FetchWorkers
func NewFindBlenderExePathRequest ¶
NewFindBlenderExePathRequest generates requests for FindBlenderExePath
func NewGetConfigurationFileRequest ¶
NewGetConfigurationFileRequest generates requests for GetConfigurationFile
func NewGetConfigurationRequest ¶
NewGetConfigurationRequest generates requests for GetConfiguration
func NewGetFarmStatusRequest ¶
NewGetFarmStatusRequest generates requests for GetFarmStatus
func NewGetJobTypeRequest ¶
NewGetJobTypeRequest generates requests for GetJobType
func NewGetJobTypesRequest ¶
NewGetJobTypesRequest generates requests for GetJobTypes
func NewGetSharedStorageRequest ¶
func NewGetSharedStorageRequest(server string, audience ManagerVariableAudience, platform string) (*http.Request, error)
NewGetSharedStorageRequest generates requests for GetSharedStorage
func NewGetVariablesRequest ¶
func NewGetVariablesRequest(server string, audience ManagerVariableAudience, platform string) (*http.Request, error)
NewGetVariablesRequest generates requests for GetVariables
func NewGetVersionRequest ¶
NewGetVersionRequest generates requests for GetVersion
func NewMayWorkerRunRequest ¶
NewMayWorkerRunRequest generates requests for MayWorkerRun
func NewQueryJobsRequest ¶
func NewQueryJobsRequest(server string, body QueryJobsJSONRequestBody) (*http.Request, error)
NewQueryJobsRequest calls the generic QueryJobs builder with application/json body
func NewQueryJobsRequestWithBody ¶
func NewQueryJobsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewQueryJobsRequestWithBody generates requests for QueryJobs with any type of body
func NewRegisterWorkerRequest ¶
func NewRegisterWorkerRequest(server string, body RegisterWorkerJSONRequestBody) (*http.Request, error)
NewRegisterWorkerRequest calls the generic RegisterWorker builder with application/json body
func NewRegisterWorkerRequestWithBody ¶
func NewRegisterWorkerRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewRegisterWorkerRequestWithBody generates requests for RegisterWorker with any type of body
func NewRemoveJobBlocklistRequest ¶
func NewRemoveJobBlocklistRequest(server string, jobId string, body RemoveJobBlocklistJSONRequestBody) (*http.Request, error)
NewRemoveJobBlocklistRequest calls the generic RemoveJobBlocklist builder with application/json body
func NewRemoveJobBlocklistRequestWithBody ¶
func NewRemoveJobBlocklistRequestWithBody(server string, jobId string, contentType string, body io.Reader) (*http.Request, error)
NewRemoveJobBlocklistRequestWithBody generates requests for RemoveJobBlocklist with any type of body
func NewRequestWorkerStatusChangeRequest ¶
func NewRequestWorkerStatusChangeRequest(server string, workerId string, body RequestWorkerStatusChangeJSONRequestBody) (*http.Request, error)
NewRequestWorkerStatusChangeRequest calls the generic RequestWorkerStatusChange builder with application/json body
func NewRequestWorkerStatusChangeRequestWithBody ¶
func NewRequestWorkerStatusChangeRequestWithBody(server string, workerId string, contentType string, body io.Reader) (*http.Request, error)
NewRequestWorkerStatusChangeRequestWithBody generates requests for RequestWorkerStatusChange with any type of body
func NewSaveSetupAssistantConfigRequest ¶
func NewSaveSetupAssistantConfigRequest(server string, body SaveSetupAssistantConfigJSONRequestBody) (*http.Request, error)
NewSaveSetupAssistantConfigRequest calls the generic SaveSetupAssistantConfig builder with application/json body
func NewSaveSetupAssistantConfigRequestWithBody ¶
func NewSaveSetupAssistantConfigRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewSaveSetupAssistantConfigRequestWithBody generates requests for SaveSetupAssistantConfig with any type of body
func NewScheduleTaskRequest ¶
NewScheduleTaskRequest generates requests for ScheduleTask
func NewSetJobPriorityRequest ¶
func NewSetJobPriorityRequest(server string, jobId string, body SetJobPriorityJSONRequestBody) (*http.Request, error)
NewSetJobPriorityRequest calls the generic SetJobPriority builder with application/json body
func NewSetJobPriorityRequestWithBody ¶
func NewSetJobPriorityRequestWithBody(server string, jobId string, contentType string, body io.Reader) (*http.Request, error)
NewSetJobPriorityRequestWithBody generates requests for SetJobPriority with any type of body
func NewSetJobStatusRequest ¶
func NewSetJobStatusRequest(server string, jobId string, body SetJobStatusJSONRequestBody) (*http.Request, error)
NewSetJobStatusRequest calls the generic SetJobStatus builder with application/json body
func NewSetJobStatusRequestWithBody ¶
func NewSetJobStatusRequestWithBody(server string, jobId string, contentType string, body io.Reader) (*http.Request, error)
NewSetJobStatusRequestWithBody generates requests for SetJobStatus with any type of body
func NewSetTaskStatusRequest ¶
func NewSetTaskStatusRequest(server string, taskId string, body SetTaskStatusJSONRequestBody) (*http.Request, error)
NewSetTaskStatusRequest calls the generic SetTaskStatus builder with application/json body
func NewSetTaskStatusRequestWithBody ¶
func NewSetTaskStatusRequestWithBody(server string, taskId string, contentType string, body io.Reader) (*http.Request, error)
NewSetTaskStatusRequestWithBody generates requests for SetTaskStatus with any type of body
func NewSetWorkerSleepScheduleRequest ¶
func NewSetWorkerSleepScheduleRequest(server string, workerId string, body SetWorkerSleepScheduleJSONRequestBody) (*http.Request, error)
NewSetWorkerSleepScheduleRequest calls the generic SetWorkerSleepSchedule builder with application/json body
func NewSetWorkerSleepScheduleRequestWithBody ¶
func NewSetWorkerSleepScheduleRequestWithBody(server string, workerId string, contentType string, body io.Reader) (*http.Request, error)
NewSetWorkerSleepScheduleRequestWithBody generates requests for SetWorkerSleepSchedule with any type of body
func NewSetWorkerTagsRequest ¶
func NewSetWorkerTagsRequest(server string, workerId string, body SetWorkerTagsJSONRequestBody) (*http.Request, error)
NewSetWorkerTagsRequest calls the generic SetWorkerTags builder with application/json body
func NewSetWorkerTagsRequestWithBody ¶
func NewSetWorkerTagsRequestWithBody(server string, workerId string, contentType string, body io.Reader) (*http.Request, error)
NewSetWorkerTagsRequestWithBody generates requests for SetWorkerTags with any type of body
func NewShamanCheckoutRequest ¶
func NewShamanCheckoutRequest(server string, body ShamanCheckoutJSONRequestBody) (*http.Request, error)
NewShamanCheckoutRequest calls the generic ShamanCheckout builder with application/json body
func NewShamanCheckoutRequestWithBody ¶
func NewShamanCheckoutRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewShamanCheckoutRequestWithBody generates requests for ShamanCheckout with any type of body
func NewShamanCheckoutRequirementsRequest ¶
func NewShamanCheckoutRequirementsRequest(server string, body ShamanCheckoutRequirementsJSONRequestBody) (*http.Request, error)
NewShamanCheckoutRequirementsRequest calls the generic ShamanCheckoutRequirements builder with application/json body
func NewShamanCheckoutRequirementsRequestWithBody ¶
func NewShamanCheckoutRequirementsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewShamanCheckoutRequirementsRequestWithBody generates requests for ShamanCheckoutRequirements with any type of body
func NewShamanFileStoreCheckRequest ¶
func NewShamanFileStoreCheckRequest(server string, checksum string, filesize int) (*http.Request, error)
NewShamanFileStoreCheckRequest generates requests for ShamanFileStoreCheck
func NewShamanFileStoreRequestWithBody ¶
func NewShamanFileStoreRequestWithBody(server string, checksum string, filesize int, params *ShamanFileStoreParams, contentType string, body io.Reader) (*http.Request, error)
NewShamanFileStoreRequestWithBody generates requests for ShamanFileStore with any type of body
func NewSignOffRequest ¶
NewSignOffRequest generates requests for SignOff
func NewSignOnRequest ¶
func NewSignOnRequest(server string, body SignOnJSONRequestBody) (*http.Request, error)
NewSignOnRequest calls the generic SignOn builder with application/json body
func NewSignOnRequestWithBody ¶
func NewSignOnRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewSignOnRequestWithBody generates requests for SignOn with any type of body
func NewSubmitJobCheckRequest ¶
func NewSubmitJobCheckRequest(server string, body SubmitJobCheckJSONRequestBody) (*http.Request, error)
NewSubmitJobCheckRequest calls the generic SubmitJobCheck builder with application/json body
func NewSubmitJobCheckRequestWithBody ¶
func NewSubmitJobCheckRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewSubmitJobCheckRequestWithBody generates requests for SubmitJobCheck with any type of body
func NewSubmitJobRequest ¶
func NewSubmitJobRequest(server string, body SubmitJobJSONRequestBody) (*http.Request, error)
NewSubmitJobRequest calls the generic SubmitJob builder with application/json body
func NewSubmitJobRequestWithBody ¶
func NewSubmitJobRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewSubmitJobRequestWithBody generates requests for SubmitJob with any type of body
func NewTaskOutputProducedRequestWithBody ¶
func NewTaskOutputProducedRequestWithBody(server string, taskId string, contentType string, body io.Reader) (*http.Request, error)
NewTaskOutputProducedRequestWithBody generates requests for TaskOutputProduced with any type of body
func NewTaskUpdateRequest ¶
func NewTaskUpdateRequest(server string, taskId string, body TaskUpdateJSONRequestBody) (*http.Request, error)
NewTaskUpdateRequest calls the generic TaskUpdate builder with application/json body
func NewTaskUpdateRequestWithBody ¶
func NewTaskUpdateRequestWithBody(server string, taskId string, contentType string, body io.Reader) (*http.Request, error)
NewTaskUpdateRequestWithBody generates requests for TaskUpdate with any type of body
func NewUpdateWorkerTagRequest ¶
func NewUpdateWorkerTagRequest(server string, tagId string, body UpdateWorkerTagJSONRequestBody) (*http.Request, error)
NewUpdateWorkerTagRequest calls the generic UpdateWorkerTag builder with application/json body
func NewUpdateWorkerTagRequestWithBody ¶
func NewUpdateWorkerTagRequestWithBody(server string, tagId string, contentType string, body io.Reader) (*http.Request, error)
NewUpdateWorkerTagRequestWithBody generates requests for UpdateWorkerTag with any type of body
func NewWorkerStateChangedRequest ¶
func NewWorkerStateChangedRequest(server string, body WorkerStateChangedJSONRequestBody) (*http.Request, error)
NewWorkerStateChangedRequest calls the generic WorkerStateChanged builder with application/json body
func NewWorkerStateChangedRequestWithBody ¶
func NewWorkerStateChangedRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewWorkerStateChangedRequestWithBody generates requests for WorkerStateChanged with any type of body
func NewWorkerStateRequest ¶
NewWorkerStateRequest generates requests for WorkerState
func PathToRawSpec ¶
Constructs a synthetic filesystem for resolving external references when loading openapi specifications.
func RegisterHandlers ¶
func RegisterHandlers(router EchoRouter, si ServerInterface)
RegisterHandlers adds each server route to the EchoRouter.
func RegisterHandlersWithBaseURL ¶
func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)
Registers handlers, and prepends BaseURL to the paths, so that the paths can be served under a prefix.
Types ¶
type AssignedTask ¶
type AssignedTask struct {
Commands []Command `json:"commands"`
Job string `json:"job"`
JobPriority int `json:"job_priority"`
JobType string `json:"job_type"`
Name string `json:"name"`
Priority int `json:"priority"`
Status TaskStatus `json:"status"`
TaskType string `json:"task_type"`
Uuid string `json:"uuid"`
}
AssignedTask is a task as it is received by the Worker.
type AvailableJobSetting ¶
type AvailableJobSetting struct {
// When given, limit the valid values to these choices. Only usable with string type.
Choices *[]string `json:"choices,omitempty"`
// The default value shown to the user when determining this setting.
Default *interface{} `json:"default,omitempty"`
// The description/tooltip shown in the user interface.
Description *interface{} `json:"description,omitempty"`
// Whether to allow editing this setting after the job has been submitted. Would imply deleting all existing tasks for this job, and recompiling it.
Editable *bool `json:"editable,omitempty"`
// Python expression to be evaluated in order to determine the default value for this setting.
Eval *string `json:"eval,omitempty"`
// Meta-data for the 'eval' expression.
EvalInfo *struct {
// Description of what the 'eval' expression is doing. It is also used as placeholder text to show when the manual input field is hidden (because eval-on-submit has been toggled on by the user).
Description string `json:"description"`
// Enables the 'eval on submit' toggle button behavior for this setting. A toggle button will be shown in Blender's submission interface. When toggled on, the `eval` expression will determine the setting's value. Manually editing the setting is then no longer possible, and instead of an input field, the 'description' string is shown.
// An example use is the to-be-rendered frame range, which by default automatically follows the scene range, but can be overridden manually when desired.
ShowLinkButton bool `json:"showLinkButton"`
} `json:"evalInfo,omitempty"`
// Identifier for the setting, must be unique within the job type.
Key string `json:"key"`
// Label for displaying this setting. If not specified, the key is used to generate a reasonable label.
Label *interface{} `json:"label,omitempty"`
// Any extra arguments to the bpy.props.SomeProperty() call used to create this property.
Propargs *map[string]interface{} `json:"propargs,omitempty"`
// Whether to immediately reject a job definition, of this type, without this particular setting.
Required *bool `json:"required,omitempty"`
// Sub-type of the job setting. Currently only available for string types. `HASHED_FILE_PATH` is a directory path + `"/######"` appended.
Subtype *AvailableJobSettingSubtype `json:"subtype,omitempty"`
// Type of job setting, must be usable as IDProperty type in Blender. No nested structures (arrays, dictionaries) are supported.
Type AvailableJobSettingType `json:"type"`
// When to show this setting. `visible`: always show. `submission`: only show in the UI of a job submitter (like a Blender add-on). `web`: only show in the web interface for management, but not when submitting the job. `hidden`: never show; only available to the job compiler script as internal setting.
Visible *AvailableJobSettingVisibility `json:"visible,omitempty"`
}
Single setting of a Job types.
type AvailableJobSettingSubtype ¶
type AvailableJobSettingSubtype string
Sub-type of the job setting. Currently only available for string types. `HASHED_FILE_PATH` is a directory path + `"/######"` appended.
const ( AvailableJobSettingSubtypeDirPath AvailableJobSettingSubtype = "dir_path" AvailableJobSettingSubtypeFileName AvailableJobSettingSubtype = "file_name" AvailableJobSettingSubtypeFilePath AvailableJobSettingSubtype = "file_path" AvailableJobSettingSubtypeHashedFilePath AvailableJobSettingSubtype = "hashed_file_path" )
Defines values for AvailableJobSettingSubtype.
type AvailableJobSettingType ¶
type AvailableJobSettingType string
Type of job setting, must be usable as IDProperty type in Blender. No nested structures (arrays, dictionaries) are supported.
const ( AvailableJobSettingTypeBool AvailableJobSettingType = "bool" AvailableJobSettingTypeFloat AvailableJobSettingType = "float" AvailableJobSettingTypeInt32 AvailableJobSettingType = "int32" AvailableJobSettingTypeString AvailableJobSettingType = "string" )
Defines values for AvailableJobSettingType.
type AvailableJobSettingVisibility ¶
type AvailableJobSettingVisibility string
When to show this setting. `visible`: always show. `submission`: only show in the UI of a job submitter (like a Blender add-on). `web`: only show in the web interface for management, but not when submitting the job. `hidden`: never show; only available to the job compiler script as internal setting.
const ( AvailableJobSettingVisibilityHidden AvailableJobSettingVisibility = "hidden" AvailableJobSettingVisibilitySubmission AvailableJobSettingVisibility = "submission" AvailableJobSettingVisibilityVisible AvailableJobSettingVisibility = "visible" AvailableJobSettingVisibilityWeb AvailableJobSettingVisibility = "web" )
Defines values for AvailableJobSettingVisibility.
type AvailableJobType ¶
type AvailableJobType struct {
// The description/tooltip shown in the user interface.
Description *string `json:"description,omitempty"`
// Hash of the job type. If the job settings or the label change, this etag will change. This is used on job submission to ensure that the submitted job settings are up to date.
Etag string `json:"etag"`
Label string `json:"label"`
Name string `json:"name"`
Settings []AvailableJobSetting `json:"settings"`
}
Job type supported by this Manager, and its parameters.
type AvailableJobTypes ¶
type AvailableJobTypes struct {
JobTypes []AvailableJobType `json:"job_types"`
}
List of job types supported by this Manager.
type BlenderPathCheckResult ¶
type BlenderPathCheckResult struct {
// Description of why this path is (not) usable.
Cause string `json:"cause"`
// The input that was given to find this Blender.
Input string `json:"input"`
// Whether the path is usable or not.
IsUsable bool `json:"is_usable"`
// The path that was found.
Path string `json:"path"`
Source BlenderPathSource `json:"source"`
}
BlenderPathCheckResult defines model for BlenderPathCheckResult.
type BlenderPathFindResult ¶
type BlenderPathFindResult []BlenderPathCheckResult
BlenderPathFindResult defines model for BlenderPathFindResult.
type BlenderPathSource ¶
type BlenderPathSource string
BlenderPathSource defines model for BlenderPathSource.
const ( BlenderPathSourceFileAssociation BlenderPathSource = "file_association" BlenderPathSourceInputPath BlenderPathSource = "input_path" BlenderPathSourcePathEnvvar BlenderPathSource = "path_envvar" )
Defines values for BlenderPathSource.
type CheckBlenderExePathJSONBody ¶
type CheckBlenderExePathJSONBody PathCheckInput
CheckBlenderExePathJSONBody defines parameters for CheckBlenderExePath.
type CheckBlenderExePathJSONRequestBody ¶
type CheckBlenderExePathJSONRequestBody CheckBlenderExePathJSONBody
CheckBlenderExePathJSONRequestBody defines body for CheckBlenderExePath for application/json ContentType.
type CheckBlenderExePathResponse ¶
type CheckBlenderExePathResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *BlenderPathCheckResult
JSONDefault *Error
}
func ParseCheckBlenderExePathResponse ¶
func ParseCheckBlenderExePathResponse(rsp *http.Response) (*CheckBlenderExePathResponse, error)
ParseCheckBlenderExePathResponse parses an HTTP response from a CheckBlenderExePathWithResponse call
func (CheckBlenderExePathResponse) Status ¶
func (r CheckBlenderExePathResponse) Status() string
Status returns HTTPResponse.Status
func (CheckBlenderExePathResponse) StatusCode ¶
func (r CheckBlenderExePathResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CheckSharedStoragePathJSONBody ¶
type CheckSharedStoragePathJSONBody PathCheckInput
CheckSharedStoragePathJSONBody defines parameters for CheckSharedStoragePath.
type CheckSharedStoragePathJSONRequestBody ¶
type CheckSharedStoragePathJSONRequestBody CheckSharedStoragePathJSONBody
CheckSharedStoragePathJSONRequestBody defines body for CheckSharedStoragePath for application/json ContentType.
type CheckSharedStoragePathResponse ¶
type CheckSharedStoragePathResponse struct {
}
func ParseCheckSharedStoragePathResponse ¶
func ParseCheckSharedStoragePathResponse(rsp *http.Response) (*CheckSharedStoragePathResponse, error)
ParseCheckSharedStoragePathResponse parses an HTTP response from a CheckSharedStoragePathWithResponse call
func (CheckSharedStoragePathResponse) Status ¶
func (r CheckSharedStoragePathResponse) Status() string
Status returns HTTPResponse.Status
func (CheckSharedStoragePathResponse) StatusCode ¶
func (r CheckSharedStoragePathResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
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) CheckBlenderExePath ¶
func (c *Client) CheckBlenderExePath(ctx context.Context, body CheckBlenderExePathJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CheckBlenderExePathWithBody ¶
func (*Client) CheckSharedStoragePath ¶
func (c *Client) CheckSharedStoragePath(ctx context.Context, body CheckSharedStoragePathJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CheckSharedStoragePathWithBody ¶
func (*Client) CreateWorkerTag ¶
func (c *Client) CreateWorkerTag(ctx context.Context, body CreateWorkerTagJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateWorkerTagWithBody ¶
func (*Client) DeleteJobMass ¶
func (c *Client) DeleteJobMass(ctx context.Context, body DeleteJobMassJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) DeleteJobMassWithBody ¶
func (*Client) DeleteJobWhatWouldItDo ¶
func (*Client) DeleteWorker ¶
func (*Client) DeleteWorkerTag ¶
func (*Client) FetchGlobalLastRenderedInfo ¶
func (*Client) FetchJobBlocklist ¶
func (*Client) FetchJobLastRenderedInfo ¶
func (*Client) FetchJobTasks ¶
func (*Client) FetchTaskLogInfo ¶
func (*Client) FetchTaskLogTail ¶
func (*Client) FetchWorker ¶
func (*Client) FetchWorkerSleepSchedule ¶
func (*Client) FetchWorkerTag ¶
func (*Client) FetchWorkerTags ¶
func (*Client) FetchWorkers ¶
func (*Client) FindBlenderExePath ¶
func (*Client) GetConfiguration ¶
func (*Client) GetConfigurationFile ¶
func (*Client) GetFarmStatus ¶
func (*Client) GetJobType ¶
func (*Client) GetJobTypes ¶
func (*Client) GetSharedStorage ¶
func (c *Client) GetSharedStorage(ctx context.Context, audience ManagerVariableAudience, platform string, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetVariables ¶
func (c *Client) GetVariables(ctx context.Context, audience ManagerVariableAudience, platform string, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) GetVersion ¶
func (*Client) MayWorkerRun ¶
func (*Client) QueryJobs ¶
func (c *Client) QueryJobs(ctx context.Context, body QueryJobsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) QueryJobsWithBody ¶
func (*Client) RegisterWorker ¶
func (c *Client) RegisterWorker(ctx context.Context, body RegisterWorkerJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) RegisterWorkerWithBody ¶
func (*Client) RemoveJobBlocklist ¶
func (c *Client) RemoveJobBlocklist(ctx context.Context, jobId string, body RemoveJobBlocklistJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) RemoveJobBlocklistWithBody ¶
func (*Client) RequestWorkerStatusChange ¶
func (c *Client) RequestWorkerStatusChange(ctx context.Context, workerId string, body RequestWorkerStatusChangeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) RequestWorkerStatusChangeWithBody ¶
func (*Client) SaveSetupAssistantConfig ¶
func (c *Client) SaveSetupAssistantConfig(ctx context.Context, body SaveSetupAssistantConfigJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) SaveSetupAssistantConfigWithBody ¶
func (*Client) ScheduleTask ¶
func (*Client) SetJobPriority ¶
func (c *Client) SetJobPriority(ctx context.Context, jobId string, body SetJobPriorityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) SetJobPriorityWithBody ¶
func (*Client) SetJobStatus ¶
func (c *Client) SetJobStatus(ctx context.Context, jobId string, body SetJobStatusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) SetJobStatusWithBody ¶
func (*Client) SetTaskStatus ¶
func (c *Client) SetTaskStatus(ctx context.Context, taskId string, body SetTaskStatusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) SetTaskStatusWithBody ¶
func (*Client) SetWorkerSleepSchedule ¶
func (c *Client) SetWorkerSleepSchedule(ctx context.Context, workerId string, body SetWorkerSleepScheduleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) SetWorkerSleepScheduleWithBody ¶
func (*Client) SetWorkerTags ¶
func (c *Client) SetWorkerTags(ctx context.Context, workerId string, body SetWorkerTagsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) SetWorkerTagsWithBody ¶
func (*Client) ShamanCheckout ¶
func (c *Client) ShamanCheckout(ctx context.Context, body ShamanCheckoutJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ShamanCheckoutRequirements ¶
func (c *Client) ShamanCheckoutRequirements(ctx context.Context, body ShamanCheckoutRequirementsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ShamanCheckoutRequirementsWithBody ¶
func (*Client) ShamanCheckoutWithBody ¶
func (*Client) ShamanFileStoreCheck ¶
func (*Client) ShamanFileStoreWithBody ¶
func (*Client) SignOn ¶
func (c *Client) SignOn(ctx context.Context, body SignOnJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) SignOnWithBody ¶
func (*Client) SubmitJob ¶
func (c *Client) SubmitJob(ctx context.Context, body SubmitJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) SubmitJobCheck ¶
func (c *Client) SubmitJobCheck(ctx context.Context, body SubmitJobCheckJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) SubmitJobCheckWithBody ¶
func (*Client) SubmitJobWithBody ¶
func (*Client) TaskOutputProducedWithBody ¶
func (*Client) TaskUpdate ¶
func (c *Client) TaskUpdate(ctx context.Context, taskId string, body TaskUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) TaskUpdateWithBody ¶
func (*Client) UpdateWorkerTag ¶
func (c *Client) UpdateWorkerTag(ctx context.Context, tagId string, body UpdateWorkerTagJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) UpdateWorkerTagWithBody ¶
func (*Client) WorkerState ¶
func (*Client) WorkerStateChanged ¶
func (c *Client) WorkerStateChanged(ctx context.Context, body WorkerStateChangedJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
type ClientInterface ¶
type ClientInterface interface {
// GetConfiguration request
GetConfiguration(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// FindBlenderExePath request
FindBlenderExePath(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// CheckBlenderExePath request with any body
CheckBlenderExePathWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CheckBlenderExePath(ctx context.Context, body CheckBlenderExePathJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
CheckSharedStoragePathWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetConfigurationFile request
GetConfigurationFile(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// SaveSetupAssistantConfig request with any body
SaveSetupAssistantConfigWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
SaveSetupAssistantConfig(ctx context.Context, body SaveSetupAssistantConfigJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
GetSharedStorage(ctx context.Context, audience ManagerVariableAudience, platform string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetVariables request
GetVariables(ctx context.Context, audience ManagerVariableAudience, platform string, reqEditors ...RequestEditorFn) (*http.Response, error)
// SubmitJob request with any body
SubmitJobWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
SubmitJob(ctx context.Context, body SubmitJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// SubmitJobCheck request with any body
SubmitJobCheckWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
SubmitJobCheck(ctx context.Context, body SubmitJobCheckJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// FetchGlobalLastRenderedInfo request
FetchGlobalLastRenderedInfo(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteJobMass request with any body
DeleteJobMassWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
DeleteJobMass(ctx context.Context, body DeleteJobMassJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// QueryJobs request with any body
QueryJobsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
QueryJobs(ctx context.Context, body QueryJobsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetJobType request
GetJobType(ctx context.Context, typeName string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetJobTypes request
GetJobTypes(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteJob request
DeleteJob(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// FetchJob request
FetchJob(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// RemoveJobBlocklist request with any body
RemoveJobBlocklistWithBody(ctx context.Context, jobId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
RemoveJobBlocklist(ctx context.Context, jobId string, body RemoveJobBlocklistJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// FetchJobBlocklist request
FetchJobBlocklist(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// FetchJobLastRenderedInfo request
FetchJobLastRenderedInfo(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// SetJobPriority request with any body
SetJobPriorityWithBody(ctx context.Context, jobId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
SetJobPriority(ctx context.Context, jobId string, body SetJobPriorityJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// SetJobStatus request with any body
SetJobStatusWithBody(ctx context.Context, jobId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
SetJobStatus(ctx context.Context, jobId string, body SetJobStatusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// FetchJobTasks request
FetchJobTasks(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteJobWhatWouldItDo request
DeleteJobWhatWouldItDo(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// ShamanCheckout request with any body
ShamanCheckoutWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
ShamanCheckout(ctx context.Context, body ShamanCheckoutJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ShamanCheckoutRequirements request with any body
ShamanCheckoutRequirementsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
ShamanCheckoutRequirements(ctx context.Context, body ShamanCheckoutRequirementsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ShamanFileStoreCheck request
ShamanFileStoreCheck(ctx context.Context, checksum string, filesize int, reqEditors ...RequestEditorFn) (*http.Response, error)
// ShamanFileStore request with any body
ShamanFileStoreWithBody(ctx context.Context, checksum string, filesize int, params *ShamanFileStoreParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetFarmStatus request
GetFarmStatus(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// FetchTask request
FetchTask(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// FetchTaskLogInfo request
FetchTaskLogInfo(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// FetchTaskLogTail request
FetchTaskLogTail(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// SetTaskStatus request with any body
SetTaskStatusWithBody(ctx context.Context, taskId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
SetTaskStatus(ctx context.Context, taskId string, body SetTaskStatusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetVersion request
GetVersion(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteWorkerTag request
DeleteWorkerTag(ctx context.Context, tagId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// FetchWorkerTag request
FetchWorkerTag(ctx context.Context, tagId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// UpdateWorkerTag request with any body
UpdateWorkerTagWithBody(ctx context.Context, tagId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
UpdateWorkerTag(ctx context.Context, tagId string, body UpdateWorkerTagJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// FetchWorkerTags request
FetchWorkerTags(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// CreateWorkerTag request with any body
CreateWorkerTagWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
CreateWorkerTag(ctx context.Context, body CreateWorkerTagJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// FetchWorkers request
FetchWorkers(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteWorker request
DeleteWorker(ctx context.Context, workerId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// FetchWorker request
FetchWorker(ctx context.Context, workerId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// RequestWorkerStatusChange request with any body
RequestWorkerStatusChangeWithBody(ctx context.Context, workerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
RequestWorkerStatusChange(ctx context.Context, workerId string, body RequestWorkerStatusChangeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// SetWorkerTags request with any body
SetWorkerTagsWithBody(ctx context.Context, workerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
SetWorkerTags(ctx context.Context, workerId string, body SetWorkerTagsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// FetchWorkerSleepSchedule request
FetchWorkerSleepSchedule(ctx context.Context, workerId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// SetWorkerSleepSchedule request with any body
SetWorkerSleepScheduleWithBody(ctx context.Context, workerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
SetWorkerSleepSchedule(ctx context.Context, workerId string, body SetWorkerSleepScheduleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// RegisterWorker request with any body
RegisterWorkerWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
RegisterWorker(ctx context.Context, body RegisterWorkerJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// SignOff request
SignOff(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// SignOn request with any body
SignOnWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
SignOn(ctx context.Context, body SignOnJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// WorkerState request
WorkerState(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// WorkerStateChanged request with any body
WorkerStateChangedWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
WorkerStateChanged(ctx context.Context, body WorkerStateChangedJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// ScheduleTask request
ScheduleTask(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// TaskUpdate request with any body
TaskUpdateWithBody(ctx context.Context, taskId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
TaskUpdate(ctx context.Context, taskId string, body TaskUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// MayWorkerRun request
MayWorkerRun(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*http.Response, error)
// TaskOutputProduced request with any body
TaskOutputProducedWithBody(ctx context.Context, taskId string, contentType string, body io.Reader, 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 NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) CheckBlenderExePathWithBodyWithResponse ¶
func (c *ClientWithResponses) CheckBlenderExePathWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CheckBlenderExePathResponse, error)
CheckBlenderExePathWithBodyWithResponse request with arbitrary body returning *CheckBlenderExePathResponse
func (*ClientWithResponses) CheckBlenderExePathWithResponse ¶
func (c *ClientWithResponses) CheckBlenderExePathWithResponse(ctx context.Context, body CheckBlenderExePathJSONRequestBody, reqEditors ...RequestEditorFn) (*CheckBlenderExePathResponse, error)
func (*ClientWithResponses) CheckSharedStoragePathWithBodyWithResponse ¶
func (c *ClientWithResponses) CheckSharedStoragePathWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CheckSharedStoragePathResponse, error)
CheckSharedStoragePathWithBodyWithResponse request with arbitrary body returning *CheckSharedStoragePathResponse
func (*ClientWithResponses) CheckSharedStoragePathWithResponse ¶
func (c *ClientWithResponses) CheckSharedStoragePathWithResponse(ctx context.Context, body CheckSharedStoragePathJSONRequestBody, reqEditors ...RequestEditorFn) (*CheckSharedStoragePathResponse, error)
func (*ClientWithResponses) CreateWorkerTagWithBodyWithResponse ¶
func (c *ClientWithResponses) CreateWorkerTagWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateWorkerTagResponse, error)
CreateWorkerTagWithBodyWithResponse request with arbitrary body returning *CreateWorkerTagResponse
func (*ClientWithResponses) CreateWorkerTagWithResponse ¶
func (c *ClientWithResponses) CreateWorkerTagWithResponse(ctx context.Context, body CreateWorkerTagJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateWorkerTagResponse, error)
func (*ClientWithResponses) DeleteJobMassWithBodyWithResponse ¶
func (c *ClientWithResponses) DeleteJobMassWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DeleteJobMassResponse, error)
DeleteJobMassWithBodyWithResponse request with arbitrary body returning *DeleteJobMassResponse
func (*ClientWithResponses) DeleteJobMassWithResponse ¶
func (c *ClientWithResponses) DeleteJobMassWithResponse(ctx context.Context, body DeleteJobMassJSONRequestBody, reqEditors ...RequestEditorFn) (*DeleteJobMassResponse, error)
func (*ClientWithResponses) DeleteJobWhatWouldItDoWithResponse ¶
func (c *ClientWithResponses) DeleteJobWhatWouldItDoWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*DeleteJobWhatWouldItDoResponse, error)
DeleteJobWhatWouldItDoWithResponse request returning *DeleteJobWhatWouldItDoResponse
func (*ClientWithResponses) DeleteJobWithResponse ¶
func (c *ClientWithResponses) DeleteJobWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*DeleteJobResponse, error)
DeleteJobWithResponse request returning *DeleteJobResponse
func (*ClientWithResponses) DeleteWorkerTagWithResponse ¶
func (c *ClientWithResponses) DeleteWorkerTagWithResponse(ctx context.Context, tagId string, reqEditors ...RequestEditorFn) (*DeleteWorkerTagResponse, error)
DeleteWorkerTagWithResponse request returning *DeleteWorkerTagResponse
func (*ClientWithResponses) DeleteWorkerWithResponse ¶
func (c *ClientWithResponses) DeleteWorkerWithResponse(ctx context.Context, workerId string, reqEditors ...RequestEditorFn) (*DeleteWorkerResponse, error)
DeleteWorkerWithResponse request returning *DeleteWorkerResponse
func (*ClientWithResponses) FetchGlobalLastRenderedInfoWithResponse ¶
func (c *ClientWithResponses) FetchGlobalLastRenderedInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FetchGlobalLastRenderedInfoResponse, error)
FetchGlobalLastRenderedInfoWithResponse request returning *FetchGlobalLastRenderedInfoResponse
func (*ClientWithResponses) FetchJobBlocklistWithResponse ¶
func (c *ClientWithResponses) FetchJobBlocklistWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*FetchJobBlocklistResponse, error)
FetchJobBlocklistWithResponse request returning *FetchJobBlocklistResponse
func (*ClientWithResponses) FetchJobLastRenderedInfoWithResponse ¶
func (c *ClientWithResponses) FetchJobLastRenderedInfoWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*FetchJobLastRenderedInfoResponse, error)
FetchJobLastRenderedInfoWithResponse request returning *FetchJobLastRenderedInfoResponse
func (*ClientWithResponses) FetchJobTasksWithResponse ¶
func (c *ClientWithResponses) FetchJobTasksWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*FetchJobTasksResponse, error)
FetchJobTasksWithResponse request returning *FetchJobTasksResponse
func (*ClientWithResponses) FetchJobWithResponse ¶
func (c *ClientWithResponses) FetchJobWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*FetchJobResponse, error)
FetchJobWithResponse request returning *FetchJobResponse
func (*ClientWithResponses) FetchTaskLogInfoWithResponse ¶
func (c *ClientWithResponses) FetchTaskLogInfoWithResponse(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*FetchTaskLogInfoResponse, error)
FetchTaskLogInfoWithResponse request returning *FetchTaskLogInfoResponse
func (*ClientWithResponses) FetchTaskLogTailWithResponse ¶
func (c *ClientWithResponses) FetchTaskLogTailWithResponse(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*FetchTaskLogTailResponse, error)
FetchTaskLogTailWithResponse request returning *FetchTaskLogTailResponse
func (*ClientWithResponses) FetchTaskWithResponse ¶
func (c *ClientWithResponses) FetchTaskWithResponse(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*FetchTaskResponse, error)
FetchTaskWithResponse request returning *FetchTaskResponse
func (*ClientWithResponses) FetchWorkerSleepScheduleWithResponse ¶
func (c *ClientWithResponses) FetchWorkerSleepScheduleWithResponse(ctx context.Context, workerId string, reqEditors ...RequestEditorFn) (*FetchWorkerSleepScheduleResponse, error)
FetchWorkerSleepScheduleWithResponse request returning *FetchWorkerSleepScheduleResponse
func (*ClientWithResponses) FetchWorkerTagWithResponse ¶
func (c *ClientWithResponses) FetchWorkerTagWithResponse(ctx context.Context, tagId string, reqEditors ...RequestEditorFn) (*FetchWorkerTagResponse, error)
FetchWorkerTagWithResponse request returning *FetchWorkerTagResponse
func (*ClientWithResponses) FetchWorkerTagsWithResponse ¶
func (c *ClientWithResponses) FetchWorkerTagsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FetchWorkerTagsResponse, error)
FetchWorkerTagsWithResponse request returning *FetchWorkerTagsResponse
func (*ClientWithResponses) FetchWorkerWithResponse ¶
func (c *ClientWithResponses) FetchWorkerWithResponse(ctx context.Context, workerId string, reqEditors ...RequestEditorFn) (*FetchWorkerResponse, error)
FetchWorkerWithResponse request returning *FetchWorkerResponse
func (*ClientWithResponses) FetchWorkersWithResponse ¶
func (c *ClientWithResponses) FetchWorkersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FetchWorkersResponse, error)
FetchWorkersWithResponse request returning *FetchWorkersResponse
func (*ClientWithResponses) FindBlenderExePathWithResponse ¶
func (c *ClientWithResponses) FindBlenderExePathWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FindBlenderExePathResponse, error)
FindBlenderExePathWithResponse request returning *FindBlenderExePathResponse
func (*ClientWithResponses) GetConfigurationFileWithResponse ¶
func (c *ClientWithResponses) GetConfigurationFileWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetConfigurationFileResponse, error)
GetConfigurationFileWithResponse request returning *GetConfigurationFileResponse
func (*ClientWithResponses) GetConfigurationWithResponse ¶
func (c *ClientWithResponses) GetConfigurationWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetConfigurationResponse, error)
GetConfigurationWithResponse request returning *GetConfigurationResponse
func (*ClientWithResponses) GetFarmStatusWithResponse ¶
func (c *ClientWithResponses) GetFarmStatusWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetFarmStatusResponse, error)
GetFarmStatusWithResponse request returning *GetFarmStatusResponse
func (*ClientWithResponses) GetJobTypeWithResponse ¶
func (c *ClientWithResponses) GetJobTypeWithResponse(ctx context.Context, typeName string, reqEditors ...RequestEditorFn) (*GetJobTypeResponse, error)
GetJobTypeWithResponse request returning *GetJobTypeResponse
func (*ClientWithResponses) GetJobTypesWithResponse ¶
func (c *ClientWithResponses) GetJobTypesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetJobTypesResponse, error)
GetJobTypesWithResponse request returning *GetJobTypesResponse
func (*ClientWithResponses) GetSharedStorageWithResponse ¶
func (c *ClientWithResponses) GetSharedStorageWithResponse(ctx context.Context, audience ManagerVariableAudience, platform string, reqEditors ...RequestEditorFn) (*GetSharedStorageResponse, error)
GetSharedStorageWithResponse request returning *GetSharedStorageResponse
func (*ClientWithResponses) GetVariablesWithResponse ¶
func (c *ClientWithResponses) GetVariablesWithResponse(ctx context.Context, audience ManagerVariableAudience, platform string, reqEditors ...RequestEditorFn) (*GetVariablesResponse, error)
GetVariablesWithResponse request returning *GetVariablesResponse
func (*ClientWithResponses) GetVersionWithResponse ¶
func (c *ClientWithResponses) GetVersionWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetVersionResponse, error)
GetVersionWithResponse request returning *GetVersionResponse
func (*ClientWithResponses) MayWorkerRunWithResponse ¶
func (c *ClientWithResponses) MayWorkerRunWithResponse(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*MayWorkerRunResponse, error)
MayWorkerRunWithResponse request returning *MayWorkerRunResponse
func (*ClientWithResponses) QueryJobsWithBodyWithResponse ¶
func (c *ClientWithResponses) QueryJobsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*QueryJobsResponse, error)
QueryJobsWithBodyWithResponse request with arbitrary body returning *QueryJobsResponse
func (*ClientWithResponses) QueryJobsWithResponse ¶
func (c *ClientWithResponses) QueryJobsWithResponse(ctx context.Context, body QueryJobsJSONRequestBody, reqEditors ...RequestEditorFn) (*QueryJobsResponse, error)
func (*ClientWithResponses) RegisterWorkerWithBodyWithResponse ¶
func (c *ClientWithResponses) RegisterWorkerWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterWorkerResponse, error)
RegisterWorkerWithBodyWithResponse request with arbitrary body returning *RegisterWorkerResponse
func (*ClientWithResponses) RegisterWorkerWithResponse ¶
func (c *ClientWithResponses) RegisterWorkerWithResponse(ctx context.Context, body RegisterWorkerJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterWorkerResponse, error)
func (*ClientWithResponses) RemoveJobBlocklistWithBodyWithResponse ¶
func (c *ClientWithResponses) RemoveJobBlocklistWithBodyWithResponse(ctx context.Context, jobId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RemoveJobBlocklistResponse, error)
RemoveJobBlocklistWithBodyWithResponse request with arbitrary body returning *RemoveJobBlocklistResponse
func (*ClientWithResponses) RemoveJobBlocklistWithResponse ¶
func (c *ClientWithResponses) RemoveJobBlocklistWithResponse(ctx context.Context, jobId string, body RemoveJobBlocklistJSONRequestBody, reqEditors ...RequestEditorFn) (*RemoveJobBlocklistResponse, error)
func (*ClientWithResponses) RequestWorkerStatusChangeWithBodyWithResponse ¶
func (c *ClientWithResponses) RequestWorkerStatusChangeWithBodyWithResponse(ctx context.Context, workerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RequestWorkerStatusChangeResponse, error)
RequestWorkerStatusChangeWithBodyWithResponse request with arbitrary body returning *RequestWorkerStatusChangeResponse
func (*ClientWithResponses) RequestWorkerStatusChangeWithResponse ¶
func (c *ClientWithResponses) RequestWorkerStatusChangeWithResponse(ctx context.Context, workerId string, body RequestWorkerStatusChangeJSONRequestBody, reqEditors ...RequestEditorFn) (*RequestWorkerStatusChangeResponse, error)
func (*ClientWithResponses) SaveSetupAssistantConfigWithBodyWithResponse ¶
func (c *ClientWithResponses) SaveSetupAssistantConfigWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SaveSetupAssistantConfigResponse, error)
SaveSetupAssistantConfigWithBodyWithResponse request with arbitrary body returning *SaveSetupAssistantConfigResponse
func (*ClientWithResponses) SaveSetupAssistantConfigWithResponse ¶
func (c *ClientWithResponses) SaveSetupAssistantConfigWithResponse(ctx context.Context, body SaveSetupAssistantConfigJSONRequestBody, reqEditors ...RequestEditorFn) (*SaveSetupAssistantConfigResponse, error)
func (*ClientWithResponses) ScheduleTaskWithResponse ¶
func (c *ClientWithResponses) ScheduleTaskWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ScheduleTaskResponse, error)
ScheduleTaskWithResponse request returning *ScheduleTaskResponse
func (*ClientWithResponses) SetJobPriorityWithBodyWithResponse ¶
func (c *ClientWithResponses) SetJobPriorityWithBodyWithResponse(ctx context.Context, jobId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetJobPriorityResponse, error)
SetJobPriorityWithBodyWithResponse request with arbitrary body returning *SetJobPriorityResponse
func (*ClientWithResponses) SetJobPriorityWithResponse ¶
func (c *ClientWithResponses) SetJobPriorityWithResponse(ctx context.Context, jobId string, body SetJobPriorityJSONRequestBody, reqEditors ...RequestEditorFn) (*SetJobPriorityResponse, error)
func (*ClientWithResponses) SetJobStatusWithBodyWithResponse ¶
func (c *ClientWithResponses) SetJobStatusWithBodyWithResponse(ctx context.Context, jobId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetJobStatusResponse, error)
SetJobStatusWithBodyWithResponse request with arbitrary body returning *SetJobStatusResponse
func (*ClientWithResponses) SetJobStatusWithResponse ¶
func (c *ClientWithResponses) SetJobStatusWithResponse(ctx context.Context, jobId string, body SetJobStatusJSONRequestBody, reqEditors ...RequestEditorFn) (*SetJobStatusResponse, error)
func (*ClientWithResponses) SetTaskStatusWithBodyWithResponse ¶
func (c *ClientWithResponses) SetTaskStatusWithBodyWithResponse(ctx context.Context, taskId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetTaskStatusResponse, error)
SetTaskStatusWithBodyWithResponse request with arbitrary body returning *SetTaskStatusResponse
func (*ClientWithResponses) SetTaskStatusWithResponse ¶
func (c *ClientWithResponses) SetTaskStatusWithResponse(ctx context.Context, taskId string, body SetTaskStatusJSONRequestBody, reqEditors ...RequestEditorFn) (*SetTaskStatusResponse, error)
func (*ClientWithResponses) SetWorkerSleepScheduleWithBodyWithResponse ¶
func (c *ClientWithResponses) SetWorkerSleepScheduleWithBodyWithResponse(ctx context.Context, workerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetWorkerSleepScheduleResponse, error)
SetWorkerSleepScheduleWithBodyWithResponse request with arbitrary body returning *SetWorkerSleepScheduleResponse
func (*ClientWithResponses) SetWorkerSleepScheduleWithResponse ¶
func (c *ClientWithResponses) SetWorkerSleepScheduleWithResponse(ctx context.Context, workerId string, body SetWorkerSleepScheduleJSONRequestBody, reqEditors ...RequestEditorFn) (*SetWorkerSleepScheduleResponse, error)
func (*ClientWithResponses) SetWorkerTagsWithBodyWithResponse ¶
func (c *ClientWithResponses) SetWorkerTagsWithBodyWithResponse(ctx context.Context, workerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetWorkerTagsResponse, error)
SetWorkerTagsWithBodyWithResponse request with arbitrary body returning *SetWorkerTagsResponse
func (*ClientWithResponses) SetWorkerTagsWithResponse ¶
func (c *ClientWithResponses) SetWorkerTagsWithResponse(ctx context.Context, workerId string, body SetWorkerTagsJSONRequestBody, reqEditors ...RequestEditorFn) (*SetWorkerTagsResponse, error)
func (*ClientWithResponses) ShamanCheckoutRequirementsWithBodyWithResponse ¶
func (c *ClientWithResponses) ShamanCheckoutRequirementsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ShamanCheckoutRequirementsResponse, error)
ShamanCheckoutRequirementsWithBodyWithResponse request with arbitrary body returning *ShamanCheckoutRequirementsResponse
func (*ClientWithResponses) ShamanCheckoutRequirementsWithResponse ¶
func (c *ClientWithResponses) ShamanCheckoutRequirementsWithResponse(ctx context.Context, body ShamanCheckoutRequirementsJSONRequestBody, reqEditors ...RequestEditorFn) (*ShamanCheckoutRequirementsResponse, error)
func (*ClientWithResponses) ShamanCheckoutWithBodyWithResponse ¶
func (c *ClientWithResponses) ShamanCheckoutWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ShamanCheckoutResponse, error)
ShamanCheckoutWithBodyWithResponse request with arbitrary body returning *ShamanCheckoutResponse
func (*ClientWithResponses) ShamanCheckoutWithResponse ¶
func (c *ClientWithResponses) ShamanCheckoutWithResponse(ctx context.Context, body ShamanCheckoutJSONRequestBody, reqEditors ...RequestEditorFn) (*ShamanCheckoutResponse, error)
func (*ClientWithResponses) ShamanFileStoreCheckWithResponse ¶
func (c *ClientWithResponses) ShamanFileStoreCheckWithResponse(ctx context.Context, checksum string, filesize int, reqEditors ...RequestEditorFn) (*ShamanFileStoreCheckResponse, error)
ShamanFileStoreCheckWithResponse request returning *ShamanFileStoreCheckResponse
func (*ClientWithResponses) ShamanFileStoreWithBodyWithResponse ¶
func (c *ClientWithResponses) ShamanFileStoreWithBodyWithResponse(ctx context.Context, checksum string, filesize int, params *ShamanFileStoreParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ShamanFileStoreResponse, error)
ShamanFileStoreWithBodyWithResponse request with arbitrary body returning *ShamanFileStoreResponse
func (*ClientWithResponses) SignOffWithResponse ¶
func (c *ClientWithResponses) SignOffWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*SignOffResponse, error)
SignOffWithResponse request returning *SignOffResponse
func (*ClientWithResponses) SignOnWithBodyWithResponse ¶
func (c *ClientWithResponses) SignOnWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SignOnResponse, error)
SignOnWithBodyWithResponse request with arbitrary body returning *SignOnResponse
func (*ClientWithResponses) SignOnWithResponse ¶
func (c *ClientWithResponses) SignOnWithResponse(ctx context.Context, body SignOnJSONRequestBody, reqEditors ...RequestEditorFn) (*SignOnResponse, error)
func (*ClientWithResponses) SubmitJobCheckWithBodyWithResponse ¶
func (c *ClientWithResponses) SubmitJobCheckWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SubmitJobCheckResponse, error)
SubmitJobCheckWithBodyWithResponse request with arbitrary body returning *SubmitJobCheckResponse
func (*ClientWithResponses) SubmitJobCheckWithResponse ¶
func (c *ClientWithResponses) SubmitJobCheckWithResponse(ctx context.Context, body SubmitJobCheckJSONRequestBody, reqEditors ...RequestEditorFn) (*SubmitJobCheckResponse, error)
func (*ClientWithResponses) SubmitJobWithBodyWithResponse ¶
func (c *ClientWithResponses) SubmitJobWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SubmitJobResponse, error)
SubmitJobWithBodyWithResponse request with arbitrary body returning *SubmitJobResponse
func (*ClientWithResponses) SubmitJobWithResponse ¶
func (c *ClientWithResponses) SubmitJobWithResponse(ctx context.Context, body SubmitJobJSONRequestBody, reqEditors ...RequestEditorFn) (*SubmitJobResponse, error)
func (*ClientWithResponses) TaskOutputProducedWithBodyWithResponse ¶
func (c *ClientWithResponses) TaskOutputProducedWithBodyWithResponse(ctx context.Context, taskId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*TaskOutputProducedResponse, error)
TaskOutputProducedWithBodyWithResponse request with arbitrary body returning *TaskOutputProducedResponse
func (*ClientWithResponses) TaskUpdateWithBodyWithResponse ¶
func (c *ClientWithResponses) TaskUpdateWithBodyWithResponse(ctx context.Context, taskId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*TaskUpdateResponse, error)
TaskUpdateWithBodyWithResponse request with arbitrary body returning *TaskUpdateResponse
func (*ClientWithResponses) TaskUpdateWithResponse ¶
func (c *ClientWithResponses) TaskUpdateWithResponse(ctx context.Context, taskId string, body TaskUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*TaskUpdateResponse, error)
func (*ClientWithResponses) UpdateWorkerTagWithBodyWithResponse ¶
func (c *ClientWithResponses) UpdateWorkerTagWithBodyWithResponse(ctx context.Context, tagId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateWorkerTagResponse, error)
UpdateWorkerTagWithBodyWithResponse request with arbitrary body returning *UpdateWorkerTagResponse
func (*ClientWithResponses) UpdateWorkerTagWithResponse ¶
func (c *ClientWithResponses) UpdateWorkerTagWithResponse(ctx context.Context, tagId string, body UpdateWorkerTagJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateWorkerTagResponse, error)
func (*ClientWithResponses) WorkerStateChangedWithBodyWithResponse ¶
func (c *ClientWithResponses) WorkerStateChangedWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*WorkerStateChangedResponse, error)
WorkerStateChangedWithBodyWithResponse request with arbitrary body returning *WorkerStateChangedResponse
func (*ClientWithResponses) WorkerStateChangedWithResponse ¶
func (c *ClientWithResponses) WorkerStateChangedWithResponse(ctx context.Context, body WorkerStateChangedJSONRequestBody, reqEditors ...RequestEditorFn) (*WorkerStateChangedResponse, error)
func (*ClientWithResponses) WorkerStateWithResponse ¶
func (c *ClientWithResponses) WorkerStateWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*WorkerStateResponse, error)
WorkerStateWithResponse request returning *WorkerStateResponse
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface {
// GetConfiguration request
GetConfigurationWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetConfigurationResponse, error)
// FindBlenderExePath request
FindBlenderExePathWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FindBlenderExePathResponse, error)
// CheckBlenderExePath request with any body
CheckBlenderExePathWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CheckBlenderExePathResponse, error)
CheckBlenderExePathWithResponse(ctx context.Context, body CheckBlenderExePathJSONRequestBody, reqEditors ...RequestEditorFn) (*CheckBlenderExePathResponse, error)
CheckSharedStoragePathWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CheckSharedStoragePathResponse, error)
// GetConfigurationFile request
GetConfigurationFileWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetConfigurationFileResponse, error)
// SaveSetupAssistantConfig request with any body
SaveSetupAssistantConfigWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SaveSetupAssistantConfigResponse, error)
SaveSetupAssistantConfigWithResponse(ctx context.Context, body SaveSetupAssistantConfigJSONRequestBody, reqEditors ...RequestEditorFn) (*SaveSetupAssistantConfigResponse, error)
GetSharedStorageWithResponse(ctx context.Context, audience ManagerVariableAudience, platform string, reqEditors ...RequestEditorFn) (*GetSharedStorageResponse, error)
// GetVariables request
GetVariablesWithResponse(ctx context.Context, audience ManagerVariableAudience, platform string, reqEditors ...RequestEditorFn) (*GetVariablesResponse, error)
// SubmitJob request with any body
SubmitJobWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SubmitJobResponse, error)
SubmitJobWithResponse(ctx context.Context, body SubmitJobJSONRequestBody, reqEditors ...RequestEditorFn) (*SubmitJobResponse, error)
// SubmitJobCheck request with any body
SubmitJobCheckWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SubmitJobCheckResponse, error)
SubmitJobCheckWithResponse(ctx context.Context, body SubmitJobCheckJSONRequestBody, reqEditors ...RequestEditorFn) (*SubmitJobCheckResponse, error)
// FetchGlobalLastRenderedInfo request
FetchGlobalLastRenderedInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FetchGlobalLastRenderedInfoResponse, error)
// DeleteJobMass request with any body
DeleteJobMassWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DeleteJobMassResponse, error)
DeleteJobMassWithResponse(ctx context.Context, body DeleteJobMassJSONRequestBody, reqEditors ...RequestEditorFn) (*DeleteJobMassResponse, error)
// QueryJobs request with any body
QueryJobsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*QueryJobsResponse, error)
QueryJobsWithResponse(ctx context.Context, body QueryJobsJSONRequestBody, reqEditors ...RequestEditorFn) (*QueryJobsResponse, error)
// GetJobType request
GetJobTypeWithResponse(ctx context.Context, typeName string, reqEditors ...RequestEditorFn) (*GetJobTypeResponse, error)
// GetJobTypes request
GetJobTypesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetJobTypesResponse, error)
// DeleteJob request
DeleteJobWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*DeleteJobResponse, error)
// FetchJob request
FetchJobWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*FetchJobResponse, error)
// RemoveJobBlocklist request with any body
RemoveJobBlocklistWithBodyWithResponse(ctx context.Context, jobId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RemoveJobBlocklistResponse, error)
RemoveJobBlocklistWithResponse(ctx context.Context, jobId string, body RemoveJobBlocklistJSONRequestBody, reqEditors ...RequestEditorFn) (*RemoveJobBlocklistResponse, error)
// FetchJobBlocklist request
FetchJobBlocklistWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*FetchJobBlocklistResponse, error)
// FetchJobLastRenderedInfo request
FetchJobLastRenderedInfoWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*FetchJobLastRenderedInfoResponse, error)
// SetJobPriority request with any body
SetJobPriorityWithBodyWithResponse(ctx context.Context, jobId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetJobPriorityResponse, error)
SetJobPriorityWithResponse(ctx context.Context, jobId string, body SetJobPriorityJSONRequestBody, reqEditors ...RequestEditorFn) (*SetJobPriorityResponse, error)
// SetJobStatus request with any body
SetJobStatusWithBodyWithResponse(ctx context.Context, jobId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetJobStatusResponse, error)
SetJobStatusWithResponse(ctx context.Context, jobId string, body SetJobStatusJSONRequestBody, reqEditors ...RequestEditorFn) (*SetJobStatusResponse, error)
// FetchJobTasks request
FetchJobTasksWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*FetchJobTasksResponse, error)
// DeleteJobWhatWouldItDo request
DeleteJobWhatWouldItDoWithResponse(ctx context.Context, jobId string, reqEditors ...RequestEditorFn) (*DeleteJobWhatWouldItDoResponse, error)
// ShamanCheckout request with any body
ShamanCheckoutWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ShamanCheckoutResponse, error)
ShamanCheckoutWithResponse(ctx context.Context, body ShamanCheckoutJSONRequestBody, reqEditors ...RequestEditorFn) (*ShamanCheckoutResponse, error)
// ShamanCheckoutRequirements request with any body
ShamanCheckoutRequirementsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ShamanCheckoutRequirementsResponse, error)
ShamanCheckoutRequirementsWithResponse(ctx context.Context, body ShamanCheckoutRequirementsJSONRequestBody, reqEditors ...RequestEditorFn) (*ShamanCheckoutRequirementsResponse, error)
// ShamanFileStoreCheck request
ShamanFileStoreCheckWithResponse(ctx context.Context, checksum string, filesize int, reqEditors ...RequestEditorFn) (*ShamanFileStoreCheckResponse, error)
// ShamanFileStore request with any body
ShamanFileStoreWithBodyWithResponse(ctx context.Context, checksum string, filesize int, params *ShamanFileStoreParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ShamanFileStoreResponse, error)
// GetFarmStatus request
GetFarmStatusWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetFarmStatusResponse, error)
// FetchTask request
FetchTaskWithResponse(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*FetchTaskResponse, error)
// FetchTaskLogInfo request
FetchTaskLogInfoWithResponse(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*FetchTaskLogInfoResponse, error)
// FetchTaskLogTail request
FetchTaskLogTailWithResponse(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*FetchTaskLogTailResponse, error)
// SetTaskStatus request with any body
SetTaskStatusWithBodyWithResponse(ctx context.Context, taskId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetTaskStatusResponse, error)
SetTaskStatusWithResponse(ctx context.Context, taskId string, body SetTaskStatusJSONRequestBody, reqEditors ...RequestEditorFn) (*SetTaskStatusResponse, error)
// GetVersion request
GetVersionWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetVersionResponse, error)
// DeleteWorkerTag request
DeleteWorkerTagWithResponse(ctx context.Context, tagId string, reqEditors ...RequestEditorFn) (*DeleteWorkerTagResponse, error)
// FetchWorkerTag request
FetchWorkerTagWithResponse(ctx context.Context, tagId string, reqEditors ...RequestEditorFn) (*FetchWorkerTagResponse, error)
// UpdateWorkerTag request with any body
UpdateWorkerTagWithBodyWithResponse(ctx context.Context, tagId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateWorkerTagResponse, error)
UpdateWorkerTagWithResponse(ctx context.Context, tagId string, body UpdateWorkerTagJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateWorkerTagResponse, error)
// FetchWorkerTags request
FetchWorkerTagsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FetchWorkerTagsResponse, error)
// CreateWorkerTag request with any body
CreateWorkerTagWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateWorkerTagResponse, error)
CreateWorkerTagWithResponse(ctx context.Context, body CreateWorkerTagJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateWorkerTagResponse, error)
// FetchWorkers request
FetchWorkersWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*FetchWorkersResponse, error)
// DeleteWorker request
DeleteWorkerWithResponse(ctx context.Context, workerId string, reqEditors ...RequestEditorFn) (*DeleteWorkerResponse, error)
// FetchWorker request
FetchWorkerWithResponse(ctx context.Context, workerId string, reqEditors ...RequestEditorFn) (*FetchWorkerResponse, error)
// RequestWorkerStatusChange request with any body
RequestWorkerStatusChangeWithBodyWithResponse(ctx context.Context, workerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RequestWorkerStatusChangeResponse, error)
RequestWorkerStatusChangeWithResponse(ctx context.Context, workerId string, body RequestWorkerStatusChangeJSONRequestBody, reqEditors ...RequestEditorFn) (*RequestWorkerStatusChangeResponse, error)
// SetWorkerTags request with any body
SetWorkerTagsWithBodyWithResponse(ctx context.Context, workerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetWorkerTagsResponse, error)
SetWorkerTagsWithResponse(ctx context.Context, workerId string, body SetWorkerTagsJSONRequestBody, reqEditors ...RequestEditorFn) (*SetWorkerTagsResponse, error)
// FetchWorkerSleepSchedule request
FetchWorkerSleepScheduleWithResponse(ctx context.Context, workerId string, reqEditors ...RequestEditorFn) (*FetchWorkerSleepScheduleResponse, error)
// SetWorkerSleepSchedule request with any body
SetWorkerSleepScheduleWithBodyWithResponse(ctx context.Context, workerId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetWorkerSleepScheduleResponse, error)
SetWorkerSleepScheduleWithResponse(ctx context.Context, workerId string, body SetWorkerSleepScheduleJSONRequestBody, reqEditors ...RequestEditorFn) (*SetWorkerSleepScheduleResponse, error)
// RegisterWorker request with any body
RegisterWorkerWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RegisterWorkerResponse, error)
RegisterWorkerWithResponse(ctx context.Context, body RegisterWorkerJSONRequestBody, reqEditors ...RequestEditorFn) (*RegisterWorkerResponse, error)
// SignOff request
SignOffWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*SignOffResponse, error)
// SignOn request with any body
SignOnWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SignOnResponse, error)
SignOnWithResponse(ctx context.Context, body SignOnJSONRequestBody, reqEditors ...RequestEditorFn) (*SignOnResponse, error)
// WorkerState request
WorkerStateWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*WorkerStateResponse, error)
// WorkerStateChanged request with any body
WorkerStateChangedWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*WorkerStateChangedResponse, error)
WorkerStateChangedWithResponse(ctx context.Context, body WorkerStateChangedJSONRequestBody, reqEditors ...RequestEditorFn) (*WorkerStateChangedResponse, error)
// ScheduleTask request
ScheduleTaskWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ScheduleTaskResponse, error)
// TaskUpdate request with any body
TaskUpdateWithBodyWithResponse(ctx context.Context, taskId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*TaskUpdateResponse, error)
TaskUpdateWithResponse(ctx context.Context, taskId string, body TaskUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*TaskUpdateResponse, error)
// MayWorkerRun request
MayWorkerRunWithResponse(ctx context.Context, taskId string, reqEditors ...RequestEditorFn) (*MayWorkerRunResponse, error)
// TaskOutputProduced request with any body
TaskOutputProducedWithBodyWithResponse(ctx context.Context, taskId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*TaskOutputProducedResponse, error)
}
ClientWithResponsesInterface is the interface specification for the client with responses above.
type Command ¶
type Command struct {
Name string `json:"name"`
Parameters map[string]interface{} `json:"parameters"`
}
Command represents a single command to execute by the Worker.
type CreateWorkerTagJSONBody ¶
type CreateWorkerTagJSONBody WorkerTag
CreateWorkerTagJSONBody defines parameters for CreateWorkerTag.
type CreateWorkerTagJSONRequestBody ¶
type CreateWorkerTagJSONRequestBody CreateWorkerTagJSONBody
CreateWorkerTagJSONRequestBody defines body for CreateWorkerTag for application/json ContentType.
type CreateWorkerTagResponse ¶
type CreateWorkerTagResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *WorkerTag
JSONDefault *Error
}
func ParseCreateWorkerTagResponse ¶
func ParseCreateWorkerTagResponse(rsp *http.Response) (*CreateWorkerTagResponse, error)
ParseCreateWorkerTagResponse parses an HTTP response from a CreateWorkerTagWithResponse call
func (CreateWorkerTagResponse) Status ¶
func (r CreateWorkerTagResponse) Status() string
Status returns HTTPResponse.Status
func (CreateWorkerTagResponse) StatusCode ¶
func (r CreateWorkerTagResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteJobMassJSONBody ¶
type DeleteJobMassJSONBody JobMassDeletionSelection
DeleteJobMassJSONBody defines parameters for DeleteJobMass.
type DeleteJobMassJSONRequestBody ¶
type DeleteJobMassJSONRequestBody DeleteJobMassJSONBody
DeleteJobMassJSONRequestBody defines body for DeleteJobMass for application/json ContentType.
type DeleteJobMassResponse ¶
type DeleteJobMassResponse struct {
Body []byte
HTTPResponse *http.Response
JSON416 *Error
JSONDefault *Error
}
func ParseDeleteJobMassResponse ¶
func ParseDeleteJobMassResponse(rsp *http.Response) (*DeleteJobMassResponse, error)
ParseDeleteJobMassResponse parses an HTTP response from a DeleteJobMassWithResponse call
func (DeleteJobMassResponse) Status ¶
func (r DeleteJobMassResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteJobMassResponse) StatusCode ¶
func (r DeleteJobMassResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteJobResponse ¶
func ParseDeleteJobResponse ¶
func ParseDeleteJobResponse(rsp *http.Response) (*DeleteJobResponse, error)
ParseDeleteJobResponse parses an HTTP response from a DeleteJobWithResponse call
func (DeleteJobResponse) Status ¶
func (r DeleteJobResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteJobResponse) StatusCode ¶
func (r DeleteJobResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteJobWhatWouldItDoResponse ¶
type DeleteJobWhatWouldItDoResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *JobDeletionInfo
}
func ParseDeleteJobWhatWouldItDoResponse ¶
func ParseDeleteJobWhatWouldItDoResponse(rsp *http.Response) (*DeleteJobWhatWouldItDoResponse, error)
ParseDeleteJobWhatWouldItDoResponse parses an HTTP response from a DeleteJobWhatWouldItDoWithResponse call
func (DeleteJobWhatWouldItDoResponse) Status ¶
func (r DeleteJobWhatWouldItDoResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteJobWhatWouldItDoResponse) StatusCode ¶
func (r DeleteJobWhatWouldItDoResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteWorkerResponse ¶
func ParseDeleteWorkerResponse ¶
func ParseDeleteWorkerResponse(rsp *http.Response) (*DeleteWorkerResponse, error)
ParseDeleteWorkerResponse parses an HTTP response from a DeleteWorkerWithResponse call
func (DeleteWorkerResponse) Status ¶
func (r DeleteWorkerResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteWorkerResponse) StatusCode ¶
func (r DeleteWorkerResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteWorkerTagResponse ¶
func ParseDeleteWorkerTagResponse ¶
func ParseDeleteWorkerTagResponse(rsp *http.Response) (*DeleteWorkerTagResponse, error)
ParseDeleteWorkerTagResponse parses an HTTP response from a DeleteWorkerTagWithResponse call
func (DeleteWorkerTagResponse) Status ¶
func (r DeleteWorkerTagResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteWorkerTagResponse) StatusCode ¶
func (r DeleteWorkerTagResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type EchoRouter ¶
type EchoRouter interface {
CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
}
This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration
type Error ¶
type Error struct {
// HTTP status code of this response. Is included in the payload so that a single object represents all error information.
// Code 503 is used when the database is busy. The HTTP response will contain a 'Retry-After' HTTP header that indicates after which time the request can be retried. Following the header is not mandatory, and it's up to the client to do something reasonable like exponential backoff.
Code int32 `json:"code"`
Message string `json:"message"`
}
Generic error response.
type EventFarmStatus ¶
type EventFarmStatus FarmStatusReport
EventFarmStatus defines model for EventFarmStatus.
type EventJobUpdate ¶
type EventJobUpdate struct {
// If job deletion was requested, this is the timestamp at which that request was stored on Flamenco Manager.
DeleteRequestedAt *time.Time `json:"delete_requested_at,omitempty"`
// UUID of the Job
Id string `json:"id"`
// Name of the job
Name *string `json:"name,omitempty"`
PreviousStatus *JobStatus `json:"previous_status,omitempty"`
Priority int `json:"priority"`
// Indicates that the client should refresh all the job's tasks. This is sent for mass updates, where updating each individual task would generate too many updates to be practical.
RefreshTasks bool `json:"refresh_tasks"`
Status JobStatus `json:"status"`
Type string `json:"type"`
// Timestamp of last update
Updated time.Time `json:"updated"`
// When a job was just deleted, this is set to `true`. If this is specified, only the 'id' field is set, the rest will be empty.
WasDeleted *bool `json:"was_deleted,omitempty"`
}
Subset of a Job, sent over SocketIO/MQTT when a job changes. For new jobs, `previous_status` will be excluded.
type EventLastRenderedUpdate ¶
type EventLastRenderedUpdate struct {
JobId string `json:"job_id"`
// Enough information for a client to piece together different strings to form a host-relative URL to the last-rendered image. To construct the URL, concatenate "{base}/{one of the suffixes}".
Thumbnail JobLastRenderedImageInfo `json:"thumbnail"`
}
Indicator that the last-rendered image of this job was updated.
type EventLifeCycle ¶
type EventLifeCycle struct {
Type LifeCycleEventType `json:"type"`
}
Flamenco life-cycle event, for things like shutting down, starting up, etc.
type EventTaskLogUpdate ¶
type EventTaskLogUpdate struct {
// Chunk of the task log. May contain multiple lines of text.
Log string `json:"log"`
// UUID of the Task
TaskId string `json:"task_id"`
}
Task log chunk, sent to a MQTT topic/SocketIO room dedicated to a single task, to avoid sending too many updates.
type EventTaskUpdate ¶
type EventTaskUpdate struct {
Activity string `json:"activity"`
// UUID of the Task
Id string `json:"id"`
JobId string `json:"job_id"`
// Name of the task
Name string `json:"name"`
PreviousStatus *TaskStatus `json:"previous_status,omitempty"`
Status TaskStatus `json:"status"`
// Timestamp of last update
Updated time.Time `json:"updated"`
}
Subset of a Task, sent over SocketIO/MQTT when a task changes. For new tasks, `previous_status` will be excluded.
type EventWorkerTagUpdate ¶
type EventWorkerTagUpdate struct {
// Tag of workers. A job can optionally specify which tag it should be limited to. Workers can be part of multiple tags simultaneously.
Tag WorkerTag `json:"tag"`
// When a tag was just deleted, this is set to `true`.
WasDeleted *bool `json:"was_deleted,omitempty"`
}
Worker Tag, sent over SocketIO/MQTT when it changes.
type EventWorkerUpdate ¶
type EventWorkerUpdate struct {
// Whether this Worker can auto-restart.
CanRestart bool `json:"can_restart"`
// This is only set when the worker was deleted.
DeletedAt *time.Time `json:"deleted_at,omitempty"`
// UUID of the Worker
Id string `json:"id"`
// Last time this worker was seen by the Manager.
LastSeen *time.Time `json:"last_seen,omitempty"`
// Name of the worker
Name string `json:"name"`
PreviousStatus *WorkerStatus `json:"previous_status,omitempty"`
Status WorkerStatus `json:"status"`
// Request for a Worker to change its status to `status`.
StatusChange *WorkerStatusChangeRequest `json:"status_change,omitempty"`
// Timestamp of last update
Updated time.Time `json:"updated"`
Version string `json:"version"`
}
Subset of a Worker, sent over SocketIO/MQTT when a worker changes.
type FarmStatus ¶
type FarmStatus string
FarmStatus defines model for FarmStatus.
const ( FarmStatusActive FarmStatus = "active" FarmStatusAsleep FarmStatus = "asleep" FarmStatusIdle FarmStatus = "idle" FarmStatusInoperative FarmStatus = "inoperative" FarmStatusStarting FarmStatus = "starting" FarmStatusUnknown FarmStatus = "unknown" FarmStatusWaiting FarmStatus = "waiting" )
Defines values for FarmStatus.
type FarmStatusReport ¶
type FarmStatusReport struct {
Status FarmStatus `json:"status"`
}
FarmStatusReport defines model for FarmStatusReport.
type FetchGlobalLastRenderedInfoResponse ¶
type FetchGlobalLastRenderedInfoResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *JobLastRenderedImageInfo
}
func ParseFetchGlobalLastRenderedInfoResponse ¶
func ParseFetchGlobalLastRenderedInfoResponse(rsp *http.Response) (*FetchGlobalLastRenderedInfoResponse, error)
ParseFetchGlobalLastRenderedInfoResponse parses an HTTP response from a FetchGlobalLastRenderedInfoWithResponse call
func (FetchGlobalLastRenderedInfoResponse) Status ¶
func (r FetchGlobalLastRenderedInfoResponse) Status() string
Status returns HTTPResponse.Status
func (FetchGlobalLastRenderedInfoResponse) StatusCode ¶
func (r FetchGlobalLastRenderedInfoResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FetchJobBlocklistResponse ¶
type FetchJobBlocklistResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *JobBlocklist
JSONDefault *Error
}
func ParseFetchJobBlocklistResponse ¶
func ParseFetchJobBlocklistResponse(rsp *http.Response) (*FetchJobBlocklistResponse, error)
ParseFetchJobBlocklistResponse parses an HTTP response from a FetchJobBlocklistWithResponse call
func (FetchJobBlocklistResponse) Status ¶
func (r FetchJobBlocklistResponse) Status() string
Status returns HTTPResponse.Status
func (FetchJobBlocklistResponse) StatusCode ¶
func (r FetchJobBlocklistResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FetchJobLastRenderedInfoResponse ¶
type FetchJobLastRenderedInfoResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *JobLastRenderedImageInfo
}
func ParseFetchJobLastRenderedInfoResponse ¶
func ParseFetchJobLastRenderedInfoResponse(rsp *http.Response) (*FetchJobLastRenderedInfoResponse, error)
ParseFetchJobLastRenderedInfoResponse parses an HTTP response from a FetchJobLastRenderedInfoWithResponse call
func (FetchJobLastRenderedInfoResponse) Status ¶
func (r FetchJobLastRenderedInfoResponse) Status() string
Status returns HTTPResponse.Status
func (FetchJobLastRenderedInfoResponse) StatusCode ¶
func (r FetchJobLastRenderedInfoResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FetchJobResponse ¶
func ParseFetchJobResponse ¶
func ParseFetchJobResponse(rsp *http.Response) (*FetchJobResponse, error)
ParseFetchJobResponse parses an HTTP response from a FetchJobWithResponse call
func (FetchJobResponse) Status ¶
func (r FetchJobResponse) Status() string
Status returns HTTPResponse.Status
func (FetchJobResponse) StatusCode ¶
func (r FetchJobResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FetchJobTasksResponse ¶
type FetchJobTasksResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *JobTasksSummary
JSONDefault *Error
}
func ParseFetchJobTasksResponse ¶
func ParseFetchJobTasksResponse(rsp *http.Response) (*FetchJobTasksResponse, error)
ParseFetchJobTasksResponse parses an HTTP response from a FetchJobTasksWithResponse call
func (FetchJobTasksResponse) Status ¶
func (r FetchJobTasksResponse) Status() string
Status returns HTTPResponse.Status
func (FetchJobTasksResponse) StatusCode ¶
func (r FetchJobTasksResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FetchTaskLogInfoResponse ¶
type FetchTaskLogInfoResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *TaskLogInfo
JSONDefault *Error
}
func ParseFetchTaskLogInfoResponse ¶
func ParseFetchTaskLogInfoResponse(rsp *http.Response) (*FetchTaskLogInfoResponse, error)
ParseFetchTaskLogInfoResponse parses an HTTP response from a FetchTaskLogInfoWithResponse call
func (FetchTaskLogInfoResponse) Status ¶
func (r FetchTaskLogInfoResponse) Status() string
Status returns HTTPResponse.Status
func (FetchTaskLogInfoResponse) StatusCode ¶
func (r FetchTaskLogInfoResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FetchTaskLogTailResponse ¶
func ParseFetchTaskLogTailResponse ¶
func ParseFetchTaskLogTailResponse(rsp *http.Response) (*FetchTaskLogTailResponse, error)
ParseFetchTaskLogTailResponse parses an HTTP response from a FetchTaskLogTailWithResponse call
func (FetchTaskLogTailResponse) Status ¶
func (r FetchTaskLogTailResponse) Status() string
Status returns HTTPResponse.Status
func (FetchTaskLogTailResponse) StatusCode ¶
func (r FetchTaskLogTailResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FetchTaskResponse ¶
type FetchTaskResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *Task
JSONDefault *Error
}
func ParseFetchTaskResponse ¶
func ParseFetchTaskResponse(rsp *http.Response) (*FetchTaskResponse, error)
ParseFetchTaskResponse parses an HTTP response from a FetchTaskWithResponse call
func (FetchTaskResponse) Status ¶
func (r FetchTaskResponse) Status() string
Status returns HTTPResponse.Status
func (FetchTaskResponse) StatusCode ¶
func (r FetchTaskResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FetchWorkerResponse ¶
func ParseFetchWorkerResponse ¶
func ParseFetchWorkerResponse(rsp *http.Response) (*FetchWorkerResponse, error)
ParseFetchWorkerResponse parses an HTTP response from a FetchWorkerWithResponse call
func (FetchWorkerResponse) Status ¶
func (r FetchWorkerResponse) Status() string
Status returns HTTPResponse.Status
func (FetchWorkerResponse) StatusCode ¶
func (r FetchWorkerResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FetchWorkerSleepScheduleResponse ¶
type FetchWorkerSleepScheduleResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *WorkerSleepSchedule
JSONDefault *Error
}
func ParseFetchWorkerSleepScheduleResponse ¶
func ParseFetchWorkerSleepScheduleResponse(rsp *http.Response) (*FetchWorkerSleepScheduleResponse, error)
ParseFetchWorkerSleepScheduleResponse parses an HTTP response from a FetchWorkerSleepScheduleWithResponse call
func (FetchWorkerSleepScheduleResponse) Status ¶
func (r FetchWorkerSleepScheduleResponse) Status() string
Status returns HTTPResponse.Status
func (FetchWorkerSleepScheduleResponse) StatusCode ¶
func (r FetchWorkerSleepScheduleResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FetchWorkerTagResponse ¶
func ParseFetchWorkerTagResponse ¶
func ParseFetchWorkerTagResponse(rsp *http.Response) (*FetchWorkerTagResponse, error)
ParseFetchWorkerTagResponse parses an HTTP response from a FetchWorkerTagWithResponse call
func (FetchWorkerTagResponse) Status ¶
func (r FetchWorkerTagResponse) Status() string
Status returns HTTPResponse.Status
func (FetchWorkerTagResponse) StatusCode ¶
func (r FetchWorkerTagResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FetchWorkerTagsResponse ¶
type FetchWorkerTagsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *WorkerTagList
}
func ParseFetchWorkerTagsResponse ¶
func ParseFetchWorkerTagsResponse(rsp *http.Response) (*FetchWorkerTagsResponse, error)
ParseFetchWorkerTagsResponse parses an HTTP response from a FetchWorkerTagsWithResponse call
func (FetchWorkerTagsResponse) Status ¶
func (r FetchWorkerTagsResponse) Status() string
Status returns HTTPResponse.Status
func (FetchWorkerTagsResponse) StatusCode ¶
func (r FetchWorkerTagsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FetchWorkersResponse ¶
type FetchWorkersResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *WorkerList
}
func ParseFetchWorkersResponse ¶
func ParseFetchWorkersResponse(rsp *http.Response) (*FetchWorkersResponse, error)
ParseFetchWorkersResponse parses an HTTP response from a FetchWorkersWithResponse call
func (FetchWorkersResponse) Status ¶
func (r FetchWorkersResponse) Status() string
Status returns HTTPResponse.Status
func (FetchWorkersResponse) StatusCode ¶
func (r FetchWorkersResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FindBlenderExePathResponse ¶
type FindBlenderExePathResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *BlenderPathFindResult
JSONDefault *Error
}
func ParseFindBlenderExePathResponse ¶
func ParseFindBlenderExePathResponse(rsp *http.Response) (*FindBlenderExePathResponse, error)
ParseFindBlenderExePathResponse parses an HTTP response from a FindBlenderExePathWithResponse call
func (FindBlenderExePathResponse) Status ¶
func (r FindBlenderExePathResponse) Status() string
Status returns HTTPResponse.Status
func (FindBlenderExePathResponse) StatusCode ¶
func (r FindBlenderExePathResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type FlamencoVersion ¶
type FlamencoVersion struct {
Git string `json:"git"`
Name string `json:"name"`
Shortversion string `json:"shortversion"`
// Version of this Manager, meant for human consumption. For release builds it is the same as `shortversion`, for other builds it also includes the `git` version info.
Version string `json:"version"`
}
FlamencoVersion defines model for FlamencoVersion.
type GetConfigurationFileResponse ¶
type GetConfigurationFileResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *struct {
AdditionalProperties map[string]interface{} `json:"-"`
}
YAML200 *string
}
func ParseGetConfigurationFileResponse ¶
func ParseGetConfigurationFileResponse(rsp *http.Response) (*GetConfigurationFileResponse, error)
ParseGetConfigurationFileResponse parses an HTTP response from a GetConfigurationFileWithResponse call
func (GetConfigurationFileResponse) Status ¶
func (r GetConfigurationFileResponse) Status() string
Status returns HTTPResponse.Status
func (GetConfigurationFileResponse) StatusCode ¶
func (r GetConfigurationFileResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetConfigurationResponse ¶
type GetConfigurationResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ManagerConfiguration
}
func ParseGetConfigurationResponse ¶
func ParseGetConfigurationResponse(rsp *http.Response) (*GetConfigurationResponse, error)
ParseGetConfigurationResponse parses an HTTP response from a GetConfigurationWithResponse call
func (GetConfigurationResponse) Status ¶
func (r GetConfigurationResponse) Status() string
Status returns HTTPResponse.Status
func (GetConfigurationResponse) StatusCode ¶
func (r GetConfigurationResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetFarmStatusResponse ¶
type GetFarmStatusResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *FarmStatusReport
}
func ParseGetFarmStatusResponse ¶
func ParseGetFarmStatusResponse(rsp *http.Response) (*GetFarmStatusResponse, error)
ParseGetFarmStatusResponse parses an HTTP response from a GetFarmStatusWithResponse call
func (GetFarmStatusResponse) Status ¶
func (r GetFarmStatusResponse) Status() string
Status returns HTTPResponse.Status
func (GetFarmStatusResponse) StatusCode ¶
func (r GetFarmStatusResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetJobTypeResponse ¶
type GetJobTypeResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AvailableJobType
}
func ParseGetJobTypeResponse ¶
func ParseGetJobTypeResponse(rsp *http.Response) (*GetJobTypeResponse, error)
ParseGetJobTypeResponse parses an HTTP response from a GetJobTypeWithResponse call
func (GetJobTypeResponse) Status ¶
func (r GetJobTypeResponse) Status() string
Status returns HTTPResponse.Status
func (GetJobTypeResponse) StatusCode ¶
func (r GetJobTypeResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetJobTypesResponse ¶
type GetJobTypesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AvailableJobTypes
}
func ParseGetJobTypesResponse ¶
func ParseGetJobTypesResponse(rsp *http.Response) (*GetJobTypesResponse, error)
ParseGetJobTypesResponse parses an HTTP response from a GetJobTypesWithResponse call
func (GetJobTypesResponse) Status ¶
func (r GetJobTypesResponse) Status() string
Status returns HTTPResponse.Status
func (GetJobTypesResponse) StatusCode ¶
func (r GetJobTypesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetSharedStorageResponse ¶
type GetSharedStorageResponse struct {
}
func ParseGetSharedStorageResponse ¶
func ParseGetSharedStorageResponse(rsp *http.Response) (*GetSharedStorageResponse, error)
ParseGetSharedStorageResponse parses an HTTP response from a GetSharedStorageWithResponse call
func (GetSharedStorageResponse) Status ¶
func (r GetSharedStorageResponse) Status() string
Status returns HTTPResponse.Status
func (GetSharedStorageResponse) StatusCode ¶
func (r GetSharedStorageResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetVariablesResponse ¶
type GetVariablesResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ManagerVariables
}
func ParseGetVariablesResponse ¶
func ParseGetVariablesResponse(rsp *http.Response) (*GetVariablesResponse, error)
ParseGetVariablesResponse parses an HTTP response from a GetVariablesWithResponse call
func (GetVariablesResponse) Status ¶
func (r GetVariablesResponse) Status() string
Status returns HTTPResponse.Status
func (GetVariablesResponse) StatusCode ¶
func (r GetVariablesResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetVersionResponse ¶
type GetVersionResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *FlamencoVersion
}
func ParseGetVersionResponse ¶
func ParseGetVersionResponse(rsp *http.Response) (*GetVersionResponse, error)
ParseGetVersionResponse parses an HTTP response from a GetVersionWithResponse call
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 HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type Job ¶
type Job struct {
// Embedded struct due to allOf(#/components/schemas/SubmittedJob)
SubmittedJob `yaml:",inline"`
// Embedded fields due to inline allOf schema
// Description of the last activity on this job.
Activity string `json:"activity"`
// Creation timestamp
Created time.Time `json:"created"`
// If job deletion was requested, this is the timestamp at which that request was stored on Flamenco Manager.
DeleteRequestedAt *time.Time `json:"delete_requested_at,omitempty"`
// UUID of the Job
Id string `json:"id"`
Status JobStatus `json:"status"`
// Timestamp of last update.
Updated time.Time `json:"updated"`
}
Job defines model for Job.
type JobBlocklist ¶
type JobBlocklist []JobBlocklistEntry
List of workers that are not allowed certain task types on a specific job.
type JobBlocklistEntry ¶
type JobBlocklistEntry struct {
TaskType string `json:"task_type"`
WorkerId string `json:"worker_id"`
WorkerName *string `json:"worker_name,omitempty"`
}
JobBlocklistEntry defines model for JobBlocklistEntry.
type JobDeletionInfo ¶
type JobDeletionInfo struct {
// Whether the Shaman checkout directory will be removed along with the job.
ShamanCheckout bool `json:"shaman_checkout"`
}
Info about what will be deleted when this job is deleted.
type JobLastRenderedImageInfo ¶
type JobLastRenderedImageInfo struct {
Base string `json:"base"`
Suffixes []string `json:"suffixes"`
}
Enough information for a client to piece together different strings to form a host-relative URL to the last-rendered image. To construct the URL, concatenate "{base}/{one of the suffixes}".
type JobMassDeletionSelection ¶
type JobMassDeletionSelection struct {
// All jobs that were last updated before or on this timestamp will be deleted.
LastUpdatedMax *time.Time `json:"last_updated_max,omitempty"`
}
Parameters to describe which jobs should be deleted.
type JobMetadata ¶
Arbitrary metadata strings. More complex structures can be modeled by using `a.b.c` notation for the key.
func (JobMetadata) Get ¶
func (a JobMetadata) Get(fieldName string) (value string, found bool)
Getter for additional properties for JobMetadata. Returns the specified element and whether it was found
func (JobMetadata) MarshalJSON ¶
func (a JobMetadata) MarshalJSON() ([]byte, error)
Override default JSON handling for JobMetadata to handle AdditionalProperties
func (*JobMetadata) Set ¶
func (a *JobMetadata) Set(fieldName string, value string)
Setter for additional properties for JobMetadata
func (*JobMetadata) UnmarshalJSON ¶
func (a *JobMetadata) UnmarshalJSON(b []byte) error
Override default JSON handling for JobMetadata to handle AdditionalProperties
type JobPriorityChange ¶
type JobPriorityChange struct {
Priority int `json:"priority"`
}
JobPriorityChange defines model for JobPriorityChange.
type JobSettings ¶
type JobSettings struct {
AdditionalProperties map[string]interface{} `json:"-"`
}
JobSettings defines model for JobSettings.
func (JobSettings) Get ¶
func (a JobSettings) Get(fieldName string) (value interface{}, found bool)
Getter for additional properties for JobSettings. Returns the specified element and whether it was found
func (JobSettings) MarshalJSON ¶
func (a JobSettings) MarshalJSON() ([]byte, error)
Override default JSON handling for JobSettings to handle AdditionalProperties
func (*JobSettings) Set ¶
func (a *JobSettings) Set(fieldName string, value interface{})
Setter for additional properties for JobSettings
func (*JobSettings) UnmarshalJSON ¶
func (a *JobSettings) UnmarshalJSON(b []byte) error
Override default JSON handling for JobSettings to handle AdditionalProperties
type JobStatus ¶
type JobStatus string
JobStatus defines model for JobStatus.
const ( JobStatusActive JobStatus = "active" JobStatusCancelRequested JobStatus = "cancel-requested" JobStatusCanceled JobStatus = "canceled" JobStatusCompleted JobStatus = "completed" JobStatusFailed JobStatus = "failed" JobStatusPaused JobStatus = "paused" JobStatusQueued JobStatus = "queued" JobStatusRequeueing JobStatus = "requeueing" JobStatusUnderConstruction JobStatus = "under-construction" )
Defines values for JobStatus.
type JobStatusChange ¶
type JobStatusChange struct {
// The reason for this status change.
Reason string `json:"reason"`
Status JobStatus `json:"status"`
}
JobStatusChange defines model for JobStatusChange.
type JobStorageInfo ¶
type JobStorageInfo struct {
// 'Checkout ID' used when creating the Shaman checkout for this job. Aids in removing the checkout directory when the job is removed from Flamenco.
ShamanCheckoutId *string `json:"shaman_checkout_id,omitempty"`
}
Storage info of a job, which Flamenco can use to remove job-related files when necessary.
type JobTasksSummary ¶
type JobTasksSummary struct {
Tasks *[]TaskSummary `json:"tasks,omitempty"`
}
Simplified list of tasks of a job. Contains all tasks, but not all info of each task.
type JobsQuery ¶
type JobsQuery struct {
Limit *int `json:"limit,omitempty"`
// Filter by metadata, using `LIKE` notation.
Metadata *JobsQuery_Metadata `json:"metadata,omitempty"`
Offset *int `json:"offset,omitempty"`
OrderBy *[]string `json:"order_by,omitempty"`
// Filter by job settings, using `LIKE` notation.
Settings *JobsQuery_Settings `json:"settings,omitempty"`
// Return only jobs with a status in this array.
StatusIn *[]JobStatus `json:"status_in,omitempty"`
}
JobsQuery defines model for JobsQuery.
type JobsQueryResult ¶
type JobsQueryResult struct {
Jobs []Job `json:"jobs"`
}
JobsQueryResult defines model for JobsQueryResult.
type JobsQuery_Metadata ¶
Filter by metadata, using `LIKE` notation.
func (JobsQuery_Metadata) Get ¶
func (a JobsQuery_Metadata) Get(fieldName string) (value string, found bool)
Getter for additional properties for JobsQuery_Metadata. Returns the specified element and whether it was found
func (JobsQuery_Metadata) MarshalJSON ¶
func (a JobsQuery_Metadata) MarshalJSON() ([]byte, error)
Override default JSON handling for JobsQuery_Metadata to handle AdditionalProperties
func (*JobsQuery_Metadata) Set ¶
func (a *JobsQuery_Metadata) Set(fieldName string, value string)
Setter for additional properties for JobsQuery_Metadata
func (*JobsQuery_Metadata) UnmarshalJSON ¶
func (a *JobsQuery_Metadata) UnmarshalJSON(b []byte) error
Override default JSON handling for JobsQuery_Metadata to handle AdditionalProperties
type JobsQuery_Settings ¶
type JobsQuery_Settings struct {
AdditionalProperties map[string]interface{} `json:"-"`
}
Filter by job settings, using `LIKE` notation.
func (JobsQuery_Settings) Get ¶
func (a JobsQuery_Settings) Get(fieldName string) (value interface{}, found bool)
Getter for additional properties for JobsQuery_Settings. Returns the specified element and whether it was found
func (JobsQuery_Settings) MarshalJSON ¶
func (a JobsQuery_Settings) MarshalJSON() ([]byte, error)
Override default JSON handling for JobsQuery_Settings to handle AdditionalProperties
func (*JobsQuery_Settings) Set ¶
func (a *JobsQuery_Settings) Set(fieldName string, value interface{})
Setter for additional properties for JobsQuery_Settings
func (*JobsQuery_Settings) UnmarshalJSON ¶
func (a *JobsQuery_Settings) UnmarshalJSON(b []byte) error
Override default JSON handling for JobsQuery_Settings to handle AdditionalProperties
type LifeCycleEventType ¶
type LifeCycleEventType string
LifeCycleEventType defines model for LifeCycleEventType.
const ( LifeCycleEventTypeManagerShutdown LifeCycleEventType = "manager-shutdown" LifeCycleEventTypeManagerStartup LifeCycleEventType = "manager-startup" )
Defines values for LifeCycleEventType.
type ManagerConfiguration ¶
type ManagerConfiguration struct {
// Whether this is considered the first time the Manager runs. This is determined by a few factors, like a non-existent configuration file or certain settings being empty while they shouldn't be.
IsFirstRun bool `json:"isFirstRun"`
// Whether the Shaman file transfer API is available.
ShamanEnabled bool `json:"shamanEnabled"`
// Directory used for job file storage.
StorageLocation string `json:"storageLocation"`
}
ManagerConfiguration defines model for ManagerConfiguration.
type ManagerVariable ¶
type ManagerVariable struct {
// One-way variables are the most common one, and are simple replacement from `{name}` to their value, which happens when a Task is given to a Worker. Two-way variables are also replaced when submitting a job, where the platform-specific value is replaced by `{name}`.
IsTwoway bool `json:"is_twoway"`
Value string `json:"value"`
}
ManagerVariable defines model for ManagerVariable.
type ManagerVariableAudience ¶
type ManagerVariableAudience string
ManagerVariableAudience defines model for ManagerVariableAudience.
const ( ManagerVariableAudienceUsers ManagerVariableAudience = "users" ManagerVariableAudienceWorkers ManagerVariableAudience = "workers" )
Defines values for ManagerVariableAudience.
type ManagerVariables ¶
type ManagerVariables struct {
AdditionalProperties map[string]ManagerVariable `json:"-"`
}
Mapping from variable name to its properties.
func (ManagerVariables) Get ¶
func (a ManagerVariables) Get(fieldName string) (value ManagerVariable, found bool)
Getter for additional properties for ManagerVariables. Returns the specified element and whether it was found
func (ManagerVariables) MarshalJSON ¶
func (a ManagerVariables) MarshalJSON() ([]byte, error)
Override default JSON handling for ManagerVariables to handle AdditionalProperties
func (*ManagerVariables) Set ¶
func (a *ManagerVariables) Set(fieldName string, value ManagerVariable)
Setter for additional properties for ManagerVariables
func (*ManagerVariables) UnmarshalJSON ¶
func (a *ManagerVariables) UnmarshalJSON(b []byte) error
Override default JSON handling for ManagerVariables to handle AdditionalProperties
type MayKeepRunning ¶
type MayKeepRunning struct {
MayKeepRunning bool `json:"mayKeepRunning"`
Reason string `json:"reason"`
// Indicates that a status change requested for the worker. It should use the `workerState` operation to determine which state to go to next. If this is `true`, `mayKeepRunning` MUST be `false`.
StatusChangeRequested bool `json:"statusChangeRequested"`
}
Indicates whether the worker may keep running the task.
type MayWorkerRunResponse ¶
type MayWorkerRunResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *MayKeepRunning
JSONDefault *Error
}
func ParseMayWorkerRunResponse ¶
func ParseMayWorkerRunResponse(rsp *http.Response) (*MayWorkerRunResponse, error)
ParseMayWorkerRunResponse parses an HTTP response from a MayWorkerRunWithResponse call
func (MayWorkerRunResponse) Status ¶
func (r MayWorkerRunResponse) Status() string
Status returns HTTPResponse.Status
func (MayWorkerRunResponse) StatusCode ¶
func (r MayWorkerRunResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PathCheckInput ¶
type PathCheckInput struct {
Path string `json:"path"`
}
PathCheckInput defines model for PathCheckInput.
type PathCheckResult ¶
type PathCheckResult struct {
// Description of why this path is (not) usable.
Cause string `json:"cause"`
// Whether the path is usable or not.
IsUsable bool `json:"is_usable"`
// The path that was checked.
Path string `json:"path"`
}
PathCheckResult defines model for PathCheckResult.
type QueryJobsJSONBody ¶
type QueryJobsJSONBody JobsQuery
QueryJobsJSONBody defines parameters for QueryJobs.
type QueryJobsJSONRequestBody ¶
type QueryJobsJSONRequestBody QueryJobsJSONBody
QueryJobsJSONRequestBody defines body for QueryJobs for application/json ContentType.
type QueryJobsResponse ¶
type QueryJobsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *JobsQueryResult
JSONDefault *Error
}
func ParseQueryJobsResponse ¶
func ParseQueryJobsResponse(rsp *http.Response) (*QueryJobsResponse, error)
ParseQueryJobsResponse parses an HTTP response from a QueryJobsWithResponse call
func (QueryJobsResponse) Status ¶
func (r QueryJobsResponse) Status() string
Status returns HTTPResponse.Status
func (QueryJobsResponse) StatusCode ¶
func (r QueryJobsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RegisterWorkerJSONBody ¶
type RegisterWorkerJSONBody WorkerRegistration
RegisterWorkerJSONBody defines parameters for RegisterWorker.
type RegisterWorkerJSONRequestBody ¶
type RegisterWorkerJSONRequestBody RegisterWorkerJSONBody
RegisterWorkerJSONRequestBody defines body for RegisterWorker for application/json ContentType.
type RegisterWorkerResponse ¶
type RegisterWorkerResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *RegisteredWorker
JSONDefault *Error
}
func ParseRegisterWorkerResponse ¶
func ParseRegisterWorkerResponse(rsp *http.Response) (*RegisterWorkerResponse, error)
ParseRegisterWorkerResponse parses an HTTP response from a RegisterWorkerWithResponse call
func (RegisterWorkerResponse) Status ¶
func (r RegisterWorkerResponse) Status() string
Status returns HTTPResponse.Status
func (RegisterWorkerResponse) StatusCode ¶
func (r RegisterWorkerResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RegisteredWorker ¶
type RegisteredWorker struct {
Address string `json:"address"`
Name string `json:"name"`
Platform string `json:"platform"`
Software string `json:"software"`
Status WorkerStatus `json:"status"`
SupportedTaskTypes []string `json:"supported_task_types"`
Uuid string `json:"uuid"`
}
RegisteredWorker defines model for RegisteredWorker.
type RemoveJobBlocklistJSONBody ¶
type RemoveJobBlocklistJSONBody JobBlocklist
RemoveJobBlocklistJSONBody defines parameters for RemoveJobBlocklist.
type RemoveJobBlocklistJSONRequestBody ¶
type RemoveJobBlocklistJSONRequestBody RemoveJobBlocklistJSONBody
RemoveJobBlocklistJSONRequestBody defines body for RemoveJobBlocklist for application/json ContentType.
type RemoveJobBlocklistResponse ¶
type RemoveJobBlocklistResponse struct {
Body []byte
HTTPResponse *http.Response
JSONDefault *Error
}
func ParseRemoveJobBlocklistResponse ¶
func ParseRemoveJobBlocklistResponse(rsp *http.Response) (*RemoveJobBlocklistResponse, error)
ParseRemoveJobBlocklistResponse parses an HTTP response from a RemoveJobBlocklistWithResponse call
func (RemoveJobBlocklistResponse) Status ¶
func (r RemoveJobBlocklistResponse) Status() string
Status returns HTTPResponse.Status
func (RemoveJobBlocklistResponse) StatusCode ¶
func (r RemoveJobBlocklistResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type RequestWorkerStatusChangeJSONBody ¶
type RequestWorkerStatusChangeJSONBody WorkerStatusChangeRequest
RequestWorkerStatusChangeJSONBody defines parameters for RequestWorkerStatusChange.
type RequestWorkerStatusChangeJSONRequestBody ¶
type RequestWorkerStatusChangeJSONRequestBody RequestWorkerStatusChangeJSONBody
RequestWorkerStatusChangeJSONRequestBody defines body for RequestWorkerStatusChange for application/json ContentType.
type RequestWorkerStatusChangeResponse ¶
type RequestWorkerStatusChangeResponse struct {
Body []byte
HTTPResponse *http.Response
JSONDefault *Error
}
func ParseRequestWorkerStatusChangeResponse ¶
func ParseRequestWorkerStatusChangeResponse(rsp *http.Response) (*RequestWorkerStatusChangeResponse, error)
ParseRequestWorkerStatusChangeResponse parses an HTTP response from a RequestWorkerStatusChangeWithResponse call
func (RequestWorkerStatusChangeResponse) Status ¶
func (r RequestWorkerStatusChangeResponse) Status() string
Status returns HTTPResponse.Status
func (RequestWorkerStatusChangeResponse) StatusCode ¶
func (r RequestWorkerStatusChangeResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SaveSetupAssistantConfigJSONBody ¶
type SaveSetupAssistantConfigJSONBody SetupAssistantConfig
SaveSetupAssistantConfigJSONBody defines parameters for SaveSetupAssistantConfig.
type SaveSetupAssistantConfigJSONRequestBody ¶
type SaveSetupAssistantConfigJSONRequestBody SaveSetupAssistantConfigJSONBody
SaveSetupAssistantConfigJSONRequestBody defines body for SaveSetupAssistantConfig for application/json ContentType.
type SaveSetupAssistantConfigResponse ¶
type SaveSetupAssistantConfigResponse struct {
Body []byte
HTTPResponse *http.Response
JSONDefault *Error
}
func ParseSaveSetupAssistantConfigResponse ¶
func ParseSaveSetupAssistantConfigResponse(rsp *http.Response) (*SaveSetupAssistantConfigResponse, error)
ParseSaveSetupAssistantConfigResponse parses an HTTP response from a SaveSetupAssistantConfigWithResponse call
func (SaveSetupAssistantConfigResponse) Status ¶
func (r SaveSetupAssistantConfigResponse) Status() string
Status returns HTTPResponse.Status
func (SaveSetupAssistantConfigResponse) StatusCode ¶
func (r SaveSetupAssistantConfigResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ScheduleTaskResponse ¶
type ScheduleTaskResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *AssignedTask
JSON403 *SecurityError
JSON423 *WorkerStateChange
}
func ParseScheduleTaskResponse ¶
func ParseScheduleTaskResponse(rsp *http.Response) (*ScheduleTaskResponse, error)
ParseScheduleTaskResponse parses an HTTP response from a ScheduleTaskWithResponse call
func (ScheduleTaskResponse) Status ¶
func (r ScheduleTaskResponse) Status() string
Status returns HTTPResponse.Status
func (ScheduleTaskResponse) StatusCode ¶
func (r ScheduleTaskResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SecurityError ¶
type SecurityError struct {
Message string `json:"message"`
}
SecurityError defines model for SecurityError.
type ServerInterface ¶
type ServerInterface interface {
// Get the configuration of this Manager.
// (GET /api/v3/configuration)
GetConfiguration(ctx echo.Context) error
// Find one or more CLI commands for use as way to start Blender
// (GET /api/v3/configuration/check/blender)
FindBlenderExePath(ctx echo.Context) error
// Validate a CLI command for use as way to start Blender
// (POST /api/v3/configuration/check/blender)
CheckBlenderExePath(ctx echo.Context) error
// (POST /api/v3/configuration/check/shared-storage)
CheckSharedStoragePath(ctx echo.Context) error
// Retrieve the configuration of Flamenco Manager.
// (GET /api/v3/configuration/file)
GetConfigurationFile(ctx echo.Context) error
// Update the Manager's configuration, and restart it in fully functional mode.
// (POST /api/v3/configuration/setup-assistant)
SaveSetupAssistantConfig(ctx echo.Context) error
// (GET /api/v3/configuration/shared-storage/{audience}/{platform})
GetSharedStorage(ctx echo.Context, audience ManagerVariableAudience, platform string) error
// Get the variables of this Manager. Used by the Blender add-on to recognise two-way variables, and for the web interface to do variable replacement based on the browser's platform.
// (GET /api/v3/configuration/variables/{audience}/{platform})
GetVariables(ctx echo.Context, audience ManagerVariableAudience, platform string) error
// Submit a new job for Flamenco Manager to execute.
// (POST /api/v3/jobs)
SubmitJob(ctx echo.Context) error
// Submit a new job for Flamenco Manager to check.
// (POST /api/v3/jobs/check)
SubmitJobCheck(ctx echo.Context) error
// Get the URL that serves the last-rendered images.
// (GET /api/v3/jobs/last-rendered)
FetchGlobalLastRenderedInfo(ctx echo.Context) error
// Mark jobs for deletion, based on certain criteria.
// (DELETE /api/v3/jobs/mass-delete)
DeleteJobMass(ctx echo.Context) error
// Fetch list of jobs.
// (POST /api/v3/jobs/query)
QueryJobs(ctx echo.Context) error
// Get single job type and its parameters.
// (GET /api/v3/jobs/type/{typeName})
GetJobType(ctx echo.Context, typeName string) error
// Get list of job types and their parameters.
// (GET /api/v3/jobs/types)
GetJobTypes(ctx echo.Context) error
// Request deletion this job, including its tasks and any log files. The actual deletion may happen in the background. No job files will be deleted (yet).
// (DELETE /api/v3/jobs/{job_id})
DeleteJob(ctx echo.Context, jobId string) error
// Fetch info about the job.
// (GET /api/v3/jobs/{job_id})
FetchJob(ctx echo.Context, jobId string) error
// Remove entries from a job blocklist.
// (DELETE /api/v3/jobs/{job_id}/blocklist)
RemoveJobBlocklist(ctx echo.Context, jobId string) error
// Fetch the list of workers that are blocked from doing certain task types on this job.
// (GET /api/v3/jobs/{job_id}/blocklist)
FetchJobBlocklist(ctx echo.Context, jobId string) error
// Get the URL that serves the last-rendered images of this job.
// (GET /api/v3/jobs/{job_id}/last-rendered)
FetchJobLastRenderedInfo(ctx echo.Context, jobId string) error
// (POST /api/v3/jobs/{job_id}/setpriority)
SetJobPriority(ctx echo.Context, jobId string) error
// (POST /api/v3/jobs/{job_id}/setstatus)
SetJobStatus(ctx echo.Context, jobId string) error
// Fetch a summary of all tasks of the given job.
// (GET /api/v3/jobs/{job_id}/tasks)
FetchJobTasks(ctx echo.Context, jobId string) error
// Get info about what would be deleted when deleting this job. The job itself, its logs, and the last-rendered images will always be deleted. The job files are only deleted conditionally, and this operation can be used to figure that out.
// (GET /api/v3/jobs/{job_id}/what-would-delete-do)
DeleteJobWhatWouldItDo(ctx echo.Context, jobId string) error
// Create a directory, and symlink the required files into it. The files must all have been uploaded to Shaman before calling this endpoint.
// (POST /api/v3/shaman/checkout/create)
ShamanCheckout(ctx echo.Context) error
// Checks a Shaman Requirements file, and reports which files are unknown.
// (POST /api/v3/shaman/checkout/requirements)
ShamanCheckoutRequirements(ctx echo.Context) error
// Check the status of a file on the Shaman server.
// (GET /api/v3/shaman/files/{checksum}/{filesize})
ShamanFileStoreCheck(ctx echo.Context, checksum string, filesize int) error
// Store a new file on the Shaman server. Note that the Shaman server can forcibly close the HTTP connection when another client finishes uploading the exact same file, to prevent double uploads.
// The file's contents should be sent in the request body.
// (POST /api/v3/shaman/files/{checksum}/{filesize})
ShamanFileStore(ctx echo.Context, checksum string, filesize int, params ShamanFileStoreParams) error
// Get the status of this Flamenco farm.
// (GET /api/v3/status)
GetFarmStatus(ctx echo.Context) error
// Fetch a single task.
// (GET /api/v3/tasks/{task_id})
FetchTask(ctx echo.Context, taskId string) error
// Get the URL of the task log, and some more info.
// (GET /api/v3/tasks/{task_id}/log)
FetchTaskLogInfo(ctx echo.Context, taskId string) error
// Fetch the last few lines of the task's log.
// (GET /api/v3/tasks/{task_id}/logtail)
FetchTaskLogTail(ctx echo.Context, taskId string) error
// (POST /api/v3/tasks/{task_id}/setstatus)
SetTaskStatus(ctx echo.Context, taskId string) error
// Get the Flamenco version of this Manager
// (GET /api/v3/version)
GetVersion(ctx echo.Context) error
// Remove this worker tag. This unassigns all workers from the tag and removes it.
// (DELETE /api/v3/worker-mgt/tag/{tag_id})
DeleteWorkerTag(ctx echo.Context, tagId string) error
// Get a single worker tag.
// (GET /api/v3/worker-mgt/tag/{tag_id})
FetchWorkerTag(ctx echo.Context, tagId string) error
// Update an existing worker tag.
// (PUT /api/v3/worker-mgt/tag/{tag_id})
UpdateWorkerTag(ctx echo.Context, tagId string) error
// Get list of worker tags.
// (GET /api/v3/worker-mgt/tags)
FetchWorkerTags(ctx echo.Context) error
// Create a new worker tag.
// (POST /api/v3/worker-mgt/tags)
CreateWorkerTag(ctx echo.Context) error
// Get list of workers.
// (GET /api/v3/worker-mgt/workers)
FetchWorkers(ctx echo.Context) error
// Remove the given worker. It is recommended to only call this function when the worker is in `offline` state. If the worker is still running, stop it first. Any task still assigned to the worker will be requeued.
// (DELETE /api/v3/worker-mgt/workers/{worker_id})
DeleteWorker(ctx echo.Context, workerId string) error
// Fetch info about the worker.
// (GET /api/v3/worker-mgt/workers/{worker_id})
FetchWorker(ctx echo.Context, workerId string) error
// (POST /api/v3/worker-mgt/workers/{worker_id}/setstatus)
RequestWorkerStatusChange(ctx echo.Context, workerId string) error
// (POST /api/v3/worker-mgt/workers/{worker_id}/settags)
SetWorkerTags(ctx echo.Context, workerId string) error
// (GET /api/v3/worker-mgt/workers/{worker_id}/sleep-schedule)
FetchWorkerSleepSchedule(ctx echo.Context, workerId string) error
// (POST /api/v3/worker-mgt/workers/{worker_id}/sleep-schedule)
SetWorkerSleepSchedule(ctx echo.Context, workerId string) error
// Register a new worker
// (POST /api/v3/worker/register-worker)
RegisterWorker(ctx echo.Context) error
// Mark the worker as offline
// (POST /api/v3/worker/sign-off)
SignOff(ctx echo.Context) error
// Authenticate & sign in the worker.
// (POST /api/v3/worker/sign-on)
SignOn(ctx echo.Context) error
// (GET /api/v3/worker/state)
WorkerState(ctx echo.Context) error
// Worker changed state. This could be as acknowledgement of a Manager-requested state change, or in response to worker-local signals.
// (POST /api/v3/worker/state-changed)
WorkerStateChanged(ctx echo.Context) error
// Obtain a new task to execute
// (POST /api/v3/worker/task)
ScheduleTask(ctx echo.Context) error
// Update the task, typically to indicate progress, completion, or failure.
// (POST /api/v3/worker/task/{task_id})
TaskUpdate(ctx echo.Context, taskId string) error
// The response indicates whether the worker is allowed to run / keep running the task. Optionally contains a queued worker status change.
// (GET /api/v3/worker/task/{task_id}/may-i-run)
MayWorkerRun(ctx echo.Context, taskId string) error
// Store the most recently rendered frame here. Note that it is up to the Worker to ensure this is in a format that's digestable by the Manager. Currently only PNG and JPEG support is planned.
// (POST /api/v3/worker/task/{task_id}/output-produced)
TaskOutputProduced(ctx echo.Context, taskId string) error
}
ServerInterface represents all server handlers.
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
}
ServerInterfaceWrapper converts echo contexts to parameters.
func (*ServerInterfaceWrapper) CheckBlenderExePath ¶
func (w *ServerInterfaceWrapper) CheckBlenderExePath(ctx echo.Context) error
CheckBlenderExePath converts echo context to params.
func (*ServerInterfaceWrapper) CheckSharedStoragePath ¶
func (w *ServerInterfaceWrapper) CheckSharedStoragePath(ctx echo.Context) error
CheckSharedStoragePath converts echo context to params.
func (*ServerInterfaceWrapper) CreateWorkerTag ¶
func (w *ServerInterfaceWrapper) CreateWorkerTag(ctx echo.Context) error
CreateWorkerTag converts echo context to params.
func (*ServerInterfaceWrapper) DeleteJob ¶
func (w *ServerInterfaceWrapper) DeleteJob(ctx echo.Context) error
DeleteJob converts echo context to params.
func (*ServerInterfaceWrapper) DeleteJobMass ¶
func (w *ServerInterfaceWrapper) DeleteJobMass(ctx echo.Context) error
DeleteJobMass converts echo context to params.
func (*ServerInterfaceWrapper) DeleteJobWhatWouldItDo ¶
func (w *ServerInterfaceWrapper) DeleteJobWhatWouldItDo(ctx echo.Context) error
DeleteJobWhatWouldItDo converts echo context to params.
func (*ServerInterfaceWrapper) DeleteWorker ¶
func (w *ServerInterfaceWrapper) DeleteWorker(ctx echo.Context) error
DeleteWorker converts echo context to params.
func (*ServerInterfaceWrapper) DeleteWorkerTag ¶
func (w *ServerInterfaceWrapper) DeleteWorkerTag(ctx echo.Context) error
DeleteWorkerTag converts echo context to params.
func (*ServerInterfaceWrapper) FetchGlobalLastRenderedInfo ¶
func (w *ServerInterfaceWrapper) FetchGlobalLastRenderedInfo(ctx echo.Context) error
FetchGlobalLastRenderedInfo converts echo context to params.
func (*ServerInterfaceWrapper) FetchJob ¶
func (w *ServerInterfaceWrapper) FetchJob(ctx echo.Context) error
FetchJob converts echo context to params.
func (*ServerInterfaceWrapper) FetchJobBlocklist ¶
func (w *ServerInterfaceWrapper) FetchJobBlocklist(ctx echo.Context) error
FetchJobBlocklist converts echo context to params.
func (*ServerInterfaceWrapper) FetchJobLastRenderedInfo ¶
func (w *ServerInterfaceWrapper) FetchJobLastRenderedInfo(ctx echo.Context) error
FetchJobLastRenderedInfo converts echo context to params.
func (*ServerInterfaceWrapper) FetchJobTasks ¶
func (w *ServerInterfaceWrapper) FetchJobTasks(ctx echo.Context) error
FetchJobTasks converts echo context to params.
func (*ServerInterfaceWrapper) FetchTask ¶
func (w *ServerInterfaceWrapper) FetchTask(ctx echo.Context) error
FetchTask converts echo context to params.
func (*ServerInterfaceWrapper) FetchTaskLogInfo ¶
func (w *ServerInterfaceWrapper) FetchTaskLogInfo(ctx echo.Context) error
FetchTaskLogInfo converts echo context to params.
func (*ServerInterfaceWrapper) FetchTaskLogTail ¶
func (w *ServerInterfaceWrapper) FetchTaskLogTail(ctx echo.Context) error
FetchTaskLogTail converts echo context to params.
func (*ServerInterfaceWrapper) FetchWorker ¶
func (w *ServerInterfaceWrapper) FetchWorker(ctx echo.Context) error
FetchWorker converts echo context to params.
func (*ServerInterfaceWrapper) FetchWorkerSleepSchedule ¶
func (w *ServerInterfaceWrapper) FetchWorkerSleepSchedule(ctx echo.Context) error
FetchWorkerSleepSchedule converts echo context to params.
func (*ServerInterfaceWrapper) FetchWorkerTag ¶
func (w *ServerInterfaceWrapper) FetchWorkerTag(ctx echo.Context) error
FetchWorkerTag converts echo context to params.
func (*ServerInterfaceWrapper) FetchWorkerTags ¶
func (w *ServerInterfaceWrapper) FetchWorkerTags(ctx echo.Context) error
FetchWorkerTags converts echo context to params.
func (*ServerInterfaceWrapper) FetchWorkers ¶
func (w *ServerInterfaceWrapper) FetchWorkers(ctx echo.Context) error
FetchWorkers converts echo context to params.
func (*ServerInterfaceWrapper) FindBlenderExePath ¶
func (w *ServerInterfaceWrapper) FindBlenderExePath(ctx echo.Context) error
FindBlenderExePath converts echo context to params.
func (*ServerInterfaceWrapper) GetConfiguration ¶
func (w *ServerInterfaceWrapper) GetConfiguration(ctx echo.Context) error
GetConfiguration converts echo context to params.
func (*ServerInterfaceWrapper) GetConfigurationFile ¶
func (w *ServerInterfaceWrapper) GetConfigurationFile(ctx echo.Context) error
GetConfigurationFile converts echo context to params.
func (*ServerInterfaceWrapper) GetFarmStatus ¶
func (w *ServerInterfaceWrapper) GetFarmStatus(ctx echo.Context) error
GetFarmStatus converts echo context to params.
func (*ServerInterfaceWrapper) GetJobType ¶
func (w *ServerInterfaceWrapper) GetJobType(ctx echo.Context) error
GetJobType converts echo context to params.
func (*ServerInterfaceWrapper) GetJobTypes ¶
func (w *ServerInterfaceWrapper) GetJobTypes(ctx echo.Context) error
GetJobTypes converts echo context to params.
func (*ServerInterfaceWrapper) GetSharedStorage ¶
func (w *ServerInterfaceWrapper) GetSharedStorage(ctx echo.Context) error
GetSharedStorage converts echo context to params.
func (*ServerInterfaceWrapper) GetVariables ¶
func (w *ServerInterfaceWrapper) GetVariables(ctx echo.Context) error
GetVariables converts echo context to params.
func (*ServerInterfaceWrapper) GetVersion ¶
func (w *ServerInterfaceWrapper) GetVersion(ctx echo.Context) error
GetVersion converts echo context to params.
func (*ServerInterfaceWrapper) MayWorkerRun ¶
func (w *ServerInterfaceWrapper) MayWorkerRun(ctx echo.Context) error
MayWorkerRun converts echo context to params.
func (*ServerInterfaceWrapper) QueryJobs ¶
func (w *ServerInterfaceWrapper) QueryJobs(ctx echo.Context) error
QueryJobs converts echo context to params.
func (*ServerInterfaceWrapper) RegisterWorker ¶
func (w *ServerInterfaceWrapper) RegisterWorker(ctx echo.Context) error
RegisterWorker converts echo context to params.
func (*ServerInterfaceWrapper) RemoveJobBlocklist ¶
func (w *ServerInterfaceWrapper) RemoveJobBlocklist(ctx echo.Context) error
RemoveJobBlocklist converts echo context to params.
func (*ServerInterfaceWrapper) RequestWorkerStatusChange ¶
func (w *ServerInterfaceWrapper) RequestWorkerStatusChange(ctx echo.Context) error
RequestWorkerStatusChange converts echo context to params.
func (*ServerInterfaceWrapper) SaveSetupAssistantConfig ¶
func (w *ServerInterfaceWrapper) SaveSetupAssistantConfig(ctx echo.Context) error
SaveSetupAssistantConfig converts echo context to params.
func (*ServerInterfaceWrapper) ScheduleTask ¶
func (w *ServerInterfaceWrapper) ScheduleTask(ctx echo.Context) error
ScheduleTask converts echo context to params.
func (*ServerInterfaceWrapper) SetJobPriority ¶
func (w *ServerInterfaceWrapper) SetJobPriority(ctx echo.Context) error
SetJobPriority converts echo context to params.
func (*ServerInterfaceWrapper) SetJobStatus ¶
func (w *ServerInterfaceWrapper) SetJobStatus(ctx echo.Context) error
SetJobStatus converts echo context to params.
func (*ServerInterfaceWrapper) SetTaskStatus ¶
func (w *ServerInterfaceWrapper) SetTaskStatus(ctx echo.Context) error
SetTaskStatus converts echo context to params.
func (*ServerInterfaceWrapper) SetWorkerSleepSchedule ¶
func (w *ServerInterfaceWrapper) SetWorkerSleepSchedule(ctx echo.Context) error
SetWorkerSleepSchedule converts echo context to params.
func (*ServerInterfaceWrapper) SetWorkerTags ¶
func (w *ServerInterfaceWrapper) SetWorkerTags(ctx echo.Context) error
SetWorkerTags converts echo context to params.
func (*ServerInterfaceWrapper) ShamanCheckout ¶
func (w *ServerInterfaceWrapper) ShamanCheckout(ctx echo.Context) error
ShamanCheckout converts echo context to params.
func (*ServerInterfaceWrapper) ShamanCheckoutRequirements ¶
func (w *ServerInterfaceWrapper) ShamanCheckoutRequirements(ctx echo.Context) error
ShamanCheckoutRequirements converts echo context to params.
func (*ServerInterfaceWrapper) ShamanFileStore ¶
func (w *ServerInterfaceWrapper) ShamanFileStore(ctx echo.Context) error
ShamanFileStore converts echo context to params.
func (*ServerInterfaceWrapper) ShamanFileStoreCheck ¶
func (w *ServerInterfaceWrapper) ShamanFileStoreCheck(ctx echo.Context) error
ShamanFileStoreCheck converts echo context to params.
func (*ServerInterfaceWrapper) SignOff ¶
func (w *ServerInterfaceWrapper) SignOff(ctx echo.Context) error
SignOff converts echo context to params.
func (*ServerInterfaceWrapper) SignOn ¶
func (w *ServerInterfaceWrapper) SignOn(ctx echo.Context) error
SignOn converts echo context to params.
func (*ServerInterfaceWrapper) SubmitJob ¶
func (w *ServerInterfaceWrapper) SubmitJob(ctx echo.Context) error
SubmitJob converts echo context to params.
func (*ServerInterfaceWrapper) SubmitJobCheck ¶
func (w *ServerInterfaceWrapper) SubmitJobCheck(ctx echo.Context) error
SubmitJobCheck converts echo context to params.
func (*ServerInterfaceWrapper) TaskOutputProduced ¶
func (w *ServerInterfaceWrapper) TaskOutputProduced(ctx echo.Context) error
TaskOutputProduced converts echo context to params.
func (*ServerInterfaceWrapper) TaskUpdate ¶
func (w *ServerInterfaceWrapper) TaskUpdate(ctx echo.Context) error
TaskUpdate converts echo context to params.
func (*ServerInterfaceWrapper) UpdateWorkerTag ¶
func (w *ServerInterfaceWrapper) UpdateWorkerTag(ctx echo.Context) error
UpdateWorkerTag converts echo context to params.
func (*ServerInterfaceWrapper) WorkerState ¶
func (w *ServerInterfaceWrapper) WorkerState(ctx echo.Context) error
WorkerState converts echo context to params.
func (*ServerInterfaceWrapper) WorkerStateChanged ¶
func (w *ServerInterfaceWrapper) WorkerStateChanged(ctx echo.Context) error
WorkerStateChanged converts echo context to params.
type SetJobPriorityJSONBody ¶
type SetJobPriorityJSONBody JobPriorityChange
SetJobPriorityJSONBody defines parameters for SetJobPriority.
type SetJobPriorityJSONRequestBody ¶
type SetJobPriorityJSONRequestBody SetJobPriorityJSONBody
SetJobPriorityJSONRequestBody defines body for SetJobPriority for application/json ContentType.
type SetJobPriorityResponse ¶
func ParseSetJobPriorityResponse ¶
func ParseSetJobPriorityResponse(rsp *http.Response) (*SetJobPriorityResponse, error)
ParseSetJobPriorityResponse parses an HTTP response from a SetJobPriorityWithResponse call
func (SetJobPriorityResponse) Status ¶
func (r SetJobPriorityResponse) Status() string
Status returns HTTPResponse.Status
func (SetJobPriorityResponse) StatusCode ¶
func (r SetJobPriorityResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SetJobStatusJSONBody ¶
type SetJobStatusJSONBody JobStatusChange
SetJobStatusJSONBody defines parameters for SetJobStatus.
type SetJobStatusJSONRequestBody ¶
type SetJobStatusJSONRequestBody SetJobStatusJSONBody
SetJobStatusJSONRequestBody defines body for SetJobStatus for application/json ContentType.
type SetJobStatusResponse ¶
func ParseSetJobStatusResponse ¶
func ParseSetJobStatusResponse(rsp *http.Response) (*SetJobStatusResponse, error)
ParseSetJobStatusResponse parses an HTTP response from a SetJobStatusWithResponse call
func (SetJobStatusResponse) Status ¶
func (r SetJobStatusResponse) Status() string
Status returns HTTPResponse.Status
func (SetJobStatusResponse) StatusCode ¶
func (r SetJobStatusResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SetTaskStatusJSONBody ¶
type SetTaskStatusJSONBody TaskStatusChange
SetTaskStatusJSONBody defines parameters for SetTaskStatus.
type SetTaskStatusJSONRequestBody ¶
type SetTaskStatusJSONRequestBody SetTaskStatusJSONBody
SetTaskStatusJSONRequestBody defines body for SetTaskStatus for application/json ContentType.
type SetTaskStatusResponse ¶
func ParseSetTaskStatusResponse ¶
func ParseSetTaskStatusResponse(rsp *http.Response) (*SetTaskStatusResponse, error)
ParseSetTaskStatusResponse parses an HTTP response from a SetTaskStatusWithResponse call
func (SetTaskStatusResponse) Status ¶
func (r SetTaskStatusResponse) Status() string
Status returns HTTPResponse.Status
func (SetTaskStatusResponse) StatusCode ¶
func (r SetTaskStatusResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SetWorkerSleepScheduleJSONBody ¶
type SetWorkerSleepScheduleJSONBody WorkerSleepSchedule
SetWorkerSleepScheduleJSONBody defines parameters for SetWorkerSleepSchedule.
type SetWorkerSleepScheduleJSONRequestBody ¶
type SetWorkerSleepScheduleJSONRequestBody SetWorkerSleepScheduleJSONBody
SetWorkerSleepScheduleJSONRequestBody defines body for SetWorkerSleepSchedule for application/json ContentType.
type SetWorkerSleepScheduleResponse ¶
type SetWorkerSleepScheduleResponse struct {
Body []byte
HTTPResponse *http.Response
JSONDefault *Error
}
func ParseSetWorkerSleepScheduleResponse ¶
func ParseSetWorkerSleepScheduleResponse(rsp *http.Response) (*SetWorkerSleepScheduleResponse, error)
ParseSetWorkerSleepScheduleResponse parses an HTTP response from a SetWorkerSleepScheduleWithResponse call
func (SetWorkerSleepScheduleResponse) Status ¶
func (r SetWorkerSleepScheduleResponse) Status() string
Status returns HTTPResponse.Status
func (SetWorkerSleepScheduleResponse) StatusCode ¶
func (r SetWorkerSleepScheduleResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SetWorkerTagsJSONBody ¶
type SetWorkerTagsJSONBody WorkerTagChangeRequest
SetWorkerTagsJSONBody defines parameters for SetWorkerTags.
type SetWorkerTagsJSONRequestBody ¶
type SetWorkerTagsJSONRequestBody SetWorkerTagsJSONBody
SetWorkerTagsJSONRequestBody defines body for SetWorkerTags for application/json ContentType.
type SetWorkerTagsResponse ¶
func ParseSetWorkerTagsResponse ¶
func ParseSetWorkerTagsResponse(rsp *http.Response) (*SetWorkerTagsResponse, error)
ParseSetWorkerTagsResponse parses an HTTP response from a SetWorkerTagsWithResponse call
func (SetWorkerTagsResponse) Status ¶
func (r SetWorkerTagsResponse) Status() string
Status returns HTTPResponse.Status
func (SetWorkerTagsResponse) StatusCode ¶
func (r SetWorkerTagsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SetupAssistantConfig ¶
type SetupAssistantConfig struct {
BlenderExecutable BlenderPathCheckResult `json:"blenderExecutable"`
// Directory used for job file storage.
StorageLocation string `json:"storageLocation"`
}
Configuration obtained from the Setup Assistant.
type ShamanCheckout ¶
type ShamanCheckout struct {
// Path where the Manager should create this checkout. It is relative to the Shaman checkout path as configured on the Manager. In older versions of the Shaman this was just the "checkout ID", but in this version it can be a path like `project-slug/scene-name/unique-ID`.
CheckoutPath string `json:"checkoutPath"`
Files []ShamanFileSpec `json:"files"`
}
Set of files with their SHA256 checksum, size in bytes, and desired location in the checkout directory.
type ShamanCheckoutJSONBody ¶
type ShamanCheckoutJSONBody ShamanCheckout
ShamanCheckoutJSONBody defines parameters for ShamanCheckout.
type ShamanCheckoutJSONRequestBody ¶
type ShamanCheckoutJSONRequestBody ShamanCheckoutJSONBody
ShamanCheckoutJSONRequestBody defines body for ShamanCheckout for application/json ContentType.
type ShamanCheckoutRequirementsJSONBody ¶
type ShamanCheckoutRequirementsJSONBody ShamanRequirementsRequest
ShamanCheckoutRequirementsJSONBody defines parameters for ShamanCheckoutRequirements.
type ShamanCheckoutRequirementsJSONRequestBody ¶
type ShamanCheckoutRequirementsJSONRequestBody ShamanCheckoutRequirementsJSONBody
ShamanCheckoutRequirementsJSONRequestBody defines body for ShamanCheckoutRequirements for application/json ContentType.
type ShamanCheckoutRequirementsResponse ¶
type ShamanCheckoutRequirementsResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShamanRequirementsResponse
JSONDefault *Error
}
func ParseShamanCheckoutRequirementsResponse ¶
func ParseShamanCheckoutRequirementsResponse(rsp *http.Response) (*ShamanCheckoutRequirementsResponse, error)
ParseShamanCheckoutRequirementsResponse parses an HTTP response from a ShamanCheckoutRequirementsWithResponse call
func (ShamanCheckoutRequirementsResponse) Status ¶
func (r ShamanCheckoutRequirementsResponse) Status() string
Status returns HTTPResponse.Status
func (ShamanCheckoutRequirementsResponse) StatusCode ¶
func (r ShamanCheckoutRequirementsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ShamanCheckoutResponse ¶
type ShamanCheckoutResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShamanCheckoutResult
JSON409 *Error
JSON424 *Error
JSONDefault *Error
}
func ParseShamanCheckoutResponse ¶
func ParseShamanCheckoutResponse(rsp *http.Response) (*ShamanCheckoutResponse, error)
ParseShamanCheckoutResponse parses an HTTP response from a ShamanCheckoutWithResponse call
func (ShamanCheckoutResponse) Status ¶
func (r ShamanCheckoutResponse) Status() string
Status returns HTTPResponse.Status
func (ShamanCheckoutResponse) StatusCode ¶
func (r ShamanCheckoutResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ShamanCheckoutResult ¶
type ShamanCheckoutResult struct {
// Path where the Manager created this checkout. This can be different than what was requested, as the Manager will ensure a unique directory. The path is relative to the Shaman checkout path as configured on the Manager.
CheckoutPath string `json:"checkoutPath"`
}
The result of a Shaman checkout.
type ShamanFileSpec ¶
type ShamanFileSpec struct {
// Location of the file in the checkout
Path string `json:"path"`
// SHA256 checksum of the file
Sha string `json:"sha"`
// File size in bytes
Size int `json:"size"`
}
Specification of a file in the Shaman storage.
type ShamanFileSpecWithStatus ¶
type ShamanFileSpecWithStatus struct {
// Location of the file in the checkout
Path string `json:"path"`
// SHA256 checksum of the file
Sha string `json:"sha"`
// File size in bytes
Size int `json:"size"`
Status ShamanFileStatus `json:"status"`
}
Specification of a file, which could be in the Shaman storage, or not, depending on its status.
type ShamanFileStatus ¶
type ShamanFileStatus string
ShamanFileStatus defines model for ShamanFileStatus.
const ( ShamanFileStatusStored ShamanFileStatus = "stored" ShamanFileStatusUnknown ShamanFileStatus = "unknown" ShamanFileStatusUploading ShamanFileStatus = "uploading" )
Defines values for ShamanFileStatus.
type ShamanFileStoreCheckResponse ¶
type ShamanFileStoreCheckResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *ShamanSingleFileStatus
JSONDefault *Error
}
func ParseShamanFileStoreCheckResponse ¶
func ParseShamanFileStoreCheckResponse(rsp *http.Response) (*ShamanFileStoreCheckResponse, error)
ParseShamanFileStoreCheckResponse parses an HTTP response from a ShamanFileStoreCheckWithResponse call
func (ShamanFileStoreCheckResponse) Status ¶
func (r ShamanFileStoreCheckResponse) Status() string
Status returns HTTPResponse.Status
func (ShamanFileStoreCheckResponse) StatusCode ¶
func (r ShamanFileStoreCheckResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ShamanFileStoreParams ¶
type ShamanFileStoreParams struct {
// The client indicates that it can defer uploading this file. The "208" response will not only be returned when the file is already fully known to the Shaman server, but also when someone else is currently uploading this file.
XShamanCanDeferUpload *bool `json:"X-Shaman-Can-Defer-Upload,omitempty"`
// The original filename. If sent along with the request, it will be included in the server logs, which can aid in debugging.
XShamanOriginalFilename *string `json:"X-Shaman-Original-Filename,omitempty"`
}
ShamanFileStoreParams defines parameters for ShamanFileStore.
type ShamanFileStoreResponse ¶
func ParseShamanFileStoreResponse ¶
func ParseShamanFileStoreResponse(rsp *http.Response) (*ShamanFileStoreResponse, error)
ParseShamanFileStoreResponse parses an HTTP response from a ShamanFileStoreWithResponse call
func (ShamanFileStoreResponse) Status ¶
func (r ShamanFileStoreResponse) Status() string
Status returns HTTPResponse.Status
func (ShamanFileStoreResponse) StatusCode ¶
func (r ShamanFileStoreResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ShamanRequirementsRequest ¶
type ShamanRequirementsRequest struct {
Files []ShamanFileSpec `json:"files"`
}
Set of files with their SHA256 checksum and size in bytes.
type ShamanRequirementsResponse ¶
type ShamanRequirementsResponse struct {
Files []ShamanFileSpecWithStatus `json:"files"`
}
The files from a requirements request, with their status on the Shaman server. Files that are known to Shaman are excluded from the response.
type ShamanSingleFileStatus ¶
type ShamanSingleFileStatus struct {
Status ShamanFileStatus `json:"status"`
}
Status of a file in the Shaman storage.
type SharedStorageLocation ¶
type SharedStorageLocation struct {
ShamanEnabled bool `json:"shamanEnabled"`
}
Location of the shared storage, adjusted for a specific audience & platform. This uses two-way variables to adjust the shared storage path from the Manager's configuration.
type SignOffResponse ¶
func ParseSignOffResponse ¶
func ParseSignOffResponse(rsp *http.Response) (*SignOffResponse, error)
ParseSignOffResponse parses an HTTP response from a SignOffWithResponse call
func (SignOffResponse) Status ¶
func (r SignOffResponse) Status() string
Status returns HTTPResponse.Status
func (SignOffResponse) StatusCode ¶
func (r SignOffResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SignOnJSONBody ¶
type SignOnJSONBody WorkerSignOn
SignOnJSONBody defines parameters for SignOn.
type SignOnJSONRequestBody ¶
type SignOnJSONRequestBody SignOnJSONBody
SignOnJSONRequestBody defines body for SignOn for application/json ContentType.
type SignOnResponse ¶
type SignOnResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *WorkerStateChange
JSONDefault *Error
}
func ParseSignOnResponse ¶
func ParseSignOnResponse(rsp *http.Response) (*SignOnResponse, error)
ParseSignOnResponse parses an HTTP response from a SignOnWithResponse call
func (SignOnResponse) Status ¶
func (r SignOnResponse) Status() string
Status returns HTTPResponse.Status
func (SignOnResponse) StatusCode ¶
func (r SignOnResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SocketIOSubscription ¶
type SocketIOSubscription struct {
Op SocketIOSubscriptionOperation `json:"op"`
// What kind of thing to subscribe to / unsubscribe from.
Type SocketIOSubscriptionType `json:"type"`
// UUID of the thing to subscribe to / unsubscribe from.
Uuid *string `json:"uuid,omitempty"`
}
Send by SocketIO clients as `/subscription` event type, to manage their subscription to job updates. Clients always get job updates, but for task updates or task logs they need to explicitly subscribe. For simplicity, clients can only subscribe to one job (to get task updates for that job) and one task's log at a time. This is not used by MQTT, as with that protocol the subscriptions are managed by the MQTT broker, not Flamenco.
type SocketIOSubscriptionOperation ¶
type SocketIOSubscriptionOperation string
SocketIOSubscriptionOperation defines model for SocketIOSubscriptionOperation.
const ( SocketIOSubscriptionOperationSubscribe SocketIOSubscriptionOperation = "subscribe" SocketIOSubscriptionOperationUnsubscribe SocketIOSubscriptionOperation = "unsubscribe" )
Defines values for SocketIOSubscriptionOperation.
type SocketIOSubscriptionType ¶
type SocketIOSubscriptionType string
What kind of thing to subscribe to / unsubscribe from.
const ( SocketIOSubscriptionTypeAllJobs SocketIOSubscriptionType = "allJobs" SocketIOSubscriptionTypeAllLastRendered SocketIOSubscriptionType = "allLastRendered" SocketIOSubscriptionTypeAllWorkerTags SocketIOSubscriptionType = "allWorkerTags" SocketIOSubscriptionTypeAllWorkers SocketIOSubscriptionType = "allWorkers" SocketIOSubscriptionTypeJob SocketIOSubscriptionType = "job" SocketIOSubscriptionTypeTasklog SocketIOSubscriptionType = "tasklog" )
Defines values for SocketIOSubscriptionType.
type SubmitJobCheckJSONBody ¶
type SubmitJobCheckJSONBody SubmittedJob
SubmitJobCheckJSONBody defines parameters for SubmitJobCheck.
type SubmitJobCheckJSONRequestBody ¶
type SubmitJobCheckJSONRequestBody SubmitJobCheckJSONBody
SubmitJobCheckJSONRequestBody defines body for SubmitJobCheck for application/json ContentType.
type SubmitJobCheckResponse ¶
type SubmitJobCheckResponse struct {
Body []byte
HTTPResponse *http.Response
JSON412 *Error
JSONDefault *Error
}
func ParseSubmitJobCheckResponse ¶
func ParseSubmitJobCheckResponse(rsp *http.Response) (*SubmitJobCheckResponse, error)
ParseSubmitJobCheckResponse parses an HTTP response from a SubmitJobCheckWithResponse call
func (SubmitJobCheckResponse) Status ¶
func (r SubmitJobCheckResponse) Status() string
Status returns HTTPResponse.Status
func (SubmitJobCheckResponse) StatusCode ¶
func (r SubmitJobCheckResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SubmitJobJSONBody ¶
type SubmitJobJSONBody SubmittedJob
SubmitJobJSONBody defines parameters for SubmitJob.
type SubmitJobJSONRequestBody ¶
type SubmitJobJSONRequestBody SubmitJobJSONBody
SubmitJobJSONRequestBody defines body for SubmitJob for application/json ContentType.
type SubmitJobResponse ¶
type SubmitJobResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *Job
JSON412 *Error
JSONDefault *Error
}
func ParseSubmitJobResponse ¶
func ParseSubmitJobResponse(rsp *http.Response) (*SubmitJobResponse, error)
ParseSubmitJobResponse parses an HTTP response from a SubmitJobWithResponse call
func (SubmitJobResponse) Status ¶
func (r SubmitJobResponse) Status() string
Status returns HTTPResponse.Status
func (SubmitJobResponse) StatusCode ¶
func (r SubmitJobResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type SubmittedJob ¶
type SubmittedJob struct {
// Arbitrary metadata strings. More complex structures can be modeled by using `a.b.c` notation for the key.
Metadata *JobMetadata `json:"metadata,omitempty"`
Name string `json:"name"`
Priority int `json:"priority"`
Settings *JobSettings `json:"settings,omitempty"`
// Storage info of a job, which Flamenco can use to remove job-related files when necessary.
Storage *JobStorageInfo `json:"storage,omitempty"`
// Operating system of the submitter. This is used to recognise two-way variables. This should be a lower-case version of the platform, like "linux", "windows", "darwin", "openbsd", etc. Should be ompatible with Go's `runtime.GOOS`; run `go tool dist list` to get a list of possible platforms.
// As a special case, the platform "manager" can be given, which will be interpreted as "the Manager's platform". This is mostly to make test/debug scripts easier, as they can use a static document on all platforms.
SubmitterPlatform string `json:"submitter_platform"`
Type string `json:"type"`
// Hash of the job type, copied from the `AvailableJobType.etag` property of the job type. The job will be rejected if this field doesn't match the actual job type on the Manager. This prevents job submission with old settings, after the job compiler script has been updated.
// If this field is ommitted, the check is bypassed.
TypeEtag *string `json:"type_etag,omitempty"`
// Worker tag that should execute this job. When a tag ID is given, only Workers in that tag will be scheduled to work on it. If empty or ommitted, all workers can work on this job.
WorkerTag *string `json:"worker_tag,omitempty"`
}
Job definition submitted to Flamenco.
type Task ¶
type Task struct {
Activity string `json:"activity"`
Commands []Command `json:"commands"`
// Creation timestamp
Created time.Time `json:"created"`
FailedByWorkers *[]TaskWorker `json:"failed_by_workers,omitempty"`
Id string `json:"id"`
JobId string `json:"job_id"`
// Timestamp of when any worker worked on this task.
LastTouched *time.Time `json:"last_touched,omitempty"`
Name string `json:"name"`
Priority int `json:"priority"`
Status TaskStatus `json:"status"`
TaskType string `json:"task_type"`
// Timestamp of last update.
Updated time.Time `json:"updated"`
// Worker reference, as used in Task objects.
Worker *TaskWorker `json:"worker,omitempty"`
}
The task as it exists in the Manager database, i.e. before variable replacement.
type TaskLogInfo ¶
type TaskLogInfo struct {
JobId string `json:"job_id"`
// The size of the task log, in bytes.
Size int `json:"size"`
TaskId string `json:"task_id"`
// The URL at which the task log itself can be downloaded.
Url string `json:"url"`
}
Info about the log of a single task.
type TaskOutputProducedResponse ¶
type TaskOutputProducedResponse struct {
Body []byte
HTTPResponse *http.Response
JSON411 *Error
JSON413 *Error
JSON415 *Error
JSON429 *Error
JSONDefault *Error
}
func ParseTaskOutputProducedResponse ¶
func ParseTaskOutputProducedResponse(rsp *http.Response) (*TaskOutputProducedResponse, error)
ParseTaskOutputProducedResponse parses an HTTP response from a TaskOutputProducedWithResponse call
func (TaskOutputProducedResponse) Status ¶
func (r TaskOutputProducedResponse) Status() string
Status returns HTTPResponse.Status
func (TaskOutputProducedResponse) StatusCode ¶
func (r TaskOutputProducedResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type TaskStatus ¶
type TaskStatus string
TaskStatus defines model for TaskStatus.
const ( TaskStatusActive TaskStatus = "active" TaskStatusCanceled TaskStatus = "canceled" TaskStatusCompleted TaskStatus = "completed" TaskStatusFailed TaskStatus = "failed" TaskStatusPaused TaskStatus = "paused" TaskStatusQueued TaskStatus = "queued" TaskStatusSoftFailed TaskStatus = "soft-failed" )
Defines values for TaskStatus.
type TaskStatusChange ¶
type TaskStatusChange struct {
// The reason for this status change.
Reason string `json:"reason"`
Status TaskStatus `json:"status"`
}
TaskStatusChange defines model for TaskStatusChange.
type TaskSummary ¶
type TaskSummary struct {
Id string `json:"id"`
Name string `json:"name"`
Priority int `json:"priority"`
Status TaskStatus `json:"status"`
TaskType string `json:"task_type"`
Updated time.Time `json:"updated"`
}
Just enough information about the task to show in the job's task list.
type TaskUpdate ¶
type TaskUpdate struct {
// One-liner to indicate what's currently happening with the task. Overwrites previously sent activity strings.
Activity *string `json:"activity,omitempty"`
// Log lines for this task, will be appended to logs sent earlier.
Log *string `json:"log,omitempty"`
TaskStatus *TaskStatus `json:"taskStatus,omitempty"`
}
TaskUpdate is sent by a Worker to update the status & logs of a task it's executing. All properties are optional; omitted properties are ignored (i.e. omitting `activity` will not erase the activity property of the task).
type TaskUpdateJSONBody ¶
type TaskUpdateJSONBody TaskUpdate
TaskUpdateJSONBody defines parameters for TaskUpdate.
type TaskUpdateJSONRequestBody ¶
type TaskUpdateJSONRequestBody TaskUpdateJSONBody
TaskUpdateJSONRequestBody defines body for TaskUpdate for application/json ContentType.
type TaskUpdateResponse ¶
func ParseTaskUpdateResponse ¶
func ParseTaskUpdateResponse(rsp *http.Response) (*TaskUpdateResponse, error)
ParseTaskUpdateResponse parses an HTTP response from a TaskUpdateWithResponse call
func (TaskUpdateResponse) Status ¶
func (r TaskUpdateResponse) Status() string
Status returns HTTPResponse.Status
func (TaskUpdateResponse) StatusCode ¶
func (r TaskUpdateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type TaskWorker ¶
type TaskWorker struct {
Address string `json:"address"`
Id string `json:"id"`
Name string `json:"name"`
}
Worker reference, as used in Task objects.
type UpdateWorkerTagJSONBody ¶
type UpdateWorkerTagJSONBody WorkerTag
UpdateWorkerTagJSONBody defines parameters for UpdateWorkerTag.
type UpdateWorkerTagJSONRequestBody ¶
type UpdateWorkerTagJSONRequestBody UpdateWorkerTagJSONBody
UpdateWorkerTagJSONRequestBody defines body for UpdateWorkerTag for application/json ContentType.
type UpdateWorkerTagResponse ¶
func ParseUpdateWorkerTagResponse ¶
func ParseUpdateWorkerTagResponse(rsp *http.Response) (*UpdateWorkerTagResponse, error)
ParseUpdateWorkerTagResponse parses an HTTP response from a UpdateWorkerTagWithResponse call
func (UpdateWorkerTagResponse) Status ¶
func (r UpdateWorkerTagResponse) Status() string
Status returns HTTPResponse.Status
func (UpdateWorkerTagResponse) StatusCode ¶
func (r UpdateWorkerTagResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Worker ¶
type Worker struct {
// Embedded struct due to allOf(#/components/schemas/WorkerSummary)
WorkerSummary `yaml:",inline"`
// Embedded fields due to inline allOf schema
// IP address of the Worker
IpAddress string `json:"ip_address"`
// Operating system of the Worker
Platform string `json:"platform"`
SupportedTaskTypes []string `json:"supported_task_types"`
// Tags of which this Worker is a member.
Tags *[]WorkerTag `json:"tags,omitempty"`
// Task assigned to a Worker.
Task *WorkerTask `json:"task,omitempty"`
}
Worker defines model for Worker.
type WorkerList ¶
type WorkerList struct {
Workers []WorkerSummary `json:"workers"`
}
List of workers.
type WorkerRegistration ¶
type WorkerRegistration struct {
Name string `json:"name"`
Platform string `json:"platform"`
Secret string `json:"secret"`
SupportedTaskTypes []string `json:"supported_task_types"`
}
WorkerRegistration defines model for WorkerRegistration.
type WorkerSignOn ¶
type WorkerSignOn struct {
CanRestart *bool `json:"can_restart,omitempty"`
Name string `json:"name"`
SoftwareVersion string `json:"software_version"`
SupportedTaskTypes []string `json:"supported_task_types"`
}
WorkerSignOn defines model for WorkerSignOn.
type WorkerSleepSchedule ¶
type WorkerSleepSchedule struct {
// Space-separated two-letter strings indicating days of week the schedule is active ("mo", "tu", etc.). Empty means "every day".
DaysOfWeek string `json:"days_of_week"`
EndTime string `json:"end_time"`
IsActive bool `json:"is_active"`
StartTime string `json:"start_time"`
}
Sleep schedule for a single Worker. Start and end time indicate the time of each day at which the schedule is active. Applies only when today is in `days_of_week`, or when `days_of_week` is empty. Start and end time are in 24-hour HH:MM notation.
type WorkerStateChange ¶
type WorkerStateChange struct {
StatusRequested WorkerStatus `json:"status_requested"`
}
WorkerStateChange defines model for WorkerStateChange.
type WorkerStateChanged ¶
type WorkerStateChanged struct {
Status WorkerStatus `json:"status"`
}
WorkerStateChanged defines model for WorkerStateChanged.
type WorkerStateChangedJSONBody ¶
type WorkerStateChangedJSONBody WorkerStateChanged
WorkerStateChangedJSONBody defines parameters for WorkerStateChanged.
type WorkerStateChangedJSONRequestBody ¶
type WorkerStateChangedJSONRequestBody WorkerStateChangedJSONBody
WorkerStateChangedJSONRequestBody defines body for WorkerStateChanged for application/json ContentType.
type WorkerStateChangedResponse ¶
type WorkerStateChangedResponse struct {
Body []byte
HTTPResponse *http.Response
JSONDefault *Error
}
func ParseWorkerStateChangedResponse ¶
func ParseWorkerStateChangedResponse(rsp *http.Response) (*WorkerStateChangedResponse, error)
ParseWorkerStateChangedResponse parses an HTTP response from a WorkerStateChangedWithResponse call
func (WorkerStateChangedResponse) Status ¶
func (r WorkerStateChangedResponse) Status() string
Status returns HTTPResponse.Status
func (WorkerStateChangedResponse) StatusCode ¶
func (r WorkerStateChangedResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type WorkerStateResponse ¶
type WorkerStateResponse struct {
Body []byte
HTTPResponse *http.Response
JSON200 *WorkerStateChange
JSONDefault *Error
}
func ParseWorkerStateResponse ¶
func ParseWorkerStateResponse(rsp *http.Response) (*WorkerStateResponse, error)
ParseWorkerStateResponse parses an HTTP response from a WorkerStateWithResponse call
func (WorkerStateResponse) Status ¶
func (r WorkerStateResponse) Status() string
Status returns HTTPResponse.Status
func (WorkerStateResponse) StatusCode ¶
func (r WorkerStateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type WorkerStatus ¶
type WorkerStatus string
WorkerStatus defines model for WorkerStatus.
const ( WorkerStatusAsleep WorkerStatus = "asleep" WorkerStatusAwake WorkerStatus = "awake" WorkerStatusError WorkerStatus = "error" WorkerStatusOffline WorkerStatus = "offline" WorkerStatusRestart WorkerStatus = "restart" WorkerStatusStarting WorkerStatus = "starting" WorkerStatusTesting WorkerStatus = "testing" )
Defines values for WorkerStatus.
type WorkerStatusChangeRequest ¶
type WorkerStatusChangeRequest struct {
// Whether the status change should happen immediately, or after the worker's current task is finished.
IsLazy bool `json:"is_lazy"`
Status WorkerStatus `json:"status"`
}
Request for a Worker to change its status to `status`.
type WorkerSummary ¶
type WorkerSummary struct {
// Whether this worker can auto-restart.
CanRestart bool `json:"can_restart"`
Id string `json:"id"`
// Last time this worker was seen by the Manager.
LastSeen *time.Time `json:"last_seen,omitempty"`
Name string `json:"name"`
Status WorkerStatus `json:"status"`
// Request for a Worker to change its status to `status`.
StatusChange *WorkerStatusChangeRequest `json:"status_change,omitempty"`
// Version of Flamenco this Worker is running
Version string `json:"version"`
}
Basic information about a Worker.
type WorkerTag ¶
type WorkerTag struct {
Description *string `json:"description,omitempty"`
// UUID of the tag. Can be ommitted when creating a new tag, in which case a random UUID will be assigned.
Id *string `json:"id,omitempty"`
Name string `json:"name"`
}
Tag of workers. A job can optionally specify which tag it should be limited to. Workers can be part of multiple tags simultaneously.
type WorkerTagChangeRequest ¶
type WorkerTagChangeRequest struct {
TagIds []string `json:"tag_ids"`
}
Request to change which tags this Worker is assigned to.
type WorkerTagList ¶
type WorkerTagList struct {
Tags *[]WorkerTag `json:"tags,omitempty"`
}
WorkerTagList defines model for WorkerTagList.
type WorkerTask ¶
type WorkerTask struct {
// Embedded struct due to allOf(#/components/schemas/TaskSummary)
TaskSummary `yaml:",inline"`
// Embedded fields due to inline allOf schema
JobId string `json:"job_id"`
}
WorkerTask defines model for WorkerTask.
Source Files
Click to show internal directories.
Click to hide internal directories.