schedules

package
v0.5.1 Latest Latest
Warning

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

Go to latest
Published: Apr 30, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package schedules is a generated GoMock package.

Package schedules provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen/v2 version v2.0.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewDeleteSchedulesIdRequest

func NewDeleteSchedulesIdRequest(server string, id IdPath, params *DeleteSchedulesIdParams) (*http.Request, error)

NewDeleteSchedulesIdRequest generates requests for DeleteSchedulesId

func NewGetSchedulesIdRequest

func NewGetSchedulesIdRequest(server string, id IdPath, params *GetSchedulesIdParams) (*http.Request, error)

NewGetSchedulesIdRequest generates requests for GetSchedulesId

func NewPostSchedulesRequest

func NewPostSchedulesRequest(server string, params *PostSchedulesParams, body PostSchedulesJSONRequestBody) (*http.Request, error)

NewPostSchedulesRequest calls the generic PostSchedules builder with application/json body

func NewPostSchedulesRequestWithBody

func NewPostSchedulesRequestWithBody(server string, params *PostSchedulesParams, contentType string, body io.Reader) (*http.Request, error)

NewPostSchedulesRequestWithBody generates requests for PostSchedules with any type of body

func NewSearchSchedulesRequest

func NewSearchSchedulesRequest(server string, params *SearchSchedulesParams) (*http.Request, error)

NewSearchSchedulesRequest generates requests for SearchSchedules

Types

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) DeleteSchedulesId

func (c *Client) DeleteSchedulesId(ctx context.Context, id IdPath, params *DeleteSchedulesIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetSchedulesId

func (c *Client) GetSchedulesId(ctx context.Context, id IdPath, params *GetSchedulesIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostSchedules

func (c *Client) PostSchedules(ctx context.Context, params *PostSchedulesParams, body PostSchedulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostSchedulesWithBody

func (c *Client) PostSchedulesWithBody(ctx context.Context, params *PostSchedulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchSchedules

func (c *Client) SearchSchedules(ctx context.Context, params *SearchSchedulesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// SearchSchedules request
	SearchSchedules(ctx context.Context, params *SearchSchedulesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostSchedulesWithBody request with any body
	PostSchedulesWithBody(ctx context.Context, params *PostSchedulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostSchedules(ctx context.Context, params *PostSchedulesParams, body PostSchedulesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteSchedulesId request
	DeleteSchedulesId(ctx context.Context, id IdPath, params *DeleteSchedulesIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSchedulesId request
	GetSchedulesId(ctx context.Context, id IdPath, params *GetSchedulesIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) DeleteSchedulesIdWithResponse

func (c *ClientWithResponses) DeleteSchedulesIdWithResponse(ctx context.Context, id IdPath, params *DeleteSchedulesIdParams, reqEditors ...RequestEditorFn) (*DeleteSchedulesIdResponse, error)

DeleteSchedulesIdWithResponse request returning *DeleteSchedulesIdResponse

func (*ClientWithResponses) GetSchedulesIdWithResponse

func (c *ClientWithResponses) GetSchedulesIdWithResponse(ctx context.Context, id IdPath, params *GetSchedulesIdParams, reqEditors ...RequestEditorFn) (*GetSchedulesIdResponse, error)

GetSchedulesIdWithResponse request returning *GetSchedulesIdResponse

func (*ClientWithResponses) PostSchedulesWithBodyWithResponse

func (c *ClientWithResponses) PostSchedulesWithBodyWithResponse(ctx context.Context, params *PostSchedulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostSchedulesResponse, error)

PostSchedulesWithBodyWithResponse request with arbitrary body returning *PostSchedulesResponse

func (*ClientWithResponses) PostSchedulesWithResponse

func (c *ClientWithResponses) PostSchedulesWithResponse(ctx context.Context, params *PostSchedulesParams, body PostSchedulesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostSchedulesResponse, error)

func (*ClientWithResponses) SearchSchedulesWithResponse

func (c *ClientWithResponses) SearchSchedulesWithResponse(ctx context.Context, params *SearchSchedulesParams, reqEditors ...RequestEditorFn) (*SearchSchedulesResponse, error)

SearchSchedulesWithResponse request returning *SearchSchedulesResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// SearchSchedulesWithResponse request
	SearchSchedulesWithResponse(ctx context.Context, params *SearchSchedulesParams, reqEditors ...RequestEditorFn) (*SearchSchedulesResponse, error)

	// PostSchedulesWithBodyWithResponse request with any body
	PostSchedulesWithBodyWithResponse(ctx context.Context, params *PostSchedulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostSchedulesResponse, error)

	PostSchedulesWithResponse(ctx context.Context, params *PostSchedulesParams, body PostSchedulesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostSchedulesResponse, error)

	// DeleteSchedulesIdWithResponse request
	DeleteSchedulesIdWithResponse(ctx context.Context, id IdPath, params *DeleteSchedulesIdParams, reqEditors ...RequestEditorFn) (*DeleteSchedulesIdResponse, error)

	// GetSchedulesIdWithResponse request
	GetSchedulesIdWithResponse(ctx context.Context, id IdPath, params *GetSchedulesIdParams, reqEditors ...RequestEditorFn) (*GetSchedulesIdResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type DeleteSchedulesIdParams

type DeleteSchedulesIdParams struct {
	// RequestId Unique ID for each request
	RequestId *RequestIdHeader `json:"request-id,omitempty"`
}

DeleteSchedulesIdParams defines parameters for DeleteSchedulesId.

type DeleteSchedulesIdResponse

type DeleteSchedulesIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseDeleteSchedulesIdResponse

func ParseDeleteSchedulesIdResponse(rsp *http.Response) (*DeleteSchedulesIdResponse, error)

ParseDeleteSchedulesIdResponse parses an HTTP response from a DeleteSchedulesIdWithResponse call

func (DeleteSchedulesIdResponse) Status

func (r DeleteSchedulesIdResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteSchedulesIdResponse) StatusCode

func (r DeleteSchedulesIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSchedulesIdParams

type GetSchedulesIdParams struct {
	// RequestId Unique ID for each request
	RequestId *RequestIdHeader `json:"request-id,omitempty"`
}

GetSchedulesIdParams defines parameters for GetSchedulesId.

type GetSchedulesIdResponse

type GetSchedulesIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Schedule
}

func ParseGetSchedulesIdResponse

func ParseGetSchedulesIdResponse(rsp *http.Response) (*GetSchedulesIdResponse, error)

ParseGetSchedulesIdResponse parses an HTTP response from a GetSchedulesIdWithResponse call

func (GetSchedulesIdResponse) Status

func (r GetSchedulesIdResponse) Status() string

Status returns HTTPResponse.Status

func (GetSchedulesIdResponse) StatusCode

func (r GetSchedulesIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type IdPath

type IdPath = string

IdPath defines model for IdPath.

type IdempotencyKeyHeader

type IdempotencyKeyHeader = string

IdempotencyKeyHeader defines model for IdempotencyKeyHeader.

type MockClientInterface

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

MockClientInterface is a mock of ClientInterface interface.

func NewMockClientInterface

func NewMockClientInterface(ctrl *gomock.Controller) *MockClientInterface

NewMockClientInterface creates a new mock instance.

func (*MockClientInterface) DeleteSchedulesId

func (m *MockClientInterface) DeleteSchedulesId(ctx context.Context, id IdPath, params *DeleteSchedulesIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteSchedulesId mocks base method.

func (*MockClientInterface) EXPECT

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockClientInterface) GetSchedulesId

func (m *MockClientInterface) GetSchedulesId(ctx context.Context, id IdPath, params *GetSchedulesIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetSchedulesId mocks base method.

func (*MockClientInterface) PostSchedules

PostSchedules mocks base method.

func (*MockClientInterface) PostSchedulesWithBody

func (m *MockClientInterface) PostSchedulesWithBody(ctx context.Context, params *PostSchedulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PostSchedulesWithBody mocks base method.

func (*MockClientInterface) SearchSchedules

func (m *MockClientInterface) SearchSchedules(ctx context.Context, params *SearchSchedulesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

SearchSchedules mocks base method.

type MockClientInterfaceMockRecorder

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

MockClientInterfaceMockRecorder is the mock recorder for MockClientInterface.

func (*MockClientInterfaceMockRecorder) DeleteSchedulesId

func (mr *MockClientInterfaceMockRecorder) DeleteSchedulesId(ctx, id, params interface{}, reqEditors ...interface{}) *gomock.Call

DeleteSchedulesId indicates an expected call of DeleteSchedulesId.

func (*MockClientInterfaceMockRecorder) GetSchedulesId

func (mr *MockClientInterfaceMockRecorder) GetSchedulesId(ctx, id, params interface{}, reqEditors ...interface{}) *gomock.Call

GetSchedulesId indicates an expected call of GetSchedulesId.

func (*MockClientInterfaceMockRecorder) PostSchedules

func (mr *MockClientInterfaceMockRecorder) PostSchedules(ctx, params, body interface{}, reqEditors ...interface{}) *gomock.Call

PostSchedules indicates an expected call of PostSchedules.

func (*MockClientInterfaceMockRecorder) PostSchedulesWithBody

func (mr *MockClientInterfaceMockRecorder) PostSchedulesWithBody(ctx, params, contentType, body interface{}, reqEditors ...interface{}) *gomock.Call

PostSchedulesWithBody indicates an expected call of PostSchedulesWithBody.

func (*MockClientInterfaceMockRecorder) SearchSchedules

func (mr *MockClientInterfaceMockRecorder) SearchSchedules(ctx, params interface{}, reqEditors ...interface{}) *gomock.Call

SearchSchedules indicates an expected call of SearchSchedules.

type MockClientWithResponsesInterface

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

MockClientWithResponsesInterface is a mock of ClientWithResponsesInterface interface.

func NewMockClientWithResponsesInterface

func NewMockClientWithResponsesInterface(ctrl *gomock.Controller) *MockClientWithResponsesInterface

NewMockClientWithResponsesInterface creates a new mock instance.

func (*MockClientWithResponsesInterface) DeleteSchedulesIdWithResponse

func (m *MockClientWithResponsesInterface) DeleteSchedulesIdWithResponse(ctx context.Context, id IdPath, params *DeleteSchedulesIdParams, reqEditors ...RequestEditorFn) (*DeleteSchedulesIdResponse, error)

DeleteSchedulesIdWithResponse mocks base method.

func (*MockClientWithResponsesInterface) EXPECT

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockClientWithResponsesInterface) GetSchedulesIdWithResponse

func (m *MockClientWithResponsesInterface) GetSchedulesIdWithResponse(ctx context.Context, id IdPath, params *GetSchedulesIdParams, reqEditors ...RequestEditorFn) (*GetSchedulesIdResponse, error)

GetSchedulesIdWithResponse mocks base method.

func (*MockClientWithResponsesInterface) PostSchedulesWithBodyWithResponse

func (m *MockClientWithResponsesInterface) PostSchedulesWithBodyWithResponse(ctx context.Context, params *PostSchedulesParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostSchedulesResponse, error)

PostSchedulesWithBodyWithResponse mocks base method.

func (*MockClientWithResponsesInterface) PostSchedulesWithResponse

PostSchedulesWithResponse mocks base method.

func (*MockClientWithResponsesInterface) SearchSchedulesWithResponse

func (m *MockClientWithResponsesInterface) SearchSchedulesWithResponse(ctx context.Context, params *SearchSchedulesParams, reqEditors ...RequestEditorFn) (*SearchSchedulesResponse, error)

SearchSchedulesWithResponse mocks base method.

type MockClientWithResponsesInterfaceMockRecorder

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

MockClientWithResponsesInterfaceMockRecorder is the mock recorder for MockClientWithResponsesInterface.

func (*MockClientWithResponsesInterfaceMockRecorder) DeleteSchedulesIdWithResponse

func (mr *MockClientWithResponsesInterfaceMockRecorder) DeleteSchedulesIdWithResponse(ctx, id, params interface{}, reqEditors ...interface{}) *gomock.Call

DeleteSchedulesIdWithResponse indicates an expected call of DeleteSchedulesIdWithResponse.

func (*MockClientWithResponsesInterfaceMockRecorder) GetSchedulesIdWithResponse

func (mr *MockClientWithResponsesInterfaceMockRecorder) GetSchedulesIdWithResponse(ctx, id, params interface{}, reqEditors ...interface{}) *gomock.Call

GetSchedulesIdWithResponse indicates an expected call of GetSchedulesIdWithResponse.

func (*MockClientWithResponsesInterfaceMockRecorder) PostSchedulesWithBodyWithResponse

func (mr *MockClientWithResponsesInterfaceMockRecorder) PostSchedulesWithBodyWithResponse(ctx, params, contentType, body interface{}, reqEditors ...interface{}) *gomock.Call

PostSchedulesWithBodyWithResponse indicates an expected call of PostSchedulesWithBodyWithResponse.

func (*MockClientWithResponsesInterfaceMockRecorder) PostSchedulesWithResponse

func (mr *MockClientWithResponsesInterfaceMockRecorder) PostSchedulesWithResponse(ctx, params, body interface{}, reqEditors ...interface{}) *gomock.Call

PostSchedulesWithResponse indicates an expected call of PostSchedulesWithResponse.

func (*MockClientWithResponsesInterfaceMockRecorder) SearchSchedulesWithResponse

func (mr *MockClientWithResponsesInterfaceMockRecorder) SearchSchedulesWithResponse(ctx, params interface{}, reqEditors ...interface{}) *gomock.Call

SearchSchedulesWithResponse indicates an expected call of SearchSchedulesWithResponse.

type MockHttpRequestDoer

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

MockHttpRequestDoer is a mock of HttpRequestDoer interface.

func NewMockHttpRequestDoer

func NewMockHttpRequestDoer(ctrl *gomock.Controller) *MockHttpRequestDoer

NewMockHttpRequestDoer creates a new mock instance.

func (*MockHttpRequestDoer) Do

Do mocks base method.

func (*MockHttpRequestDoer) EXPECT

EXPECT returns an object that allows the caller to indicate expected use.

type MockHttpRequestDoerMockRecorder

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

MockHttpRequestDoerMockRecorder is the mock recorder for MockHttpRequestDoer.

func (*MockHttpRequestDoerMockRecorder) Do

func (mr *MockHttpRequestDoerMockRecorder) Do(req interface{}) *gomock.Call

Do indicates an expected call of Do.

type PostSchedulesJSONRequestBody

type PostSchedulesJSONRequestBody = Schedule

PostSchedulesJSONRequestBody defines body for PostSchedules for application/json ContentType.

type PostSchedulesParams

type PostSchedulesParams struct {
	// RequestId Unique ID for each request
	RequestId *RequestIdHeader `json:"request-id,omitempty"`

	// IdempotencyKey Deduplicates multiple requests
	IdempotencyKey *IdempotencyKeyHeader `json:"idempotency-key,omitempty"`
}

PostSchedulesParams defines parameters for PostSchedules.

type PostSchedulesResponse

type PostSchedulesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Schedule
	JSON201      *Schedule
}

func ParsePostSchedulesResponse

func ParsePostSchedulesResponse(rsp *http.Response) (*PostSchedulesResponse, error)

ParsePostSchedulesResponse parses an HTTP response from a PostSchedulesWithResponse call

func (PostSchedulesResponse) Status

func (r PostSchedulesResponse) Status() string

Status returns HTTPResponse.Status

func (PostSchedulesResponse) StatusCode

func (r PostSchedulesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PromiseValue

type PromiseValue struct {
	Data    *string           `json:"data,omitempty"`
	Headers map[string]string `json:"headers"`
}

PromiseValue defines model for PromiseValue.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type RequestIdHeader

type RequestIdHeader = string

RequestIdHeader defines model for RequestIdHeader.

type Schedule

type Schedule struct {
	CreatedOn      *int64             `json:"createdOn,omitempty"`
	Cron           string             `json:"cron"`
	Description    *string            `json:"description,omitempty"`
	Id             string             `json:"id"`
	IdempotencyKey *string            `json:"idempotencyKey,omitempty"`
	LastRunTime    *int64             `json:"lastRunTime,omitempty"`
	NextRunTime    *int64             `json:"nextRunTime,omitempty"`
	PromiseId      string             `json:"promiseId"`
	PromiseParam   *PromiseValue      `json:"promiseParam,omitempty"`
	PromiseTags    *map[string]string `json:"promiseTags,omitempty"`
	PromiseTimeout int64              `json:"promiseTimeout"`
	Tags           *map[string]string `json:"tags,omitempty"`
}

Schedule defines model for Schedule.

type SearchSchedulesParams

type SearchSchedulesParams struct {
	// Id Search schedules for matching IDs, can include wildcards.
	//
	// For example:
	// - "foo/*" matches all IDs starting with "foo/"
	// - "*/bar" matches all IDs starting with "bar/"
	// - "foo/*/bar" matches all IDs starting with "foo/" and ending with "/bar"
	Id   *string            `form:"id,omitempty" json:"id,omitempty"`
	Tags *map[string]string `json:"tags,omitempty"`

	// Limit Number of results
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Cursor for pagination
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`

	// RequestId Unique ID for each request
	RequestId *RequestIdHeader `json:"request-id,omitempty"`
}

SearchSchedulesParams defines parameters for SearchSchedules.

type SearchSchedulesResp

type SearchSchedulesResp struct {
	Cursor    *string     `json:"cursor,omitempty"`
	Schedules *[]Schedule `json:"schedules,omitempty"`
}

SearchSchedulesResp defines model for SearchSchedulesResp.

type SearchSchedulesResponse

type SearchSchedulesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SearchSchedulesResp
}

func ParseSearchSchedulesResponse

func ParseSearchSchedulesResponse(rsp *http.Response) (*SearchSchedulesResponse, error)

ParseSearchSchedulesResponse parses an HTTP response from a SearchSchedulesWithResponse call

func (SearchSchedulesResponse) Status

func (r SearchSchedulesResponse) Status() string

Status returns HTTPResponse.Status

func (SearchSchedulesResponse) StatusCode

func (r SearchSchedulesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

Jump to

Keyboard shortcuts

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