client

package
v0.9.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 21, 2024 License: AGPL-3.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	JsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?json)`)
	XmlCheck  = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?xml)`)
)
View Source
var (
	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func IsNil

func IsNil(i interface{}) bool

IsNil checks if an input is nil

func PtrBool

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient

type APIClient struct {
	TaskAPI TaskAPI

	WorkerAPI WorkerAPI
	// contains filtered or unexported fields
}

APIClient manages communication with the saturn-bot server API API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ApiGetTaskV1Request

type ApiGetTaskV1Request struct {
	ApiService TaskAPI
	// contains filtered or unexported fields
}

func (ApiGetTaskV1Request) Execute

type ApiGetWorkV1Request

type ApiGetWorkV1Request struct {
	ApiService WorkerAPI
	// contains filtered or unexported fields
}

func (ApiGetWorkV1Request) Execute

type ApiListTasksV1Request

type ApiListTasksV1Request struct {
	ApiService TaskAPI
	// contains filtered or unexported fields
}

func (ApiListTasksV1Request) Execute

type ApiReportWorkV1Request

type ApiReportWorkV1Request struct {
	ApiService WorkerAPI
	// contains filtered or unexported fields
}

func (ApiReportWorkV1Request) Execute

func (ApiReportWorkV1Request) ReportWorkV1Request

func (r ApiReportWorkV1Request) ReportWorkV1Request(reportWorkV1Request ReportWorkV1Request) ApiReportWorkV1Request

type ApiScheduleRunV1Request

type ApiScheduleRunV1Request struct {
	ApiService WorkerAPI
	// contains filtered or unexported fields
}

func (ApiScheduleRunV1Request) Execute

func (ApiScheduleRunV1Request) ScheduleRunV1Request

func (r ApiScheduleRunV1Request) ScheduleRunV1Request(scheduleRunV1Request ScheduleRunV1Request) ApiScheduleRunV1Request

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type Error

type Error struct {
	Error   string `json:"error"`
	Message string `json:"message"`
}

Error struct for Error

func NewError

func NewError(error_ string, message string) *Error

NewError instantiates a new Error object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewErrorWithDefaults

func NewErrorWithDefaults() *Error

NewErrorWithDefaults instantiates a new Error object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Error) GetError

func (o *Error) GetError() string

GetError returns the Error field value

func (*Error) GetErrorOk

func (o *Error) GetErrorOk() (*string, bool)

GetErrorOk returns a tuple with the Error field value and a boolean to check if the value has been set.

func (*Error) GetMessage

func (o *Error) GetMessage() string

GetMessage returns the Message field value

func (*Error) GetMessageOk

func (o *Error) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value and a boolean to check if the value has been set.

func (Error) MarshalJSON

func (o Error) MarshalJSON() ([]byte, error)

func (*Error) SetError

func (o *Error) SetError(v string)

SetError sets field value

func (*Error) SetMessage

func (o *Error) SetMessage(v string)

SetMessage sets field value

func (Error) ToMap

func (o Error) ToMap() (map[string]interface{}, error)

func (*Error) UnmarshalJSON

func (o *Error) UnmarshalJSON(data []byte) (err error)

type GenericOpenAPIError

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GetTaskV1Response

type GetTaskV1Response struct {
	Name    string `json:"name"`
	Hash    string `json:"hash"`
	Content string `json:"content"`
}

GetTaskV1Response struct for GetTaskV1Response

func NewGetTaskV1Response

func NewGetTaskV1Response(name string, hash string, content string) *GetTaskV1Response

NewGetTaskV1Response instantiates a new GetTaskV1Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewGetTaskV1ResponseWithDefaults

func NewGetTaskV1ResponseWithDefaults() *GetTaskV1Response

NewGetTaskV1ResponseWithDefaults instantiates a new GetTaskV1Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*GetTaskV1Response) GetContent

func (o *GetTaskV1Response) GetContent() string

GetContent returns the Content field value

func (*GetTaskV1Response) GetContentOk

func (o *GetTaskV1Response) GetContentOk() (*string, bool)

GetContentOk returns a tuple with the Content field value and a boolean to check if the value has been set.

func (*GetTaskV1Response) GetHash

func (o *GetTaskV1Response) GetHash() string

GetHash returns the Hash field value

func (*GetTaskV1Response) GetHashOk

func (o *GetTaskV1Response) GetHashOk() (*string, bool)

GetHashOk returns a tuple with the Hash field value and a boolean to check if the value has been set.

func (*GetTaskV1Response) GetName

func (o *GetTaskV1Response) GetName() string

GetName returns the Name field value

func (*GetTaskV1Response) GetNameOk

func (o *GetTaskV1Response) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (GetTaskV1Response) MarshalJSON

func (o GetTaskV1Response) MarshalJSON() ([]byte, error)

func (*GetTaskV1Response) SetContent

func (o *GetTaskV1Response) SetContent(v string)

SetContent sets field value

func (*GetTaskV1Response) SetHash

func (o *GetTaskV1Response) SetHash(v string)

SetHash sets field value

func (*GetTaskV1Response) SetName

func (o *GetTaskV1Response) SetName(v string)

SetName sets field value

func (GetTaskV1Response) ToMap

func (o GetTaskV1Response) ToMap() (map[string]interface{}, error)

func (*GetTaskV1Response) UnmarshalJSON

func (o *GetTaskV1Response) UnmarshalJSON(data []byte) (err error)

type GetWorkV1Response

type GetWorkV1Response struct {
	// Internal identifier of the unit of work.
	RunID int32 `json:"runID"`
	// Repository for which to apply the tasks.
	Repository *string `json:"repository,omitempty"`
	// Names of the tasks to execute.
	Tasks []GetWorkV1Task `json:"tasks"`
}

GetWorkV1Response struct for GetWorkV1Response

func NewGetWorkV1Response

func NewGetWorkV1Response(runID int32, tasks []GetWorkV1Task) *GetWorkV1Response

NewGetWorkV1Response instantiates a new GetWorkV1Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewGetWorkV1ResponseWithDefaults

func NewGetWorkV1ResponseWithDefaults() *GetWorkV1Response

NewGetWorkV1ResponseWithDefaults instantiates a new GetWorkV1Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*GetWorkV1Response) GetRepository

func (o *GetWorkV1Response) GetRepository() string

GetRepository returns the Repository field value if set, zero value otherwise.

func (*GetWorkV1Response) GetRepositoryOk

func (o *GetWorkV1Response) GetRepositoryOk() (*string, bool)

GetRepositoryOk returns a tuple with the Repository field value if set, nil otherwise and a boolean to check if the value has been set.

func (*GetWorkV1Response) GetRunID

func (o *GetWorkV1Response) GetRunID() int32

GetRunID returns the RunID field value

func (*GetWorkV1Response) GetRunIDOk

func (o *GetWorkV1Response) GetRunIDOk() (*int32, bool)

GetRunIDOk returns a tuple with the RunID field value and a boolean to check if the value has been set.

func (*GetWorkV1Response) GetTasks

func (o *GetWorkV1Response) GetTasks() []GetWorkV1Task

GetTasks returns the Tasks field value

func (*GetWorkV1Response) GetTasksOk

func (o *GetWorkV1Response) GetTasksOk() ([]GetWorkV1Task, bool)

GetTasksOk returns a tuple with the Tasks field value and a boolean to check if the value has been set.

func (*GetWorkV1Response) HasRepository

func (o *GetWorkV1Response) HasRepository() bool

HasRepository returns a boolean if a field has been set.

func (GetWorkV1Response) MarshalJSON

func (o GetWorkV1Response) MarshalJSON() ([]byte, error)

func (*GetWorkV1Response) SetRepository

func (o *GetWorkV1Response) SetRepository(v string)

SetRepository gets a reference to the given string and assigns it to the Repository field.

func (*GetWorkV1Response) SetRunID

func (o *GetWorkV1Response) SetRunID(v int32)

SetRunID sets field value

func (*GetWorkV1Response) SetTasks

func (o *GetWorkV1Response) SetTasks(v []GetWorkV1Task)

SetTasks sets field value

func (GetWorkV1Response) ToMap

func (o GetWorkV1Response) ToMap() (map[string]interface{}, error)

func (*GetWorkV1Response) UnmarshalJSON

func (o *GetWorkV1Response) UnmarshalJSON(data []byte) (err error)

type GetWorkV1Task

type GetWorkV1Task struct {
	// Hash of the task. Used to detect if server and worker are out of sync.
	Hash string `json:"hash"`
	// Name of the task to execute.
	Name string `json:"name"`
}

GetWorkV1Task struct for GetWorkV1Task

func NewGetWorkV1Task

func NewGetWorkV1Task(hash string, name string) *GetWorkV1Task

NewGetWorkV1Task instantiates a new GetWorkV1Task object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewGetWorkV1TaskWithDefaults

func NewGetWorkV1TaskWithDefaults() *GetWorkV1Task

NewGetWorkV1TaskWithDefaults instantiates a new GetWorkV1Task object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*GetWorkV1Task) GetHash

func (o *GetWorkV1Task) GetHash() string

GetHash returns the Hash field value

func (*GetWorkV1Task) GetHashOk

func (o *GetWorkV1Task) GetHashOk() (*string, bool)

GetHashOk returns a tuple with the Hash field value and a boolean to check if the value has been set.

func (*GetWorkV1Task) GetName

func (o *GetWorkV1Task) GetName() string

GetName returns the Name field value

func (*GetWorkV1Task) GetNameOk

func (o *GetWorkV1Task) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (GetWorkV1Task) MarshalJSON

func (o GetWorkV1Task) MarshalJSON() ([]byte, error)

func (*GetWorkV1Task) SetHash

func (o *GetWorkV1Task) SetHash(v string)

SetHash sets field value

func (*GetWorkV1Task) SetName

func (o *GetWorkV1Task) SetName(v string)

SetName sets field value

func (GetWorkV1Task) ToMap

func (o GetWorkV1Task) ToMap() (map[string]interface{}, error)

func (*GetWorkV1Task) UnmarshalJSON

func (o *GetWorkV1Task) UnmarshalJSON(data []byte) (err error)

type ListTasksV1Response

type ListTasksV1Response struct {
	// Names of registered tasks.
	Tasks []string `json:"tasks"`
}

ListTasksV1Response struct for ListTasksV1Response

func NewListTasksV1Response

func NewListTasksV1Response(tasks []string) *ListTasksV1Response

NewListTasksV1Response instantiates a new ListTasksV1Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewListTasksV1ResponseWithDefaults

func NewListTasksV1ResponseWithDefaults() *ListTasksV1Response

NewListTasksV1ResponseWithDefaults instantiates a new ListTasksV1Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ListTasksV1Response) GetTasks

func (o *ListTasksV1Response) GetTasks() []string

GetTasks returns the Tasks field value

func (*ListTasksV1Response) GetTasksOk

func (o *ListTasksV1Response) GetTasksOk() ([]string, bool)

GetTasksOk returns a tuple with the Tasks field value and a boolean to check if the value has been set.

func (ListTasksV1Response) MarshalJSON

func (o ListTasksV1Response) MarshalJSON() ([]byte, error)

func (*ListTasksV1Response) SetTasks

func (o *ListTasksV1Response) SetTasks(v []string)

SetTasks sets field value

func (ListTasksV1Response) ToMap

func (o ListTasksV1Response) ToMap() (map[string]interface{}, error)

func (*ListTasksV1Response) UnmarshalJSON

func (o *ListTasksV1Response) UnmarshalJSON(data []byte) (err error)

type MappedNullable

type MappedNullable interface {
	ToMap() (map[string]interface{}, error)
}

type NullableBool

type NullableBool struct {
	// contains filtered or unexported fields
}

func NewNullableBool

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get

func (v NullableBool) Get() *bool

func (NullableBool) IsSet

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset

func (v *NullableBool) Unset()

type NullableError

type NullableError struct {
	// contains filtered or unexported fields
}

func NewNullableError

func NewNullableError(val *Error) *NullableError

func (NullableError) Get

func (v NullableError) Get() *Error

func (NullableError) IsSet

func (v NullableError) IsSet() bool

func (NullableError) MarshalJSON

func (v NullableError) MarshalJSON() ([]byte, error)

func (*NullableError) Set

func (v *NullableError) Set(val *Error)

func (*NullableError) UnmarshalJSON

func (v *NullableError) UnmarshalJSON(src []byte) error

func (*NullableError) Unset

func (v *NullableError) Unset()

type NullableFloat32

type NullableFloat32 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat32

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset

func (v *NullableFloat32) Unset()

type NullableFloat64

type NullableFloat64 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat64

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset

func (v *NullableFloat64) Unset()

type NullableGetTaskV1Response

type NullableGetTaskV1Response struct {
	// contains filtered or unexported fields
}

func NewNullableGetTaskV1Response

func NewNullableGetTaskV1Response(val *GetTaskV1Response) *NullableGetTaskV1Response

func (NullableGetTaskV1Response) Get

func (NullableGetTaskV1Response) IsSet

func (v NullableGetTaskV1Response) IsSet() bool

func (NullableGetTaskV1Response) MarshalJSON

func (v NullableGetTaskV1Response) MarshalJSON() ([]byte, error)

func (*NullableGetTaskV1Response) Set

func (*NullableGetTaskV1Response) UnmarshalJSON

func (v *NullableGetTaskV1Response) UnmarshalJSON(src []byte) error

func (*NullableGetTaskV1Response) Unset

func (v *NullableGetTaskV1Response) Unset()

type NullableGetWorkV1Response

type NullableGetWorkV1Response struct {
	// contains filtered or unexported fields
}

func NewNullableGetWorkV1Response

func NewNullableGetWorkV1Response(val *GetWorkV1Response) *NullableGetWorkV1Response

func (NullableGetWorkV1Response) Get

func (NullableGetWorkV1Response) IsSet

func (v NullableGetWorkV1Response) IsSet() bool

func (NullableGetWorkV1Response) MarshalJSON

func (v NullableGetWorkV1Response) MarshalJSON() ([]byte, error)

func (*NullableGetWorkV1Response) Set

func (*NullableGetWorkV1Response) UnmarshalJSON

func (v *NullableGetWorkV1Response) UnmarshalJSON(src []byte) error

func (*NullableGetWorkV1Response) Unset

func (v *NullableGetWorkV1Response) Unset()

type NullableGetWorkV1Task

type NullableGetWorkV1Task struct {
	// contains filtered or unexported fields
}

func NewNullableGetWorkV1Task

func NewNullableGetWorkV1Task(val *GetWorkV1Task) *NullableGetWorkV1Task

func (NullableGetWorkV1Task) Get

func (NullableGetWorkV1Task) IsSet

func (v NullableGetWorkV1Task) IsSet() bool

func (NullableGetWorkV1Task) MarshalJSON

func (v NullableGetWorkV1Task) MarshalJSON() ([]byte, error)

func (*NullableGetWorkV1Task) Set

func (v *NullableGetWorkV1Task) Set(val *GetWorkV1Task)

func (*NullableGetWorkV1Task) UnmarshalJSON

func (v *NullableGetWorkV1Task) UnmarshalJSON(src []byte) error

func (*NullableGetWorkV1Task) Unset

func (v *NullableGetWorkV1Task) Unset()

type NullableInt

type NullableInt struct {
	// contains filtered or unexported fields
}

func NewNullableInt

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get

func (v NullableInt) Get() *int

func (NullableInt) IsSet

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset

func (v *NullableInt) Unset()

type NullableInt32

type NullableInt32 struct {
	// contains filtered or unexported fields
}

func NewNullableInt32

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset

func (v *NullableInt32) Unset()

type NullableInt64

type NullableInt64 struct {
	// contains filtered or unexported fields
}

func NewNullableInt64

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset

func (v *NullableInt64) Unset()

type NullableListTasksV1Response

type NullableListTasksV1Response struct {
	// contains filtered or unexported fields
}

func NewNullableListTasksV1Response

func NewNullableListTasksV1Response(val *ListTasksV1Response) *NullableListTasksV1Response

func (NullableListTasksV1Response) Get

func (NullableListTasksV1Response) IsSet

func (NullableListTasksV1Response) MarshalJSON

func (v NullableListTasksV1Response) MarshalJSON() ([]byte, error)

func (*NullableListTasksV1Response) Set

func (*NullableListTasksV1Response) UnmarshalJSON

func (v *NullableListTasksV1Response) UnmarshalJSON(src []byte) error

func (*NullableListTasksV1Response) Unset

func (v *NullableListTasksV1Response) Unset()

type NullableReportWorkV1Request

type NullableReportWorkV1Request struct {
	// contains filtered or unexported fields
}

func NewNullableReportWorkV1Request

func NewNullableReportWorkV1Request(val *ReportWorkV1Request) *NullableReportWorkV1Request

func (NullableReportWorkV1Request) Get

func (NullableReportWorkV1Request) IsSet

func (NullableReportWorkV1Request) MarshalJSON

func (v NullableReportWorkV1Request) MarshalJSON() ([]byte, error)

func (*NullableReportWorkV1Request) Set

func (*NullableReportWorkV1Request) UnmarshalJSON

func (v *NullableReportWorkV1Request) UnmarshalJSON(src []byte) error

func (*NullableReportWorkV1Request) Unset

func (v *NullableReportWorkV1Request) Unset()

type NullableReportWorkV1Response

type NullableReportWorkV1Response struct {
	// contains filtered or unexported fields
}

func NewNullableReportWorkV1Response

func NewNullableReportWorkV1Response(val *ReportWorkV1Response) *NullableReportWorkV1Response

func (NullableReportWorkV1Response) Get

func (NullableReportWorkV1Response) IsSet

func (NullableReportWorkV1Response) MarshalJSON

func (v NullableReportWorkV1Response) MarshalJSON() ([]byte, error)

func (*NullableReportWorkV1Response) Set

func (*NullableReportWorkV1Response) UnmarshalJSON

func (v *NullableReportWorkV1Response) UnmarshalJSON(src []byte) error

func (*NullableReportWorkV1Response) Unset

func (v *NullableReportWorkV1Response) Unset()

type NullableReportWorkV1TaskResult

type NullableReportWorkV1TaskResult struct {
	// contains filtered or unexported fields
}

func (NullableReportWorkV1TaskResult) Get

func (NullableReportWorkV1TaskResult) IsSet

func (NullableReportWorkV1TaskResult) MarshalJSON

func (v NullableReportWorkV1TaskResult) MarshalJSON() ([]byte, error)

func (*NullableReportWorkV1TaskResult) Set

func (*NullableReportWorkV1TaskResult) UnmarshalJSON

func (v *NullableReportWorkV1TaskResult) UnmarshalJSON(src []byte) error

func (*NullableReportWorkV1TaskResult) Unset

func (v *NullableReportWorkV1TaskResult) Unset()

type NullableScheduleRunV1Request

type NullableScheduleRunV1Request struct {
	// contains filtered or unexported fields
}

func NewNullableScheduleRunV1Request

func NewNullableScheduleRunV1Request(val *ScheduleRunV1Request) *NullableScheduleRunV1Request

func (NullableScheduleRunV1Request) Get

func (NullableScheduleRunV1Request) IsSet

func (NullableScheduleRunV1Request) MarshalJSON

func (v NullableScheduleRunV1Request) MarshalJSON() ([]byte, error)

func (*NullableScheduleRunV1Request) Set

func (*NullableScheduleRunV1Request) UnmarshalJSON

func (v *NullableScheduleRunV1Request) UnmarshalJSON(src []byte) error

func (*NullableScheduleRunV1Request) Unset

func (v *NullableScheduleRunV1Request) Unset()

type NullableScheduleRunV1Response

type NullableScheduleRunV1Response struct {
	// contains filtered or unexported fields
}

func (NullableScheduleRunV1Response) Get

func (NullableScheduleRunV1Response) IsSet

func (NullableScheduleRunV1Response) MarshalJSON

func (v NullableScheduleRunV1Response) MarshalJSON() ([]byte, error)

func (*NullableScheduleRunV1Response) Set

func (*NullableScheduleRunV1Response) UnmarshalJSON

func (v *NullableScheduleRunV1Response) UnmarshalJSON(src []byte) error

func (*NullableScheduleRunV1Response) Unset

func (v *NullableScheduleRunV1Response) Unset()

type NullableString

type NullableString struct {
	// contains filtered or unexported fields
}

func NewNullableString

func NewNullableString(val *string) *NullableString

func (NullableString) Get

func (v NullableString) Get() *string

func (NullableString) IsSet

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset

func (v *NullableString) Unset()

type NullableTime

type NullableTime struct {
	// contains filtered or unexported fields
}

func NewNullableTime

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset

func (v *NullableTime) Unset()

type ReportWorkV1Request

type ReportWorkV1Request struct {
	// General that occurred during the run, if any.
	Error *string `json:"error,omitempty"`
	// Internal identifier of the unit of work.
	RunID int32 `json:"runID"`
	// Results of each task.
	TaskResults []ReportWorkV1TaskResult `json:"taskResults,omitempty"`
}

ReportWorkV1Request struct for ReportWorkV1Request

func NewReportWorkV1Request

func NewReportWorkV1Request(runID int32) *ReportWorkV1Request

NewReportWorkV1Request instantiates a new ReportWorkV1Request object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewReportWorkV1RequestWithDefaults

func NewReportWorkV1RequestWithDefaults() *ReportWorkV1Request

NewReportWorkV1RequestWithDefaults instantiates a new ReportWorkV1Request object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ReportWorkV1Request) GetError

func (o *ReportWorkV1Request) GetError() string

GetError returns the Error field value if set, zero value otherwise.

func (*ReportWorkV1Request) GetErrorOk

func (o *ReportWorkV1Request) GetErrorOk() (*string, bool)

GetErrorOk returns a tuple with the Error field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ReportWorkV1Request) GetRunID

func (o *ReportWorkV1Request) GetRunID() int32

GetRunID returns the RunID field value

func (*ReportWorkV1Request) GetRunIDOk

func (o *ReportWorkV1Request) GetRunIDOk() (*int32, bool)

GetRunIDOk returns a tuple with the RunID field value and a boolean to check if the value has been set.

func (*ReportWorkV1Request) GetTaskResults

func (o *ReportWorkV1Request) GetTaskResults() []ReportWorkV1TaskResult

GetTaskResults returns the TaskResults field value if set, zero value otherwise.

func (*ReportWorkV1Request) GetTaskResultsOk

func (o *ReportWorkV1Request) GetTaskResultsOk() ([]ReportWorkV1TaskResult, bool)

GetTaskResultsOk returns a tuple with the TaskResults field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ReportWorkV1Request) HasError

func (o *ReportWorkV1Request) HasError() bool

HasError returns a boolean if a field has been set.

func (*ReportWorkV1Request) HasTaskResults

func (o *ReportWorkV1Request) HasTaskResults() bool

HasTaskResults returns a boolean if a field has been set.

func (ReportWorkV1Request) MarshalJSON

func (o ReportWorkV1Request) MarshalJSON() ([]byte, error)

func (*ReportWorkV1Request) SetError

func (o *ReportWorkV1Request) SetError(v string)

SetError gets a reference to the given string and assigns it to the Error field.

func (*ReportWorkV1Request) SetRunID

func (o *ReportWorkV1Request) SetRunID(v int32)

SetRunID sets field value

func (*ReportWorkV1Request) SetTaskResults

func (o *ReportWorkV1Request) SetTaskResults(v []ReportWorkV1TaskResult)

SetTaskResults gets a reference to the given []ReportWorkV1TaskResult and assigns it to the TaskResults field.

func (ReportWorkV1Request) ToMap

func (o ReportWorkV1Request) ToMap() (map[string]interface{}, error)

func (*ReportWorkV1Request) UnmarshalJSON

func (o *ReportWorkV1Request) UnmarshalJSON(data []byte) (err error)

type ReportWorkV1Response

type ReportWorkV1Response struct {
	// Indicator of the result of the operation.
	Result string `json:"result"`
}

ReportWorkV1Response struct for ReportWorkV1Response

func NewReportWorkV1Response

func NewReportWorkV1Response(result string) *ReportWorkV1Response

NewReportWorkV1Response instantiates a new ReportWorkV1Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewReportWorkV1ResponseWithDefaults

func NewReportWorkV1ResponseWithDefaults() *ReportWorkV1Response

NewReportWorkV1ResponseWithDefaults instantiates a new ReportWorkV1Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ReportWorkV1Response) GetResult

func (o *ReportWorkV1Response) GetResult() string

GetResult returns the Result field value

func (*ReportWorkV1Response) GetResultOk

func (o *ReportWorkV1Response) GetResultOk() (*string, bool)

GetResultOk returns a tuple with the Result field value and a boolean to check if the value has been set.

func (ReportWorkV1Response) MarshalJSON

func (o ReportWorkV1Response) MarshalJSON() ([]byte, error)

func (*ReportWorkV1Response) SetResult

func (o *ReportWorkV1Response) SetResult(v string)

SetResult sets field value

func (ReportWorkV1Response) ToMap

func (o ReportWorkV1Response) ToMap() (map[string]interface{}, error)

func (*ReportWorkV1Response) UnmarshalJSON

func (o *ReportWorkV1Response) UnmarshalJSON(data []byte) (err error)

type ReportWorkV1TaskResult

type ReportWorkV1TaskResult struct {
	// Error encountered during the run, if any.
	Error *string `json:"error,omitempty"`
	// Name of the repository.
	RepositoryName string `json:"repositoryName"`
	// Identifier of the result.
	Result int32 `json:"result"`
	// Name of the task.
	TaskName string `json:"taskName"`
}

ReportWorkV1TaskResult Result of the run of a task.

func NewReportWorkV1TaskResult

func NewReportWorkV1TaskResult(repositoryName string, result int32, taskName string) *ReportWorkV1TaskResult

NewReportWorkV1TaskResult instantiates a new ReportWorkV1TaskResult object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewReportWorkV1TaskResultWithDefaults

func NewReportWorkV1TaskResultWithDefaults() *ReportWorkV1TaskResult

NewReportWorkV1TaskResultWithDefaults instantiates a new ReportWorkV1TaskResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ReportWorkV1TaskResult) GetError

func (o *ReportWorkV1TaskResult) GetError() string

GetError returns the Error field value if set, zero value otherwise.

func (*ReportWorkV1TaskResult) GetErrorOk

func (o *ReportWorkV1TaskResult) GetErrorOk() (*string, bool)

GetErrorOk returns a tuple with the Error field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ReportWorkV1TaskResult) GetRepositoryName

func (o *ReportWorkV1TaskResult) GetRepositoryName() string

GetRepositoryName returns the RepositoryName field value

func (*ReportWorkV1TaskResult) GetRepositoryNameOk

func (o *ReportWorkV1TaskResult) GetRepositoryNameOk() (*string, bool)

GetRepositoryNameOk returns a tuple with the RepositoryName field value and a boolean to check if the value has been set.

func (*ReportWorkV1TaskResult) GetResult

func (o *ReportWorkV1TaskResult) GetResult() int32

GetResult returns the Result field value

func (*ReportWorkV1TaskResult) GetResultOk

func (o *ReportWorkV1TaskResult) GetResultOk() (*int32, bool)

GetResultOk returns a tuple with the Result field value and a boolean to check if the value has been set.

func (*ReportWorkV1TaskResult) GetTaskName

func (o *ReportWorkV1TaskResult) GetTaskName() string

GetTaskName returns the TaskName field value

func (*ReportWorkV1TaskResult) GetTaskNameOk

func (o *ReportWorkV1TaskResult) GetTaskNameOk() (*string, bool)

GetTaskNameOk returns a tuple with the TaskName field value and a boolean to check if the value has been set.

func (*ReportWorkV1TaskResult) HasError

func (o *ReportWorkV1TaskResult) HasError() bool

HasError returns a boolean if a field has been set.

func (ReportWorkV1TaskResult) MarshalJSON

func (o ReportWorkV1TaskResult) MarshalJSON() ([]byte, error)

func (*ReportWorkV1TaskResult) SetError

func (o *ReportWorkV1TaskResult) SetError(v string)

SetError gets a reference to the given string and assigns it to the Error field.

func (*ReportWorkV1TaskResult) SetRepositoryName

func (o *ReportWorkV1TaskResult) SetRepositoryName(v string)

SetRepositoryName sets field value

func (*ReportWorkV1TaskResult) SetResult

func (o *ReportWorkV1TaskResult) SetResult(v int32)

SetResult sets field value

func (*ReportWorkV1TaskResult) SetTaskName

func (o *ReportWorkV1TaskResult) SetTaskName(v string)

SetTaskName sets field value

func (ReportWorkV1TaskResult) ToMap

func (o ReportWorkV1TaskResult) ToMap() (map[string]interface{}, error)

func (*ReportWorkV1TaskResult) UnmarshalJSON

func (o *ReportWorkV1TaskResult) UnmarshalJSON(data []byte) (err error)

type ScheduleRunV1Request

type ScheduleRunV1Request struct {
	// Name of the repository for which to add a run. If empty, the run uses the filters of the task.
	RepositoryName *string `json:"repositoryName,omitempty"`
	// Schedule the run after the given time. If empty, then the current time is used.
	ScheduleAfter *time.Time `json:"scheduleAfter,omitempty"`
	// Name of the task for which to add a run.
	TaskName string            `json:"taskName"`
	RunData  map[string]string `json:"runData,omitempty"`
}

ScheduleRunV1Request struct for ScheduleRunV1Request

func NewScheduleRunV1Request

func NewScheduleRunV1Request(taskName string) *ScheduleRunV1Request

NewScheduleRunV1Request instantiates a new ScheduleRunV1Request object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewScheduleRunV1RequestWithDefaults

func NewScheduleRunV1RequestWithDefaults() *ScheduleRunV1Request

NewScheduleRunV1RequestWithDefaults instantiates a new ScheduleRunV1Request object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ScheduleRunV1Request) GetRepositoryName

func (o *ScheduleRunV1Request) GetRepositoryName() string

GetRepositoryName returns the RepositoryName field value if set, zero value otherwise.

func (*ScheduleRunV1Request) GetRepositoryNameOk

func (o *ScheduleRunV1Request) GetRepositoryNameOk() (*string, bool)

GetRepositoryNameOk returns a tuple with the RepositoryName field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ScheduleRunV1Request) GetRunData

func (o *ScheduleRunV1Request) GetRunData() map[string]string

GetRunData returns the RunData field value if set, zero value otherwise.

func (*ScheduleRunV1Request) GetRunDataOk

func (o *ScheduleRunV1Request) GetRunDataOk() (map[string]string, bool)

GetRunDataOk returns a tuple with the RunData field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ScheduleRunV1Request) GetScheduleAfter

func (o *ScheduleRunV1Request) GetScheduleAfter() time.Time

GetScheduleAfter returns the ScheduleAfter field value if set, zero value otherwise.

func (*ScheduleRunV1Request) GetScheduleAfterOk

func (o *ScheduleRunV1Request) GetScheduleAfterOk() (*time.Time, bool)

GetScheduleAfterOk returns a tuple with the ScheduleAfter field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ScheduleRunV1Request) GetTaskName

func (o *ScheduleRunV1Request) GetTaskName() string

GetTaskName returns the TaskName field value

func (*ScheduleRunV1Request) GetTaskNameOk

func (o *ScheduleRunV1Request) GetTaskNameOk() (*string, bool)

GetTaskNameOk returns a tuple with the TaskName field value and a boolean to check if the value has been set.

func (*ScheduleRunV1Request) HasRepositoryName

func (o *ScheduleRunV1Request) HasRepositoryName() bool

HasRepositoryName returns a boolean if a field has been set.

func (*ScheduleRunV1Request) HasRunData

func (o *ScheduleRunV1Request) HasRunData() bool

HasRunData returns a boolean if a field has been set.

func (*ScheduleRunV1Request) HasScheduleAfter

func (o *ScheduleRunV1Request) HasScheduleAfter() bool

HasScheduleAfter returns a boolean if a field has been set.

func (ScheduleRunV1Request) MarshalJSON

func (o ScheduleRunV1Request) MarshalJSON() ([]byte, error)

func (*ScheduleRunV1Request) SetRepositoryName

func (o *ScheduleRunV1Request) SetRepositoryName(v string)

SetRepositoryName gets a reference to the given string and assigns it to the RepositoryName field.

func (*ScheduleRunV1Request) SetRunData

func (o *ScheduleRunV1Request) SetRunData(v map[string]string)

SetRunData gets a reference to the given map[string]string and assigns it to the RunData field.

func (*ScheduleRunV1Request) SetScheduleAfter

func (o *ScheduleRunV1Request) SetScheduleAfter(v time.Time)

SetScheduleAfter gets a reference to the given time.Time and assigns it to the ScheduleAfter field.

func (*ScheduleRunV1Request) SetTaskName

func (o *ScheduleRunV1Request) SetTaskName(v string)

SetTaskName sets field value

func (ScheduleRunV1Request) ToMap

func (o ScheduleRunV1Request) ToMap() (map[string]interface{}, error)

func (*ScheduleRunV1Request) UnmarshalJSON

func (o *ScheduleRunV1Request) UnmarshalJSON(data []byte) (err error)

type ScheduleRunV1Response

type ScheduleRunV1Response struct {
	// Identifier of the newly scheduled run.
	RunID int32 `json:"runID"`
}

ScheduleRunV1Response struct for ScheduleRunV1Response

func NewScheduleRunV1Response

func NewScheduleRunV1Response(runID int32) *ScheduleRunV1Response

NewScheduleRunV1Response instantiates a new ScheduleRunV1Response object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewScheduleRunV1ResponseWithDefaults

func NewScheduleRunV1ResponseWithDefaults() *ScheduleRunV1Response

NewScheduleRunV1ResponseWithDefaults instantiates a new ScheduleRunV1Response object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ScheduleRunV1Response) GetRunID

func (o *ScheduleRunV1Response) GetRunID() int32

GetRunID returns the RunID field value

func (*ScheduleRunV1Response) GetRunIDOk

func (o *ScheduleRunV1Response) GetRunIDOk() (*int32, bool)

GetRunIDOk returns a tuple with the RunID field value and a boolean to check if the value has been set.

func (ScheduleRunV1Response) MarshalJSON

func (o ScheduleRunV1Response) MarshalJSON() ([]byte, error)

func (*ScheduleRunV1Response) SetRunID

func (o *ScheduleRunV1Response) SetRunID(v int32)

SetRunID sets field value

func (ScheduleRunV1Response) ToMap

func (o ScheduleRunV1Response) ToMap() (map[string]interface{}, error)

func (*ScheduleRunV1Response) UnmarshalJSON

func (o *ScheduleRunV1Response) UnmarshalJSON(data []byte) (err error)

type ServerConfiguration

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type TaskAPI

type TaskAPI interface {

	/*
		GetTaskV1 Get information about a task.

		Returns detail information about a task.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@param task Name of the task to return.
		@return ApiGetTaskV1Request
	*/
	GetTaskV1(ctx context.Context, task string) ApiGetTaskV1Request

	// GetTaskV1Execute executes the request
	//  @return GetTaskV1Response
	GetTaskV1Execute(r ApiGetTaskV1Request) (*GetTaskV1Response, *http.Response, error)

	/*
		ListTasksV1 List tasks.

		Returns a list of registered tasks.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@return ApiListTasksV1Request
	*/
	ListTasksV1(ctx context.Context) ApiListTasksV1Request

	// ListTasksV1Execute executes the request
	//  @return ListTasksV1Response
	ListTasksV1Execute(r ApiListTasksV1Request) (*ListTasksV1Response, *http.Response, error)
}

type TaskAPIService

type TaskAPIService service

TaskAPIService TaskAPI service

func (*TaskAPIService) GetTaskV1

func (a *TaskAPIService) GetTaskV1(ctx context.Context, task string) ApiGetTaskV1Request

GetTaskV1 Get information about a task.

Returns detail information about a task.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param task Name of the task to return.
@return ApiGetTaskV1Request

func (*TaskAPIService) GetTaskV1Execute

Execute executes the request

@return GetTaskV1Response

func (*TaskAPIService) ListTasksV1

ListTasksV1 List tasks.

Returns a list of registered tasks.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiListTasksV1Request

func (*TaskAPIService) ListTasksV1Execute

Execute executes the request

@return ListTasksV1Response

type WorkerAPI

type WorkerAPI interface {

	/*
		GetWorkV1 Get a unit of work.

		Let a worker retrieve the next unit of work.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@return ApiGetWorkV1Request
	*/
	GetWorkV1(ctx context.Context) ApiGetWorkV1Request

	// GetWorkV1Execute executes the request
	//  @return GetWorkV1Response
	GetWorkV1Execute(r ApiGetWorkV1Request) (*GetWorkV1Response, *http.Response, error)

	/*
		ReportWorkV1 Report the result of a unit of work

		Used by workers to report the result of a unit of work.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@return ApiReportWorkV1Request
	*/
	ReportWorkV1(ctx context.Context) ApiReportWorkV1Request

	// ReportWorkV1Execute executes the request
	//  @return ReportWorkV1Response
	ReportWorkV1Execute(r ApiReportWorkV1Request) (*ReportWorkV1Response, *http.Response, error)

	/*
		ScheduleRunV1 Schedule a run.

		Add a new run to the queue.

		@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		@return ApiScheduleRunV1Request
	*/
	ScheduleRunV1(ctx context.Context) ApiScheduleRunV1Request

	// ScheduleRunV1Execute executes the request
	//  @return ScheduleRunV1Response
	ScheduleRunV1Execute(r ApiScheduleRunV1Request) (*ScheduleRunV1Response, *http.Response, error)
}

type WorkerAPIService

type WorkerAPIService service

WorkerAPIService WorkerAPI service

func (*WorkerAPIService) GetWorkV1

GetWorkV1 Get a unit of work.

Let a worker retrieve the next unit of work.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetWorkV1Request

func (*WorkerAPIService) GetWorkV1Execute

Execute executes the request

@return GetWorkV1Response

func (*WorkerAPIService) ReportWorkV1

ReportWorkV1 Report the result of a unit of work

Used by workers to report the result of a unit of work.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiReportWorkV1Request

func (*WorkerAPIService) ReportWorkV1Execute

Execute executes the request

@return ReportWorkV1Response

func (*WorkerAPIService) ScheduleRunV1

ScheduleRunV1 Schedule a run.

Add a new run to the queue.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiScheduleRunV1Request

func (*WorkerAPIService) ScheduleRunV1Execute

Execute executes the request

@return ScheduleRunV1Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL