JobsApi.md

\JobsApi

All URIs are relative to /v1

Method	HTTP request	Description
GetJobById	Get /jobs/{jobId}	Returns an job by ID.

GetJobById

Job GetJobById(ctx, jobId).Execute()

Returns an job by ID.

Example

package main

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

func main() {
    jobId := "jobId_example" // string | The ID of the job.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.JobsApi.GetJobById(context.Background(), jobId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `JobsApi.GetJobById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetJobById`: Job
    fmt.Fprintf(os.Stdout, "Response from `JobsApi.GetJobById`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
jobId	string	The ID of the job.

Other Parameters

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

Name	Type	Description	Notes

Return type

Job

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]