Skip to content

Latest commit

 

History

History
449 lines (290 loc) · 11.5 KB

CustomerTasksApi.md

File metadata and controls

449 lines (290 loc) · 11.5 KB
Raw

\CustomerTasksApi

All URIs are relative to http://localhost

Method HTTP request Description
AbortTask Post /api/v1/customers/{cUUID}/tasks/{tUUID}/abort Abort a task
FailedSubtasks Get /api/v1/customers/{cUUID}/tasks/{tUUID}/failed Fetch failed subtasks - deprecated
ListFailedSubtasks Get /api/v1/customers/{cUUID}/tasks/{tUUID}/failed_subtasks Get a list of task's failed subtasks
RetryTask Post /api/v1/customers/{cUUID}/tasks/{tUUID}/retry Retry a Universe or Provider task
TaskStatus Get /api/v1/customers/{cUUID}/tasks/{tUUID} Get a task's status
TasksList Get /api/v1/customers/{cUUID}/tasks_list List task

AbortTask

YBPSuccess AbortTask(ctx, cUUID, tUUID).Request(request).Execute()

Abort a task

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    tUUID := TODO // string | 
    request := TODO // interface{} |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.CustomerTasksApi.AbortTask(context.Background(), cUUID, tUUID).Request(request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomerTasksApi.AbortTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AbortTask`: YBPSuccess
    fmt.Fprintf(os.Stdout, "Response from `CustomerTasksApi.AbortTask`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string
tUUID string

Other Parameters

Other parameters are passed through a pointer to a apiAbortTaskRequest struct via the builder pattern

Name Type Description Notes

request | interface{} | |

Return type

YBPSuccess

Authorization

apiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FailedSubtasks

map[string]map[string]interface{} FailedSubtasks(ctx, cUUID, tUUID).Execute()

Fetch failed subtasks - deprecated

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    tUUID := TODO // string | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.CustomerTasksApi.FailedSubtasks(context.Background(), cUUID, tUUID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomerTasksApi.FailedSubtasks``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FailedSubtasks`: map[string]map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `CustomerTasksApi.FailedSubtasks`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string
tUUID string

Other Parameters

Other parameters are passed through a pointer to a apiFailedSubtasksRequest struct via the builder pattern

Name Type Description Notes

Return type

map[string]map[string]interface{}

Authorization

apiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListFailedSubtasks

FailedSubtasks ListFailedSubtasks(ctx, cUUID, tUUID).Execute()

Get a list of task's failed subtasks

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    tUUID := TODO // string | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.CustomerTasksApi.ListFailedSubtasks(context.Background(), cUUID, tUUID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomerTasksApi.ListFailedSubtasks``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListFailedSubtasks`: FailedSubtasks
    fmt.Fprintf(os.Stdout, "Response from `CustomerTasksApi.ListFailedSubtasks`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string
tUUID string

Other Parameters

Other parameters are passed through a pointer to a apiListFailedSubtasksRequest struct via the builder pattern

Name Type Description Notes

Return type

FailedSubtasks

Authorization

apiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetryTask

YBPTask RetryTask(ctx, cUUID, tUUID).Request(request).Execute()

Retry a Universe or Provider task

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    tUUID := TODO // string | 
    request := TODO // interface{} |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.CustomerTasksApi.RetryTask(context.Background(), cUUID, tUUID).Request(request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomerTasksApi.RetryTask``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RetryTask`: YBPTask
    fmt.Fprintf(os.Stdout, "Response from `CustomerTasksApi.RetryTask`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string
tUUID string

Other Parameters

Other parameters are passed through a pointer to a apiRetryTaskRequest struct via the builder pattern

Name Type Description Notes

request | interface{} | |

Return type

YBPTask

Authorization

apiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TaskStatus

map[string]interface{} TaskStatus(ctx, cUUID, tUUID).Execute()

Get a task's status

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    tUUID := TODO // string | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.CustomerTasksApi.TaskStatus(context.Background(), cUUID, tUUID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomerTasksApi.TaskStatus``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `TaskStatus`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `CustomerTasksApi.TaskStatus`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string
tUUID string

Other Parameters

Other parameters are passed through a pointer to a apiTaskStatusRequest struct via the builder pattern

Name Type Description Notes

Return type

map[string]interface{}

Authorization

apiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TasksList

[]CustomerTaskData TasksList(ctx, cUUID).UUUID(uUUID).Execute()

List task

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    cUUID := TODO // string | 
    uUUID := TODO // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.CustomerTasksApi.TasksList(context.Background(), cUUID).UUUID(uUUID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CustomerTasksApi.TasksList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `TasksList`: []CustomerTaskData
    fmt.Fprintf(os.Stdout, "Response from `CustomerTasksApi.TasksList`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cUUID string

Other Parameters

Other parameters are passed through a pointer to a apiTasksListRequest struct via the builder pattern

Name Type Description Notes

uUUID | string | |

Return type

[]CustomerTaskData

Authorization

apiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]