kalaclient

package
v0.8.5 Latest Latest
Warning

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

 Go to latest Published: Sep 17, 2020 License: MIT Imports: 23 Imported by: 0

README

Go API client for kalaclient

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./kalaclient"

Documentation for API Endpoints

All URIs are relative to http://localhost:8000

Class Method HTTP request Description
DefaultApi CreateJob Post /api/v1/job/ Creates a job
DefaultApi DeleteJob Delete /api/v1/job/{jobId}/ Deletes a job
DefaultApi GetJob Get /api/v1/job/{jobId}/ Get job details

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

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

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

Types

type APIClient 

type APIClient struct {
	DefaultApi *DefaultApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Kala scheduler API v1.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) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

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 APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

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

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 {
	BasePath      string            `json:"basePath,omitempty"`
	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       []ServerConfiguration
	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

type CreateJobOpts 

type CreateJobOpts struct {
	CreateJob optional.Interface
}

CreateJobOpts Optional parameters for the method 'CreateJob'

type DefaultApiService 

type DefaultApiService service

DefaultApiService DefaultApi service

func (*DefaultApiService) CreateJob 

func (a *DefaultApiService) CreateJob(ctx _context.Context, localVarOptionals *CreateJobOpts) (JobWithId, *_nethttp.Response, error)

CreateJob Creates a job

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *CreateJobOpts - Optional Parameters:
  • @param "CreateJob" (optional.Interface of Job) -

@return JobWithId

func (*DefaultApiService) DeleteJob 

func (a *DefaultApiService) DeleteJob(ctx _context.Context, jobId string) (*_nethttp.Response, error)

DeleteJob Deletes a job

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

func (*DefaultApiService) GetJob 

func (a *DefaultApiService) GetJob(ctx _context.Context, jobId string) (InlineResponse200, *_nethttp.Response, error)

GetJob Get job details

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

@return InlineResponse200

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 InlineResponse200 

type InlineResponse200 struct {
	Job Job `json:"job,omitempty"`
}

InlineResponse200 struct for InlineResponse200

type InlineResponse400 

type InlineResponse400 struct {
	Error string `json:"error,omitempty"`
}

InlineResponse400 struct for InlineResponse400

type Job 

type Job struct {
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
	// 0 - local, 1 - remote
	Type     int64  `json:"type,omitempty"`
	Command  string `json:"command,omitempty"`
	Owner    string `json:"owner,omitempty"`
	Disabled bool   `json:"disabled,omitempty"`
	Schedule string `json:"schedule,omitempty"`
	Retries  int64  `json:"retries,omitempty"`
	// Duration in which it is safe to retry the Job.
	Epsilon          string           `json:"epsilon,omitempty"`
	NextRunAt        time.Time        `json:"next_run_at,omitempty"`
	RemoteProperties RemoteProperties `json:"remote_properties,omitempty"`
	IsDone           bool             `json:"is_done,omitempty"`
}

Job struct for Job

type JobWithId 

type JobWithId struct {
	Id string `json:"id,omitempty"`
}

JobWithId struct for JobWithId

type RemoteProperties 

type RemoteProperties struct {
	Url                   string              `json:"url,omitempty"`
	Method                string              `json:"method,omitempty"`
	Body                  string              `json:"body,omitempty"`
	Headers               map[string][]string `json:"headers,omitempty"`
	Timeout               int64               `json:"timeout,omitempty"`
	ExpectedResponseCodes []int64             `json:"expected_response_codes,omitempty"`
}

RemoteProperties struct for RemoteProperties

type ServerConfiguration 

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

ServerConfiguration stores the information about a server

type ServerVariable 

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

ServerVariable stores the information about a server variable

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.