Openapi

package
v0.0.0-...-8ab5fcb Latest Latest
Warning

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

Go to latest
Published: Nov 27, 2023 License: Apache-2.0 Imports: 14 Imported by: 11

Documentation

Overview

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

Code generated by github.com/deepmap/oapi-codegen version v1.12.4 DO NOT EDIT.

Index

Constants

View Source
const (
	BearerAuthScopes = "BearerAuth.Scopes"
)

Variables

This section is empty.

Functions

func GetSwagger

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func NewCreateJobRequest

func NewCreateJobRequest(server string, clusterId string, body CreateJobJSONRequestBody) (*http.Request, error)

NewCreateJobRequest calls the generic CreateJob builder with application/json body

func NewCreateJobRequestWithBody

func NewCreateJobRequestWithBody(server string, clusterId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateJobRequestWithBody generates requests for CreateJob with any type of body

func NewCreateTestScriptRunRequest

func NewCreateTestScriptRunRequest(server string, clusterId string, body CreateTestScriptRunJSONRequestBody) (*http.Request, error)

NewCreateTestScriptRunRequest calls the generic CreateTestScriptRun builder with application/json body

func NewCreateTestScriptRunRequestWithBody

func NewCreateTestScriptRunRequestWithBody(server string, clusterId string, contentType string, body io.Reader) (*http.Request, error)

NewCreateTestScriptRunRequestWithBody generates requests for CreateTestScriptRun with any type of body

func NewDeleteBackplaneClusterClusterIdRequest

func NewDeleteBackplaneClusterClusterIdRequest(server string, clusterId string) (*http.Request, error)

NewDeleteBackplaneClusterClusterIdRequest generates requests for DeleteBackplaneClusterClusterId

func NewDeleteJobRequest

func NewDeleteJobRequest(server string, clusterId string, jobId string) (*http.Request, error)

NewDeleteJobRequest generates requests for DeleteJob

func NewGetAllJobsRequest

func NewGetAllJobsRequest(server string, clusterId string) (*http.Request, error)

NewGetAllJobsRequest generates requests for GetAllJobs

func NewGetAssumeRoleSequenceRequest

func NewGetAssumeRoleSequenceRequest(server string, clusterId string) (*http.Request, error)

NewGetAssumeRoleSequenceRequest generates requests for GetAssumeRoleSequence

func NewGetBackplaneClusterClusterIdRequest

func NewGetBackplaneClusterClusterIdRequest(server string, clusterId string) (*http.Request, error)

NewGetBackplaneClusterClusterIdRequest generates requests for GetBackplaneClusterClusterId

func NewGetCloudConsoleRequest

func NewGetCloudConsoleRequest(server string, clusterId string) (*http.Request, error)

NewGetCloudConsoleRequest generates requests for GetCloudConsole

func NewGetCloudCredentialsRequest

func NewGetCloudCredentialsRequest(server string, clusterId string) (*http.Request, error)

NewGetCloudCredentialsRequest generates requests for GetCloudCredentials

func NewGetJobLogsRequest

func NewGetJobLogsRequest(server string, clusterId string, jobId string, params *GetJobLogsParams) (*http.Request, error)

NewGetJobLogsRequest generates requests for GetJobLogs

func NewGetRunRequest

func NewGetRunRequest(server string, clusterId string, jobId string) (*http.Request, error)

NewGetRunRequest generates requests for GetRun

func NewGetScriptsByClusterRequest

func NewGetScriptsByClusterRequest(server string, clusterId string, params *GetScriptsByClusterParams) (*http.Request, error)

NewGetScriptsByClusterRequest generates requests for GetScriptsByCluster

func NewGetTestScriptRunLogsRequest

func NewGetTestScriptRunLogsRequest(server string, clusterId string, testId string, params *GetTestScriptRunLogsParams) (*http.Request, error)

NewGetTestScriptRunLogsRequest generates requests for GetTestScriptRunLogs

func NewGetTestScriptRunRequest

func NewGetTestScriptRunRequest(server string, clusterId string, testId string) (*http.Request, error)

NewGetTestScriptRunRequest generates requests for GetTestScriptRun

func NewHeadBackplaneClusterClusterIdRequest

func NewHeadBackplaneClusterClusterIdRequest(server string, clusterId string) (*http.Request, error)

NewHeadBackplaneClusterClusterIdRequest generates requests for HeadBackplaneClusterClusterId

func NewLoginClusterRequest

func NewLoginClusterRequest(server string, clusterId string) (*http.Request, error)

NewLoginClusterRequest generates requests for LoginCluster

func NewOptionsBackplaneClusterClusterIdRequest

func NewOptionsBackplaneClusterClusterIdRequest(server string, clusterId string) (*http.Request, error)

NewOptionsBackplaneClusterClusterIdRequest generates requests for OptionsBackplaneClusterClusterId

func NewPatchBackplaneClusterClusterIdRequest

func NewPatchBackplaneClusterClusterIdRequest(server string, clusterId string) (*http.Request, error)

NewPatchBackplaneClusterClusterIdRequest generates requests for PatchBackplaneClusterClusterId

func NewPostBackplaneClusterClusterIdRequest

func NewPostBackplaneClusterClusterIdRequest(server string, clusterId string) (*http.Request, error)

NewPostBackplaneClusterClusterIdRequest generates requests for PostBackplaneClusterClusterId

func NewPutBackplaneClusterClusterIdRequest

func NewPutBackplaneClusterClusterIdRequest(server string, clusterId string) (*http.Request, error)

NewPutBackplaneClusterClusterIdRequest generates requests for PutBackplaneClusterClusterId

func NewTraceBackplaneClusterClusterIdRequest

func NewTraceBackplaneClusterClusterIdRequest(server string, clusterId string) (*http.Request, error)

NewTraceBackplaneClusterClusterIdRequest generates requests for TraceBackplaneClusterClusterId

func PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type AssumableRole

type AssumableRole struct {
	// Arn ARN for the assumable role
	Arn string `json:"arn"`

	// Name Human readable
	Name string `json:"name"`
}

AssumableRole Roles and there corresponding ARN

type AssumeRoleSequenceResponse

type AssumeRoleSequenceResponse struct {
	// AssumptionSequence Role ARNs to assume in order
	AssumptionSequence []AssumableRole `json:"assumptionSequence"`
}

AssumeRoleSequenceResponse Response for assume role handler

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) CreateJob

func (c *Client) CreateJob(ctx context.Context, clusterId string, body CreateJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateJobWithBody

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

func (*Client) CreateTestScriptRun

func (c *Client) CreateTestScriptRun(ctx context.Context, clusterId string, body CreateTestScriptRunJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateTestScriptRunWithBody

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

func (*Client) DeleteBackplaneClusterClusterId

func (c *Client) DeleteBackplaneClusterClusterId(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteJob

func (c *Client) DeleteJob(ctx context.Context, clusterId string, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAllJobs

func (c *Client) GetAllJobs(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetAssumeRoleSequence

func (c *Client) GetAssumeRoleSequence(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetBackplaneClusterClusterId

func (c *Client) GetBackplaneClusterClusterId(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetCloudConsole

func (c *Client) GetCloudConsole(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetCloudCredentials

func (c *Client) GetCloudCredentials(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetJobLogs

func (c *Client) GetJobLogs(ctx context.Context, clusterId string, jobId string, params *GetJobLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetRun

func (c *Client) GetRun(ctx context.Context, clusterId string, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetScriptsByCluster

func (c *Client) GetScriptsByCluster(ctx context.Context, clusterId string, params *GetScriptsByClusterParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTestScriptRun

func (c *Client) GetTestScriptRun(ctx context.Context, clusterId string, testId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTestScriptRunLogs

func (c *Client) GetTestScriptRunLogs(ctx context.Context, clusterId string, testId string, params *GetTestScriptRunLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) HeadBackplaneClusterClusterId

func (c *Client) HeadBackplaneClusterClusterId(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) LoginCluster

func (c *Client) LoginCluster(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) OptionsBackplaneClusterClusterId

func (c *Client) OptionsBackplaneClusterClusterId(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PatchBackplaneClusterClusterId

func (c *Client) PatchBackplaneClusterClusterId(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostBackplaneClusterClusterId

func (c *Client) PostBackplaneClusterClusterId(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PutBackplaneClusterClusterId

func (c *Client) PutBackplaneClusterClusterId(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) TraceBackplaneClusterClusterId

func (c *Client) TraceBackplaneClusterClusterId(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// GetCloudConsole request
	GetCloudConsole(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAssumeRoleSequence request
	GetAssumeRoleSequence(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCloudCredentials request
	GetCloudCredentials(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteBackplaneClusterClusterId request
	DeleteBackplaneClusterClusterId(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetBackplaneClusterClusterId request
	GetBackplaneClusterClusterId(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// HeadBackplaneClusterClusterId request
	HeadBackplaneClusterClusterId(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// OptionsBackplaneClusterClusterId request
	OptionsBackplaneClusterClusterId(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchBackplaneClusterClusterId request
	PatchBackplaneClusterClusterId(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostBackplaneClusterClusterId request
	PostBackplaneClusterClusterId(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PutBackplaneClusterClusterId request
	PutBackplaneClusterClusterId(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// TraceBackplaneClusterClusterId request
	TraceBackplaneClusterClusterId(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// LoginCluster request
	LoginCluster(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetScriptsByCluster request
	GetScriptsByCluster(ctx context.Context, clusterId string, params *GetScriptsByClusterParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetAllJobs request
	GetAllJobs(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateJob request with any body
	CreateJobWithBody(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateJob(ctx context.Context, clusterId string, body CreateJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteJob request
	DeleteJob(ctx context.Context, clusterId string, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRun request
	GetRun(ctx context.Context, clusterId string, jobId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetJobLogs request
	GetJobLogs(ctx context.Context, clusterId string, jobId string, params *GetJobLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateTestScriptRun request with any body
	CreateTestScriptRunWithBody(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateTestScriptRun(ctx context.Context, clusterId string, body CreateTestScriptRunJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTestScriptRun request
	GetTestScriptRun(ctx context.Context, clusterId string, testId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTestScriptRunLogs request
	GetTestScriptRunLogs(ctx context.Context, clusterId string, testId string, params *GetTestScriptRunLogsParams, 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) CreateJobWithBodyWithResponse

func (c *ClientWithResponses) CreateJobWithBodyWithResponse(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateJobResponse, error)

CreateJobWithBodyWithResponse request with arbitrary body returning *CreateJobResponse

func (*ClientWithResponses) CreateJobWithResponse

func (c *ClientWithResponses) CreateJobWithResponse(ctx context.Context, clusterId string, body CreateJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateJobResponse, error)

func (*ClientWithResponses) CreateTestScriptRunWithBodyWithResponse

func (c *ClientWithResponses) CreateTestScriptRunWithBodyWithResponse(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTestScriptRunResponse, error)

CreateTestScriptRunWithBodyWithResponse request with arbitrary body returning *CreateTestScriptRunResponse

func (*ClientWithResponses) CreateTestScriptRunWithResponse

func (c *ClientWithResponses) CreateTestScriptRunWithResponse(ctx context.Context, clusterId string, body CreateTestScriptRunJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTestScriptRunResponse, error)

func (*ClientWithResponses) DeleteBackplaneClusterClusterIdWithResponse

func (c *ClientWithResponses) DeleteBackplaneClusterClusterIdWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*DeleteBackplaneClusterClusterIdResponse, error)

DeleteBackplaneClusterClusterIdWithResponse request returning *DeleteBackplaneClusterClusterIdResponse

func (*ClientWithResponses) DeleteJobWithResponse

func (c *ClientWithResponses) DeleteJobWithResponse(ctx context.Context, clusterId string, jobId string, reqEditors ...RequestEditorFn) (*DeleteJobResponse, error)

DeleteJobWithResponse request returning *DeleteJobResponse

func (*ClientWithResponses) GetAllJobsWithResponse

func (c *ClientWithResponses) GetAllJobsWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*GetAllJobsResponse, error)

GetAllJobsWithResponse request returning *GetAllJobsResponse

func (*ClientWithResponses) GetAssumeRoleSequenceWithResponse

func (c *ClientWithResponses) GetAssumeRoleSequenceWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*GetAssumeRoleSequenceResponse, error)

GetAssumeRoleSequenceWithResponse request returning *GetAssumeRoleSequenceResponse

func (*ClientWithResponses) GetBackplaneClusterClusterIdWithResponse

func (c *ClientWithResponses) GetBackplaneClusterClusterIdWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*GetBackplaneClusterClusterIdResponse, error)

GetBackplaneClusterClusterIdWithResponse request returning *GetBackplaneClusterClusterIdResponse

func (*ClientWithResponses) GetCloudConsoleWithResponse

func (c *ClientWithResponses) GetCloudConsoleWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*GetCloudConsoleResponse, error)

GetCloudConsoleWithResponse request returning *GetCloudConsoleResponse

func (*ClientWithResponses) GetCloudCredentialsWithResponse

func (c *ClientWithResponses) GetCloudCredentialsWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*GetCloudCredentialsResponse, error)

GetCloudCredentialsWithResponse request returning *GetCloudCredentialsResponse

func (*ClientWithResponses) GetJobLogsWithResponse

func (c *ClientWithResponses) GetJobLogsWithResponse(ctx context.Context, clusterId string, jobId string, params *GetJobLogsParams, reqEditors ...RequestEditorFn) (*GetJobLogsResponse, error)

GetJobLogsWithResponse request returning *GetJobLogsResponse

func (*ClientWithResponses) GetRunWithResponse

func (c *ClientWithResponses) GetRunWithResponse(ctx context.Context, clusterId string, jobId string, reqEditors ...RequestEditorFn) (*GetRunResponse, error)

GetRunWithResponse request returning *GetRunResponse

func (*ClientWithResponses) GetScriptsByClusterWithResponse

func (c *ClientWithResponses) GetScriptsByClusterWithResponse(ctx context.Context, clusterId string, params *GetScriptsByClusterParams, reqEditors ...RequestEditorFn) (*GetScriptsByClusterResponse, error)

GetScriptsByClusterWithResponse request returning *GetScriptsByClusterResponse

func (*ClientWithResponses) GetTestScriptRunLogsWithResponse

func (c *ClientWithResponses) GetTestScriptRunLogsWithResponse(ctx context.Context, clusterId string, testId string, params *GetTestScriptRunLogsParams, reqEditors ...RequestEditorFn) (*GetTestScriptRunLogsResponse, error)

GetTestScriptRunLogsWithResponse request returning *GetTestScriptRunLogsResponse

func (*ClientWithResponses) GetTestScriptRunWithResponse

func (c *ClientWithResponses) GetTestScriptRunWithResponse(ctx context.Context, clusterId string, testId string, reqEditors ...RequestEditorFn) (*GetTestScriptRunResponse, error)

GetTestScriptRunWithResponse request returning *GetTestScriptRunResponse

func (*ClientWithResponses) HeadBackplaneClusterClusterIdWithResponse

func (c *ClientWithResponses) HeadBackplaneClusterClusterIdWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*HeadBackplaneClusterClusterIdResponse, error)

HeadBackplaneClusterClusterIdWithResponse request returning *HeadBackplaneClusterClusterIdResponse

func (*ClientWithResponses) LoginClusterWithResponse

func (c *ClientWithResponses) LoginClusterWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*LoginClusterResponse, error)

LoginClusterWithResponse request returning *LoginClusterResponse

func (*ClientWithResponses) OptionsBackplaneClusterClusterIdWithResponse

func (c *ClientWithResponses) OptionsBackplaneClusterClusterIdWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*OptionsBackplaneClusterClusterIdResponse, error)

OptionsBackplaneClusterClusterIdWithResponse request returning *OptionsBackplaneClusterClusterIdResponse

func (*ClientWithResponses) PatchBackplaneClusterClusterIdWithResponse

func (c *ClientWithResponses) PatchBackplaneClusterClusterIdWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*PatchBackplaneClusterClusterIdResponse, error)

PatchBackplaneClusterClusterIdWithResponse request returning *PatchBackplaneClusterClusterIdResponse

func (*ClientWithResponses) PostBackplaneClusterClusterIdWithResponse

func (c *ClientWithResponses) PostBackplaneClusterClusterIdWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*PostBackplaneClusterClusterIdResponse, error)

PostBackplaneClusterClusterIdWithResponse request returning *PostBackplaneClusterClusterIdResponse

func (*ClientWithResponses) PutBackplaneClusterClusterIdWithResponse

func (c *ClientWithResponses) PutBackplaneClusterClusterIdWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*PutBackplaneClusterClusterIdResponse, error)

PutBackplaneClusterClusterIdWithResponse request returning *PutBackplaneClusterClusterIdResponse

func (*ClientWithResponses) TraceBackplaneClusterClusterIdWithResponse

func (c *ClientWithResponses) TraceBackplaneClusterClusterIdWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*TraceBackplaneClusterClusterIdResponse, error)

TraceBackplaneClusterClusterIdWithResponse request returning *TraceBackplaneClusterClusterIdResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetCloudConsole request
	GetCloudConsoleWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*GetCloudConsoleResponse, error)

	// GetAssumeRoleSequence request
	GetAssumeRoleSequenceWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*GetAssumeRoleSequenceResponse, error)

	// GetCloudCredentials request
	GetCloudCredentialsWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*GetCloudCredentialsResponse, error)

	// DeleteBackplaneClusterClusterId request
	DeleteBackplaneClusterClusterIdWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*DeleteBackplaneClusterClusterIdResponse, error)

	// GetBackplaneClusterClusterId request
	GetBackplaneClusterClusterIdWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*GetBackplaneClusterClusterIdResponse, error)

	// HeadBackplaneClusterClusterId request
	HeadBackplaneClusterClusterIdWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*HeadBackplaneClusterClusterIdResponse, error)

	// OptionsBackplaneClusterClusterId request
	OptionsBackplaneClusterClusterIdWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*OptionsBackplaneClusterClusterIdResponse, error)

	// PatchBackplaneClusterClusterId request
	PatchBackplaneClusterClusterIdWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*PatchBackplaneClusterClusterIdResponse, error)

	// PostBackplaneClusterClusterId request
	PostBackplaneClusterClusterIdWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*PostBackplaneClusterClusterIdResponse, error)

	// PutBackplaneClusterClusterId request
	PutBackplaneClusterClusterIdWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*PutBackplaneClusterClusterIdResponse, error)

	// TraceBackplaneClusterClusterId request
	TraceBackplaneClusterClusterIdWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*TraceBackplaneClusterClusterIdResponse, error)

	// LoginCluster request
	LoginClusterWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*LoginClusterResponse, error)

	// GetScriptsByCluster request
	GetScriptsByClusterWithResponse(ctx context.Context, clusterId string, params *GetScriptsByClusterParams, reqEditors ...RequestEditorFn) (*GetScriptsByClusterResponse, error)

	// GetAllJobs request
	GetAllJobsWithResponse(ctx context.Context, clusterId string, reqEditors ...RequestEditorFn) (*GetAllJobsResponse, error)

	// CreateJob request with any body
	CreateJobWithBodyWithResponse(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateJobResponse, error)

	CreateJobWithResponse(ctx context.Context, clusterId string, body CreateJobJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateJobResponse, error)

	// DeleteJob request
	DeleteJobWithResponse(ctx context.Context, clusterId string, jobId string, reqEditors ...RequestEditorFn) (*DeleteJobResponse, error)

	// GetRun request
	GetRunWithResponse(ctx context.Context, clusterId string, jobId string, reqEditors ...RequestEditorFn) (*GetRunResponse, error)

	// GetJobLogs request
	GetJobLogsWithResponse(ctx context.Context, clusterId string, jobId string, params *GetJobLogsParams, reqEditors ...RequestEditorFn) (*GetJobLogsResponse, error)

	// CreateTestScriptRun request with any body
	CreateTestScriptRunWithBodyWithResponse(ctx context.Context, clusterId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateTestScriptRunResponse, error)

	CreateTestScriptRunWithResponse(ctx context.Context, clusterId string, body CreateTestScriptRunJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateTestScriptRunResponse, error)

	// GetTestScriptRun request
	GetTestScriptRunWithResponse(ctx context.Context, clusterId string, testId string, reqEditors ...RequestEditorFn) (*GetTestScriptRunResponse, error)

	// GetTestScriptRunLogs request
	GetTestScriptRunLogsWithResponse(ctx context.Context, clusterId string, testId string, params *GetTestScriptRunLogsParams, reqEditors ...RequestEditorFn) (*GetTestScriptRunLogsResponse, error)
}

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

type CloudCredentialsResponse

type CloudCredentialsResponse struct {
	// ClusterID ClusterID
	ClusterID string `json:"clusterID"`

	// ConsoleLink Link to the console, optional
	ConsoleLink *string `json:"consoleLink,omitempty"`

	// Credentials Cloud credentials, optional
	Credentials *string `json:"credentials,omitempty"`

	// Region Region, optional
	Region *string `json:"region,omitempty"`
}

CloudCredentialsResponse Response for cloud handler

type CreateJob

type CreateJob struct {
	// CanonicalName Name of the script to run
	CanonicalName *string `json:"canonicalName,omitempty"`

	// Parameters A map of parameters for the script, must be a flat object and matches
	// the parameters declared on the metadata
	Parameters *map[string]string `json:"parameters,omitempty"`
}

CreateJob defines model for CreateJob.

type CreateJobJSONRequestBody

type CreateJobJSONRequestBody = CreateJob

CreateJobJSONRequestBody defines body for CreateJob for application/json ContentType.

type CreateJobResponse

type CreateJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Job
}

func ParseCreateJobResponse

func ParseCreateJobResponse(rsp *http.Response) (*CreateJobResponse, error)

ParseCreateJobResponse parses an HTTP response from a CreateJobWithResponse call

func (CreateJobResponse) Status

func (r CreateJobResponse) Status() string

Status returns HTTPResponse.Status

func (CreateJobResponse) StatusCode

func (r CreateJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateTestJob

type CreateTestJob struct {
	// BaseImageOverride Container image tag to override default managed-scripts base image during test job run.
	BaseImageOverride *string `json:"baseImageOverride,omitempty"`

	// DryRun Flag to indicate whether to generate a template or execute the script
	DryRun *bool `json:"dryRun,omitempty"`

	// Parameters A map of parameters for the script, must be a flat object and matches
	// the parameters declared on the metadata
	Parameters *map[string]string `json:"parameters,omitempty"`

	// ScriptBody Base64 encoded script body to run
	ScriptBody string `json:"scriptBody"`

	// ScriptMetadata Script metadata
	ScriptMetadata ScriptMetadata `json:"scriptMetadata"`
}

CreateTestJob Body for creating a test job

type CreateTestScriptRunJSONRequestBody

type CreateTestScriptRunJSONRequestBody = CreateTestJob

CreateTestScriptRunJSONRequestBody defines body for CreateTestScriptRun for application/json ContentType.

type CreateTestScriptRunResponse

type CreateTestScriptRunResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TestJobResult
}

func ParseCreateTestScriptRunResponse

func ParseCreateTestScriptRunResponse(rsp *http.Response) (*CreateTestScriptRunResponse, error)

ParseCreateTestScriptRunResponse parses an HTTP response from a CreateTestScriptRunWithResponse call

func (CreateTestScriptRunResponse) Status

Status returns HTTPResponse.Status

func (CreateTestScriptRunResponse) StatusCode

func (r CreateTestScriptRunResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteBackplaneClusterClusterIdResponse

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

func ParseDeleteBackplaneClusterClusterIdResponse

func ParseDeleteBackplaneClusterClusterIdResponse(rsp *http.Response) (*DeleteBackplaneClusterClusterIdResponse, error)

ParseDeleteBackplaneClusterClusterIdResponse parses an HTTP response from a DeleteBackplaneClusterClusterIdWithResponse call

func (DeleteBackplaneClusterClusterIdResponse) Status

Status returns HTTPResponse.Status

func (DeleteBackplaneClusterClusterIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type DeleteJobResponse

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

func ParseDeleteJobResponse

func ParseDeleteJobResponse(rsp *http.Response) (*DeleteJobResponse, error)

ParseDeleteJobResponse parses an HTTP response from a DeleteJobWithResponse call

func (DeleteJobResponse) Status

func (r DeleteJobResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteJobResponse) StatusCode

func (r DeleteJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EnvDecl

type EnvDecl struct {
	// Description A description of the env var
	Description *string `json:"description,omitempty"`

	// Key Key of the env
	Key *string `json:"key,omitempty"`

	// Optional Whether this env var is optional
	Optional *bool `json:"optional,omitempty"`
}

EnvDecl defines model for EnvDecl.

type EnvRealised

type EnvRealised struct {
	// Key Key of the env
	Key *string `json:"key,omitempty"`

	// Value The processed value of the env var
	Value *string `json:"value,omitempty"`
}

EnvRealised defines model for EnvRealised.

type Error

type Error struct {
	// Message Error Message
	Message *string `json:"message,omitempty"`

	// StatusCode HTTP status code
	StatusCode *int `json:"statusCode,omitempty"`
}

Error defines model for Error.

type GetAllJobsResponse

type GetAllJobsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Job
}

func ParseGetAllJobsResponse

func ParseGetAllJobsResponse(rsp *http.Response) (*GetAllJobsResponse, error)

ParseGetAllJobsResponse parses an HTTP response from a GetAllJobsWithResponse call

func (GetAllJobsResponse) Status

func (r GetAllJobsResponse) Status() string

Status returns HTTPResponse.Status

func (GetAllJobsResponse) StatusCode

func (r GetAllJobsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAssumeRoleSequenceResponse

type GetAssumeRoleSequenceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AssumeRoleSequenceResponse
}

func ParseGetAssumeRoleSequenceResponse

func ParseGetAssumeRoleSequenceResponse(rsp *http.Response) (*GetAssumeRoleSequenceResponse, error)

ParseGetAssumeRoleSequenceResponse parses an HTTP response from a GetAssumeRoleSequenceWithResponse call

func (GetAssumeRoleSequenceResponse) Status

Status returns HTTPResponse.Status

func (GetAssumeRoleSequenceResponse) StatusCode

func (r GetAssumeRoleSequenceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetBackplaneClusterClusterIdResponse

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

func ParseGetBackplaneClusterClusterIdResponse

func ParseGetBackplaneClusterClusterIdResponse(rsp *http.Response) (*GetBackplaneClusterClusterIdResponse, error)

ParseGetBackplaneClusterClusterIdResponse parses an HTTP response from a GetBackplaneClusterClusterIdWithResponse call

func (GetBackplaneClusterClusterIdResponse) Status

Status returns HTTPResponse.Status

func (GetBackplaneClusterClusterIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetCloudConsoleResponse

type GetCloudConsoleResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CloudCredentialsResponse
}

func ParseGetCloudConsoleResponse

func ParseGetCloudConsoleResponse(rsp *http.Response) (*GetCloudConsoleResponse, error)

ParseGetCloudConsoleResponse parses an HTTP response from a GetCloudConsoleWithResponse call

func (GetCloudConsoleResponse) Status

func (r GetCloudConsoleResponse) Status() string

Status returns HTTPResponse.Status

func (GetCloudConsoleResponse) StatusCode

func (r GetCloudConsoleResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCloudCredentialsResponse

type GetCloudCredentialsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CloudCredentialsResponse
}

func ParseGetCloudCredentialsResponse

func ParseGetCloudCredentialsResponse(rsp *http.Response) (*GetCloudCredentialsResponse, error)

ParseGetCloudCredentialsResponse parses an HTTP response from a GetCloudCredentialsWithResponse call

func (GetCloudCredentialsResponse) Status

Status returns HTTPResponse.Status

func (GetCloudCredentialsResponse) StatusCode

func (r GetCloudCredentialsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetJobLogsParams

type GetJobLogsParams struct {
	// Version The version to return. Default is JSON, v2 is streaming
	Version *string `form:"version,omitempty" json:"version,omitempty"`

	// Follow Specify if the logs should be followed.
	Follow *bool `form:"follow,omitempty" json:"follow,omitempty"`
}

GetJobLogsParams defines parameters for GetJobLogs.

type GetJobLogsResponse

type GetJobLogsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Logs
}

func ParseGetJobLogsResponse

func ParseGetJobLogsResponse(rsp *http.Response) (*GetJobLogsResponse, error)

ParseGetJobLogsResponse parses an HTTP response from a GetJobLogsWithResponse call

func (GetJobLogsResponse) Status

func (r GetJobLogsResponse) Status() string

Status returns HTTPResponse.Status

func (GetJobLogsResponse) StatusCode

func (r GetJobLogsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetRunResponse

type GetRunResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Job
}

func ParseGetRunResponse

func ParseGetRunResponse(rsp *http.Response) (*GetRunResponse, error)

ParseGetRunResponse parses an HTTP response from a GetRunWithResponse call

func (GetRunResponse) Status

func (r GetRunResponse) Status() string

Status returns HTTPResponse.Status

func (GetRunResponse) StatusCode

func (r GetRunResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetScriptsByClusterParams

type GetScriptsByClusterParams struct {
	Scriptname *string `form:"scriptname,omitempty" json:"scriptname,omitempty"`
}

GetScriptsByClusterParams defines parameters for GetScriptsByCluster.

type GetScriptsByClusterResponse

type GetScriptsByClusterResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Scripts
}

func ParseGetScriptsByClusterResponse

func ParseGetScriptsByClusterResponse(rsp *http.Response) (*GetScriptsByClusterResponse, error)

ParseGetScriptsByClusterResponse parses an HTTP response from a GetScriptsByClusterWithResponse call

func (GetScriptsByClusterResponse) Status

Status returns HTTPResponse.Status

func (GetScriptsByClusterResponse) StatusCode

func (r GetScriptsByClusterResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTestScriptRunLogsParams

type GetTestScriptRunLogsParams struct {
	// Version The version to return. Default is JSON, v2 is streaming
	Version *string `form:"version,omitempty" json:"version,omitempty"`

	// Follow Specify if the logs should be followed.
	Follow *bool `form:"follow,omitempty" json:"follow,omitempty"`
}

GetTestScriptRunLogsParams defines parameters for GetTestScriptRunLogs.

type GetTestScriptRunLogsResponse

type GetTestScriptRunLogsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Logs
}

func ParseGetTestScriptRunLogsResponse

func ParseGetTestScriptRunLogsResponse(rsp *http.Response) (*GetTestScriptRunLogsResponse, error)

ParseGetTestScriptRunLogsResponse parses an HTTP response from a GetTestScriptRunLogsWithResponse call

func (GetTestScriptRunLogsResponse) Status

Status returns HTTPResponse.Status

func (GetTestScriptRunLogsResponse) StatusCode

func (r GetTestScriptRunLogsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTestScriptRunResponse

type GetTestScriptRunResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TestJobResult
}

func ParseGetTestScriptRunResponse

func ParseGetTestScriptRunResponse(rsp *http.Response) (*GetTestScriptRunResponse, error)

ParseGetTestScriptRunResponse parses an HTTP response from a GetTestScriptRunWithResponse call

func (GetTestScriptRunResponse) Status

func (r GetTestScriptRunResponse) Status() string

Status returns HTTPResponse.Status

func (GetTestScriptRunResponse) StatusCode

func (r GetTestScriptRunResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HeadBackplaneClusterClusterIdResponse

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

func ParseHeadBackplaneClusterClusterIdResponse

func ParseHeadBackplaneClusterClusterIdResponse(rsp *http.Response) (*HeadBackplaneClusterClusterIdResponse, error)

ParseHeadBackplaneClusterClusterIdResponse parses an HTTP response from a HeadBackplaneClusterClusterIdWithResponse call

func (HeadBackplaneClusterClusterIdResponse) Status

Status returns HTTPResponse.Status

func (HeadBackplaneClusterClusterIdResponse) StatusCode

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 Job

type Job struct {
	// JobId An unique id to identify this job run
	JobId     *string    `json:"jobId,omitempty"`
	JobStatus *JobStatus `json:"jobStatus,omitempty"`

	// Message A helpful message to the user
	Message *string `json:"message,omitempty"`

	// UserMD5 MD5 of the user who created the job
	UserMD5 *string `json:"userMD5,omitempty"`
}

Job defines model for Job.

type JobStatus

type JobStatus struct {
	// End End/Finish time of the script
	End *time.Time `json:"end"`

	// Envs A array of environment parameters for the script
	Envs *[]EnvRealised `json:"envs,omitempty"`

	// Namespace Namespace of the script being ran
	Namespace *string `json:"namespace,omitempty"`
	Script    *Script `json:"script,omitempty"`

	// Start Start time of the script
	Start *time.Time `json:"start,omitempty"`

	// Status status of the script
	Status *JobStatusStatus `json:"status,omitempty"`
}

JobStatus defines model for JobStatus.

type JobStatusStatus

type JobStatusStatus string

JobStatusStatus status of the script

const (
	JobStatusStatusFailed    JobStatusStatus = "Failed"
	JobStatusStatusKilled    JobStatusStatus = "Killed"
	JobStatusStatusPending   JobStatusStatus = "Pending"
	JobStatusStatusRunning   JobStatusStatus = "Running"
	JobStatusStatusSucceeded JobStatusStatus = "Succeeded"
	JobStatusStatusUnknown   JobStatusStatus = "Unknown"
)

Defines values for JobStatusStatus.

type LabelDecl

type LabelDecl struct {
	// Description A brief description of the label
	Description *string `json:"description,omitempty"`

	// Key Key of the label
	Key *string `json:"key,omitempty"`

	// Values Values for the label
	Values *[]interface{} `json:"values,omitempty"`
}

LabelDecl defines model for LabelDecl.

type LoginClusterResponse

type LoginClusterResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *LoginResponse
}

func ParseLoginClusterResponse

func ParseLoginClusterResponse(rsp *http.Response) (*LoginClusterResponse, error)

ParseLoginClusterResponse parses an HTTP response from a LoginClusterWithResponse call

func (LoginClusterResponse) Status

func (r LoginClusterResponse) Status() string

Status returns HTTPResponse.Status

func (LoginClusterResponse) StatusCode

func (r LoginClusterResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type LoginResponse

type LoginResponse struct {
	// Message message
	Message *string `json:"message,omitempty"`

	// ProxyUri KubeAPI proxy URI
	ProxyUri *string `json:"proxy_uri,omitempty"`

	// StatusCode status code
	StatusCode *int `json:"statusCode,omitempty"`
}

LoginResponse Login status response

type Logs

type Logs struct {
	// Logs Logs of the pod
	Logs *string `json:"logs,omitempty"`
}

Logs defines model for Logs.

type OptionsBackplaneClusterClusterIdResponse

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

func ParseOptionsBackplaneClusterClusterIdResponse

func ParseOptionsBackplaneClusterClusterIdResponse(rsp *http.Response) (*OptionsBackplaneClusterClusterIdResponse, error)

ParseOptionsBackplaneClusterClusterIdResponse parses an HTTP response from a OptionsBackplaneClusterClusterIdWithResponse call

func (OptionsBackplaneClusterClusterIdResponse) Status

Status returns HTTPResponse.Status

func (OptionsBackplaneClusterClusterIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PatchBackplaneClusterClusterIdResponse

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

func ParsePatchBackplaneClusterClusterIdResponse

func ParsePatchBackplaneClusterClusterIdResponse(rsp *http.Response) (*PatchBackplaneClusterClusterIdResponse, error)

ParsePatchBackplaneClusterClusterIdResponse parses an HTTP response from a PatchBackplaneClusterClusterIdWithResponse call

func (PatchBackplaneClusterClusterIdResponse) Status

Status returns HTTPResponse.Status

func (PatchBackplaneClusterClusterIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PolicyRule

type PolicyRule struct {
	ApiGroups       *[]string `json:"apiGroups,omitempty" yaml:"apiGroups,omitempty"`
	NonResourceURLs *[]string `json:"nonResourceURLs,omitempty" yaml:"nonResourceURLs,omitempty"`
	ResourceNames   *[]string `json:"resourceNames,omitempty" yaml:"resourceNames,omitempty"`
	Resources       *[]string `json:"resources,omitempty" yaml:"resources,omitempty"`
	Verbs           *[]string `json:"verbs,omitempty" yaml:"verbs,omitempty"`
}

PolicyRule defines model for PolicyRule.

type PostBackplaneClusterClusterIdResponse

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

func ParsePostBackplaneClusterClusterIdResponse

func ParsePostBackplaneClusterClusterIdResponse(rsp *http.Response) (*PostBackplaneClusterClusterIdResponse, error)

ParsePostBackplaneClusterClusterIdResponse parses an HTTP response from a PostBackplaneClusterClusterIdWithResponse call

func (PostBackplaneClusterClusterIdResponse) Status

Status returns HTTPResponse.Status

func (PostBackplaneClusterClusterIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PutBackplaneClusterClusterIdResponse

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

func ParsePutBackplaneClusterClusterIdResponse

func ParsePutBackplaneClusterClusterIdResponse(rsp *http.Response) (*PutBackplaneClusterClusterIdResponse, error)

ParsePutBackplaneClusterClusterIdResponse parses an HTTP response from a PutBackplaneClusterClusterIdWithResponse call

func (PutBackplaneClusterClusterIdResponse) Status

Status returns HTTPResponse.Status

func (PutBackplaneClusterClusterIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type RBAC

type RBAC struct {
	ClusterRoleRules *[]PolicyRule   `json:"clusterRoleRules,omitempty" yaml:"clusterRoleRules,omitempty"`
	Roles            *[]RoleRbacDecl `json:"roles,omitempty" yaml:"roles,omitempty"`
}

RBAC RBAC declaration

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

type RoleRbacDecl

type RoleRbacDecl struct {
	Namespace *string       `json:"namespace,omitempty"`
	Rules     *[]PolicyRule `json:"rules,omitempty"`
}

RoleRbacDecl defines model for RoleRbacDecl.

type Script

type Script struct {
	// AllowedGroups Which groups are allowed to run this script
	AllowedGroups *[]string `json:"allowedGroups,omitempty"`

	// Author Author of the script, github username
	Author *string `json:"author,omitempty"`

	// CanonicalName Fully qualified name of the script, in the format of roleId/scriptname.
	// Must be unique, MR in-place check to enforce this
	CanonicalName *string `json:"canonicalName,omitempty"`

	// Description A brief description of the script and what it does
	Description *string `json:"description,omitempty"`

	// Envs An array of environment variables for the script
	Envs *[]EnvDecl `json:"envs,omitempty"`

	// Labels An array of labels for the script
	Labels *[]interface{} `json:"labels,omitempty"`

	// Language The script language
	Language *ScriptLanguage `json:"language,omitempty"`

	// Path Path from the repo root to the script
	Path *string `json:"path,omitempty"`

	// Permalink Permalink to the script file on git
	Permalink *string `json:"permalink,omitempty"`

	// Rbac RBAC declaration
	Rbac *RBAC `json:"rbac,omitempty" yaml:"rbac,omitempty"`

	// ShortDescription A shorter description for tables and lists
	ShortDescription *string `json:"shortDescription,omitempty"`
}

Script defines model for Script.

type ScriptLanguage

type ScriptLanguage string

ScriptLanguage The script language

const (
	ScriptLanguageBash   ScriptLanguage = "bash"
	ScriptLanguagePython ScriptLanguage = "python"
)

Defines values for ScriptLanguage.

type ScriptMetadata

type ScriptMetadata struct {
	AllowedGroups []string               `json:"allowedGroups"`
	Author        string                 `json:"author"`
	Description   string                 `json:"description"`
	Envs          []EnvDecl              `json:"envs"`
	File          string                 `json:"file"`
	Labels        []LabelDecl            `json:"labels"`
	Language      ScriptMetadataLanguage `json:"language"`
	Name          string                 `json:"name"`

	// Rbac RBAC declaration
	Rbac             RBAC   `json:"rbac" yaml:"rbac,omitempty"`
	ShortDescription string `json:"shortDescription"`
}

ScriptMetadata Script metadata

type ScriptMetadataLanguage

type ScriptMetadataLanguage string

ScriptMetadataLanguage defines model for ScriptMetadata.Language.

const (
	ScriptMetadataLanguageBash   ScriptMetadataLanguage = "bash"
	ScriptMetadataLanguagePython ScriptMetadataLanguage = "python"
)

Defines values for ScriptMetadataLanguage.

type Scripts

type Scripts = []Script

Scripts defines model for Scripts.

type TestJobResult

type TestJobResult struct {
	Message *string `json:"message,omitempty"`

	// Status Test run status
	Status *TestJobResultStatus `json:"status,omitempty"`

	// TestId A unique id for test script run
	TestId string `json:"testId"`
}

TestJobResult Body of response for a test job run

type TestJobResultStatus

type TestJobResultStatus string

TestJobResultStatus Test run status

const (
	TestJobResultStatusFailed    TestJobResultStatus = "Failed"
	TestJobResultStatusPending   TestJobResultStatus = "Pending"
	TestJobResultStatusRunning   TestJobResultStatus = "Running"
	TestJobResultStatusSucceeded TestJobResultStatus = "Succeeded"
)

Defines values for TestJobResultStatus.

type TraceBackplaneClusterClusterIdResponse

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

func ParseTraceBackplaneClusterClusterIdResponse

func ParseTraceBackplaneClusterClusterIdResponse(rsp *http.Response) (*TraceBackplaneClusterClusterIdResponse, error)

ParseTraceBackplaneClusterClusterIdResponse parses an HTTP response from a TraceBackplaneClusterClusterIdWithResponse call

func (TraceBackplaneClusterClusterIdResponse) Status

Status returns HTTPResponse.Status

func (TraceBackplaneClusterClusterIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

Jump to

Keyboard shortcuts

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