All URIs are relative to http://localhost/api/v1
Method | HTTP request | Description |
---|---|---|
ClearDagRun | Post /dags/{dag_id}/dagRuns/{dag_run_id}/clear | Clear a DAG run |
DeleteDagRun | Delete /dags/{dag_id}/dagRuns/{dag_run_id} | Delete a DAG run |
GetDagRun | Get /dags/{dag_id}/dagRuns/{dag_run_id} | Get a DAG run |
GetDagRuns | Get /dags/{dag_id}/dagRuns | List DAG runs |
GetDagRunsBatch | Post /dags/~/dagRuns/list | List DAG runs (batch) |
GetUpstreamDatasetEvents | Get /dags/{dag_id}/dagRuns/{dag_run_id}/upstreamDatasetEvents | Get dataset events for a DAG run |
PostDagRun | Post /dags/{dag_id}/dagRuns | Trigger a new DAG run |
SetDagRunNote | Patch /dags/{dag_id}/dagRuns/{dag_run_id}/setNote | Update the DagRun note. |
UpdateDagRunState | Patch /dags/{dag_id}/dagRuns/{dag_run_id} | Modify a DAG run |
DAGRun ClearDagRun(ctx, dagId, dagRunId).ClearDagRun(clearDagRun).Execute()
Clear a DAG run
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { dagId := "dagId_example" // string | The DAG ID. dagRunId := "dagRunId_example" // string | The DAG run ID. clearDagRun := *openapiclient.NewClearDagRun() // ClearDagRun | configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGRunApi.ClearDagRun(context.Background(), dagId, dagRunId).ClearDagRun(clearDagRun).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGRunApi.ClearDagRun``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `ClearDagRun`: DAGRun fmt.Fprintf(os.Stdout, "Response from `DAGRunApi.ClearDagRun`: %v\n", resp) }
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
dagId | string | The DAG ID. | |
dagRunId | string | The DAG run ID. |
Other parameters are passed through a pointer to a apiClearDagRunRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
clearDagRun | ClearDagRun | |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteDagRun(ctx, dagId, dagRunId).Execute()
Delete a DAG run
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { dagId := "dagId_example" // string | The DAG ID. dagRunId := "dagRunId_example" // string | The DAG run ID. configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGRunApi.DeleteDagRun(context.Background(), dagId, dagRunId).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGRunApi.DeleteDagRun``: %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. | |
dagRunId | string | The DAG run ID. |
Other parameters are passed through a pointer to a apiDeleteDagRunRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DAGRun GetDagRun(ctx, dagId, dagRunId).Execute()
Get a DAG run
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { dagId := "dagId_example" // string | The DAG ID. dagRunId := "dagRunId_example" // string | The DAG run ID. configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGRunApi.GetDagRun(context.Background(), dagId, dagRunId).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGRunApi.GetDagRun``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `GetDagRun`: DAGRun fmt.Fprintf(os.Stdout, "Response from `DAGRunApi.GetDagRun`: %v\n", resp) }
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
dagId | string | The DAG ID. | |
dagRunId | string | The DAG run ID. |
Other parameters are passed through a pointer to a apiGetDagRunRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DAGRunCollection GetDagRuns(ctx, dagId).Limit(limit).Offset(offset).ExecutionDateGte(executionDateGte).ExecutionDateLte(executionDateLte).StartDateGte(startDateGte).StartDateLte(startDateLte).EndDateGte(endDateGte).EndDateLte(endDateLte).State(state).OrderBy(orderBy).Execute()
List DAG runs
package main import ( "context" "fmt" "os" "time" openapiclient "./openapi" ) func main() { dagId := "dagId_example" // string | The DAG ID. 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) executionDateGte := time.Now() // time.Time | Returns objects greater or equal to the specified date. This can be combined with execution_date_lte parameter to receive only the selected period. (optional) executionDateLte := time.Now() // time.Time | Returns objects less than or equal to the specified date. This can be combined with execution_date_gte parameter to receive only the selected period. (optional) startDateGte := time.Now() // time.Time | Returns objects greater or equal the specified date. This can be combined with start_date_lte parameter to receive only the selected period. (optional) startDateLte := time.Now() // time.Time | Returns objects less or equal the specified date. This can be combined with start_date_gte parameter to receive only the selected period. (optional) endDateGte := time.Now() // time.Time | Returns objects greater or equal the specified date. This can be combined with start_date_lte parameter to receive only the selected period. (optional) endDateLte := time.Now() // time.Time | Returns objects less than or equal to the specified date. This can be combined with start_date_gte parameter to receive only the selected period. (optional) state := []string{"Inner_example"} // []string | The value can be repeated to retrieve multiple matching values (OR condition). (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. *New in version 2.1.0* (optional) configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGRunApi.GetDagRuns(context.Background(), dagId).Limit(limit).Offset(offset).ExecutionDateGte(executionDateGte).ExecutionDateLte(executionDateLte).StartDateGte(startDateGte).StartDateLte(startDateLte).EndDateGte(endDateGte).EndDateLte(endDateLte).State(state).OrderBy(orderBy).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGRunApi.GetDagRuns``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `GetDagRuns`: DAGRunCollection fmt.Fprintf(os.Stdout, "Response from `DAGRunApi.GetDagRuns`: %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 apiGetDagRunsRequest 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. | executionDateGte | time.Time | Returns objects greater or equal to the specified date. This can be combined with execution_date_lte parameter to receive only the selected period. | executionDateLte | time.Time | Returns objects less than or equal to the specified date. This can be combined with execution_date_gte parameter to receive only the selected period. | startDateGte | time.Time | Returns objects greater or equal the specified date. This can be combined with start_date_lte parameter to receive only the selected period. | startDateLte | time.Time | Returns objects less or equal the specified date. This can be combined with start_date_gte parameter to receive only the selected period. | endDateGte | time.Time | Returns objects greater or equal the specified date. This can be combined with start_date_lte parameter to receive only the selected period. | endDateLte | time.Time | Returns objects less than or equal to the specified date. This can be combined with start_date_gte parameter to receive only the selected period. | state | []string | The value can be repeated to retrieve multiple matching values (OR condition). | orderBy | string | The name of the field to order the results by. Prefix a field name with `-` to reverse the sort order. New in version 2.1.0 |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DAGRunCollection GetDagRunsBatch(ctx).ListDagRunsForm(listDagRunsForm).Execute()
List DAG runs (batch)
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { listDagRunsForm := *openapiclient.NewListDagRunsForm() // ListDagRunsForm | configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGRunApi.GetDagRunsBatch(context.Background()).ListDagRunsForm(listDagRunsForm).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGRunApi.GetDagRunsBatch``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `GetDagRunsBatch`: DAGRunCollection fmt.Fprintf(os.Stdout, "Response from `DAGRunApi.GetDagRunsBatch`: %v\n", resp) }
Other parameters are passed through a pointer to a apiGetDagRunsBatchRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
listDagRunsForm | ListDagRunsForm |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DatasetEventCollection GetUpstreamDatasetEvents(ctx, dagId, dagRunId).Execute()
Get dataset events for a DAG run
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { dagId := "dagId_example" // string | The DAG ID. dagRunId := "dagRunId_example" // string | The DAG run ID. configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGRunApi.GetUpstreamDatasetEvents(context.Background(), dagId, dagRunId).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGRunApi.GetUpstreamDatasetEvents``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `GetUpstreamDatasetEvents`: DatasetEventCollection fmt.Fprintf(os.Stdout, "Response from `DAGRunApi.GetUpstreamDatasetEvents`: %v\n", resp) }
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
dagId | string | The DAG ID. | |
dagRunId | string | The DAG run ID. |
Other parameters are passed through a pointer to a apiGetUpstreamDatasetEventsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DAGRun PostDagRun(ctx, dagId).DAGRun(dAGRun).Execute()
Trigger a new DAG run
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { dagId := "dagId_example" // string | The DAG ID. dAGRun := *openapiclient.NewDAGRun() // DAGRun | configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGRunApi.PostDagRun(context.Background(), dagId).DAGRun(dAGRun).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGRunApi.PostDagRun``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `PostDagRun`: DAGRun fmt.Fprintf(os.Stdout, "Response from `DAGRunApi.PostDagRun`: %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 apiPostDagRunRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
dAGRun | DAGRun | |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DAGRun SetDagRunNote(ctx, dagId, dagRunId).SetDagRunNote(setDagRunNote).Execute()
Update the DagRun note.
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { dagId := "dagId_example" // string | The DAG ID. dagRunId := "dagRunId_example" // string | The DAG run ID. setDagRunNote := *openapiclient.NewSetDagRunNote() // SetDagRunNote | Parameters of set DagRun note. configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGRunApi.SetDagRunNote(context.Background(), dagId, dagRunId).SetDagRunNote(setDagRunNote).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGRunApi.SetDagRunNote``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `SetDagRunNote`: DAGRun fmt.Fprintf(os.Stdout, "Response from `DAGRunApi.SetDagRunNote`: %v\n", resp) }
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
dagId | string | The DAG ID. | |
dagRunId | string | The DAG run ID. |
Other parameters are passed through a pointer to a apiSetDagRunNoteRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
setDagRunNote | SetDagRunNote | Parameters of set DagRun note. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DAGRun UpdateDagRunState(ctx, dagId, dagRunId).UpdateDagRunState(updateDagRunState).Execute()
Modify a DAG run
package main import ( "context" "fmt" "os" openapiclient "./openapi" ) func main() { dagId := "dagId_example" // string | The DAG ID. dagRunId := "dagRunId_example" // string | The DAG run ID. updateDagRunState := *openapiclient.NewUpdateDagRunState() // UpdateDagRunState | configuration := openapiclient.NewConfiguration() api_client := openapiclient.NewAPIClient(configuration) resp, r, err := api_client.DAGRunApi.UpdateDagRunState(context.Background(), dagId, dagRunId).UpdateDagRunState(updateDagRunState).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DAGRunApi.UpdateDagRunState``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `UpdateDagRunState`: DAGRun fmt.Fprintf(os.Stdout, "Response from `DAGRunApi.UpdateDagRunState`: %v\n", resp) }
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
dagId | string | The DAG ID. | |
dagRunId | string | The DAG run ID. |
Other parameters are passed through a pointer to a apiUpdateDagRunStateRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
updateDagRunState | UpdateDagRunState | |
[Back to top] [Back to API list] [Back to Model list] [Back to README]