All URIs are relative to http://localhost/api/v1
Method | HTTP request | Description |
---|---|---|
DeleteDag | Delete /dags/{dag_id} | Delete a DAG |
GetDag | Get /dags/{dag_id} | Get basic information about a DAG |
GetDagDetails | Get /dags/{dag_id}/details | Get a simplified representation of DAG |
GetDagSource | Get /dagSources/{file_token} | Get a source code |
GetDags | Get /dags | List DAGs |
GetTask | Get /dags/{dag_id}/tasks/{task_id} | Get simplified representation of a task |
GetTasks | Get /dags/{dag_id}/tasks | Get tasks for DAG |
PatchDag | Patch /dags/{dag_id} | Update a DAG |
PostClearTaskInstances | Post /dags/{dag_id}/clearTaskInstances | Clear a set of task instances |
PostSetTaskInstancesState | Post /dags/{dag_id}/updateTaskInstancesState | Set a state of task instances |
DeleteDag(ctx, dagId).Execute()
Delete a DAG
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { dagId := "dagId_example" // string | The DAG ID. configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGApi.DeleteDag(context.Background(), dagId).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGApi.DeleteDag``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } }
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
dagId | string | The DAG ID. |
Other parameters are passed through a pointer to a apiDeleteDagRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
No authorization required
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DAG GetDag(ctx, dagId).Execute()
Get basic information about a DAG
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { dagId := "dagId_example" // string | The DAG ID. configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGApi.GetDag(context.Background(), dagId).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGApi.GetDag``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `GetDag`: DAG fmt.Fprintf(os.Stdout, "Response from `DAGApi.GetDag`: %v\n", resp) }
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
dagId | string | The DAG ID. |
Other parameters are passed through a pointer to a apiGetDagRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
No authorization required
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DAGDetail GetDagDetails(ctx, dagId).Execute()
Get a simplified representation of DAG
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { dagId := "dagId_example" // string | The DAG ID. configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGApi.GetDagDetails(context.Background(), dagId).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGApi.GetDagDetails``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `GetDagDetails`: DAGDetail fmt.Fprintf(os.Stdout, "Response from `DAGApi.GetDagDetails`: %v\n", resp) }
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
dagId | string | The DAG ID. |
Other parameters are passed through a pointer to a apiGetDagDetailsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
No authorization required
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse2001 GetDagSource(ctx, fileToken).Execute()
Get a source code
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { fileToken := "fileToken_example" // string | The key containing the encrypted path to the file. Encryption and decryption take place only on the server. This prevents the client from reading an non-DAG file. This also ensures API extensibility, because the format of encrypted data may change. configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGApi.GetDagSource(context.Background(), fileToken).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGApi.GetDagSource``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `GetDagSource`: InlineResponse2001 fmt.Fprintf(os.Stdout, "Response from `DAGApi.GetDagSource`: %v\n", resp) }
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
fileToken | string | The key containing the encrypted path to the file. Encryption and decryption take place only on the server. This prevents the client from reading an non-DAG file. This also ensures API extensibility, because the format of encrypted data may change. |
Other parameters are passed through a pointer to a apiGetDagSourceRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
No authorization required
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DAGCollection GetDags(ctx).Limit(limit).Offset(offset).OrderBy(orderBy).Tags(tags).OnlyActive(onlyActive).Execute()
List DAGs
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { limit := int32(56) // int32 | The numbers of items to return. (optional) (default to 100) offset := int32(56) // int32 | The number of items to skip before starting to collect the result set. (optional) orderBy := "orderBy_example" // string | The name of the field to order the results by. Prefix a field name with `-` to reverse the sort order. (optional) tags := []string{"Inner_example"} // []string | List of tags to filter results (optional) onlyActive := true // bool | Only return active DAGs. (optional) (default to true) configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGApi.GetDags(context.Background()).Limit(limit).Offset(offset).OrderBy(orderBy).Tags(tags).OnlyActive(onlyActive).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGApi.GetDags``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `GetDags`: DAGCollection fmt.Fprintf(os.Stdout, "Response from `DAGApi.GetDags`: %v\n", resp) }
Other parameters are passed through a pointer to a apiGetDagsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
limit | int32 | The numbers of items to return. | [default to 100] |
offset | int32 | The number of items to skip before starting to collect the result set. | |
orderBy | string | The name of the field to order the results by. Prefix a field name with `-` to reverse the sort order. | |
tags | []string | List of tags to filter results | |
onlyActive | bool | Only return active DAGs. | [default to true] |
No authorization required
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Task GetTask(ctx, dagId, taskId).Execute()
Get simplified representation of a task
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { dagId := "dagId_example" // string | The DAG ID. taskId := "taskId_example" // string | The task ID. configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGApi.GetTask(context.Background(), dagId, taskId).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGApi.GetTask``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `GetTask`: Task fmt.Fprintf(os.Stdout, "Response from `DAGApi.GetTask`: %v\n", resp) }
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
dagId | string | The DAG ID. | |
taskId | string | The task ID. |
Other parameters are passed through a pointer to a apiGetTaskRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
No authorization required
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskCollection GetTasks(ctx, dagId).OrderBy(orderBy).Execute()
Get tasks for DAG
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { dagId := "dagId_example" // string | The DAG ID. orderBy := "orderBy_example" // string | The name of the field to order the results by. Prefix a field name with `-` to reverse the sort order. (optional) configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGApi.GetTasks(context.Background(), dagId).OrderBy(orderBy).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGApi.GetTasks``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `GetTasks`: TaskCollection fmt.Fprintf(os.Stdout, "Response from `DAGApi.GetTasks`: %v\n", resp) }
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
dagId | string | The DAG ID. |
Other parameters are passed through a pointer to a apiGetTasksRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
orderBy | string | The name of the field to order the results by. Prefix a field name with `-` to reverse the sort order. |
No authorization required
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DAG PatchDag(ctx, dagId).DAG(dAG).UpdateMask(updateMask).Execute()
Update a DAG
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { dagId := "dagId_example" // string | The DAG ID. dAG := *openapiclient.NewDAG() // DAG | updateMask := []string{"Inner_example"} // []string | The fields to update on the resource. If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields. (optional) configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGApi.PatchDag(context.Background(), dagId).DAG(dAG).UpdateMask(updateMask).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGApi.PatchDag``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `PatchDag`: DAG fmt.Fprintf(os.Stdout, "Response from `DAGApi.PatchDag`: %v\n", resp) }
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
dagId | string | The DAG ID. |
Other parameters are passed through a pointer to a apiPatchDagRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
dAG | DAG | | updateMask | []string | The fields to update on the resource. If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields. |
No authorization required
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskInstanceReferenceCollection PostClearTaskInstances(ctx, dagId).ClearTaskInstance(clearTaskInstance).Execute()
Clear a set of task instances
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { dagId := "dagId_example" // string | The DAG ID. clearTaskInstance := *openapiclient.NewClearTaskInstance() // ClearTaskInstance | Parameters of action configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGApi.PostClearTaskInstances(context.Background(), dagId).ClearTaskInstance(clearTaskInstance).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGApi.PostClearTaskInstances``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `PostClearTaskInstances`: TaskInstanceReferenceCollection fmt.Fprintf(os.Stdout, "Response from `DAGApi.PostClearTaskInstances`: %v\n", resp) }
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
dagId | string | The DAG ID. |
Other parameters are passed through a pointer to a apiPostClearTaskInstancesRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
clearTaskInstance | ClearTaskInstance | Parameters of action |
TaskInstanceReferenceCollection
No authorization required
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskInstanceReferenceCollection PostSetTaskInstancesState(ctx, dagId).UpdateTaskInstancesState(updateTaskInstancesState).Execute()
Set a state of task instances
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { dagId := "dagId_example" // string | The DAG ID. updateTaskInstancesState := *openapiclient.NewUpdateTaskInstancesState() // UpdateTaskInstancesState | Parameters of action configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGApi.PostSetTaskInstancesState(context.Background(), dagId).UpdateTaskInstancesState(updateTaskInstancesState).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGApi.PostSetTaskInstancesState``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `PostSetTaskInstancesState`: TaskInstanceReferenceCollection fmt.Fprintf(os.Stdout, "Response from `DAGApi.PostSetTaskInstancesState`: %v\n", resp) }
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
dagId | string | The DAG ID. |
Other parameters are passed through a pointer to a apiPostSetTaskInstancesStateRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
updateTaskInstancesState | UpdateTaskInstancesState | Parameters of action |
TaskInstanceReferenceCollection
No authorization required
[Back to top] [Back to API list] [Back to Model list] [Back to README]