genclient

package
v0.3.32 Latest Latest
Warning

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

 Go to latest Published: Feb 1, 2024 License: Apache-2.0 Imports: 16 Imported by: 2

Documentation

Overview

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

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

Index

Constants

This section is empty.

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 NewAddArrayJobRequest 

func NewAddArrayJobRequest(server string, body AddArrayJobJSONRequestBody) (*http.Request, error)

NewAddArrayJobRequest calls the generic AddArrayJob builder with application/json body

func NewAddArrayJobRequestWithBody 

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

NewAddArrayJobRequestWithBody generates requests for AddArrayJob with any type of body

func NewAddJobRequest 

func NewAddJobRequest(server string, body AddJobJSONRequestBody) (*http.Request, error)

NewAddJobRequest calls the generic AddJob builder with application/json body

func NewAddJobRequestWithBody 

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

NewAddJobRequestWithBody generates requests for AddJob with any type of body

func NewDeleteJobRequest 

func NewDeleteJobRequest(server string, params *DeleteJobParams) (*http.Request, error)

NewDeleteJobRequest generates requests for DeleteJob

func NewJobControlRequest 

func NewJobControlRequest(server string, params *JobControlParams) (*http.Request, error)

NewJobControlRequest generates requests for JobControl

func NewJobInfoRequest 

func NewJobInfoRequest(server string, params *JobInfoParams) (*http.Request, error)

NewJobInfoRequest generates requests for JobInfo

func NewJobStateRequest 

func NewJobStateRequest(server string, params *JobStateParams) (*http.Request, error)

NewJobStateRequest generates requests for JobState

func NewListArrayJobsRequest 

func NewListArrayJobsRequest(server string, params *ListArrayJobsParams) (*http.Request, error)

NewListArrayJobsRequest generates requests for ListArrayJobs

func NewListJobCategoriesRequest 

func NewListJobCategoriesRequest(server string) (*http.Request, error)

NewListJobCategoriesRequest generates requests for ListJobCategories

func NewListJobsRequest 

func NewListJobsRequest(server string, params *ListJobsParams) (*http.Request, error)

NewListJobsRequest generates requests for ListJobs

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 AddArrayJobJSONBody 

type AddArrayJobJSONBody struct {
	// Embedded struct due to allOf(#/components/schemas/JobTemplate)
	JobTemplate `yaml:",inline"`
	// Embedded fields due to inline allOf schema
	Begin       int64  `json:"begin"`
	End         int64  `json:"end"`
	MaxParallel *int64 `json:"maxParallel,omitempty"`
	Step        *int64 `json:"step,omitempty"`
}

AddArrayJobJSONBody defines parameters for AddArrayJob.

type AddArrayJobJSONRequestBody 

type AddArrayJobJSONRequestBody AddArrayJobJSONBody

AddArrayJobJSONRequestBody defines body for AddArrayJob for application/json ContentType.

type AddArrayJobOutput 

type AddArrayJobOutput struct {
	// Embedded struct due to allOf(#/components/schemas/JobID)
	JobID `yaml:",inline"`
	// Embedded struct due to allOf(#/components/schemas/Error)
	Error `yaml:",inline"`
}

AddArrayJobOutput defines model for AddArrayJobOutput.

type AddArrayJobResponse 

type AddArrayJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AddArrayJobOutput
}

func ParseAddArrayJobResponse 

func ParseAddArrayJobResponse(rsp *http.Response) (*AddArrayJobResponse, error)

ParseAddArrayJobResponse parses an HTTP response from a AddArrayJobWithResponse call

func (AddArrayJobResponse) Status 

func (r AddArrayJobResponse) Status() string

Status returns HTTPResponse.Status

func (AddArrayJobResponse) StatusCode 

func (r AddArrayJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AddJobJSONBody 

type AddJobJSONBody JobTemplate

AddJobJSONBody defines parameters for AddJob.

type AddJobJSONRequestBody 

type AddJobJSONRequestBody AddJobJSONBody

AddJobJSONRequestBody defines body for AddJob for application/json ContentType.

type AddJobOutput 

type AddJobOutput struct {
	// Embedded struct due to allOf(#/components/schemas/JobID)
	JobID `yaml:",inline"`
	// Embedded struct due to allOf(#/components/schemas/Error)
	Error `yaml:",inline"`
}

AddJobOutput defines model for AddJobOutput.

type AddJobResponse 

type AddJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *AddJobOutput
}

func ParseAddJobResponse 

func ParseAddJobResponse(rsp *http.Response) (*AddJobResponse, error)

ParseAddJobResponse parses an HTTP response from a AddJobWithResponse call

func (AddJobResponse) Status 

func (r AddJobResponse) Status() string

Status returns HTTPResponse.Status

func (AddJobResponse) StatusCode 

func (r AddJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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

func (c *Client) AddArrayJob(ctx context.Context, body AddArrayJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AddArrayJobWithBody 

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

func (*Client) AddJob 

func (c *Client) AddJob(ctx context.Context, body AddJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AddJobWithBody 

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

func (*Client) DeleteJob 

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

func (*Client) JobControl 

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

func (*Client) JobInfo 

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

func (*Client) JobState 

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

func (*Client) ListArrayJobs 

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

func (*Client) ListJobCategories 

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

func (*Client) ListJobs 

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

type ClientInterface 

type ClientInterface interface {
	// AddArrayJob request  with any body
	AddArrayJobWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	AddArrayJob(ctx context.Context, body AddArrayJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	AddJob(ctx context.Context, body AddJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteJob request
	DeleteJob(ctx context.Context, params *DeleteJobParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// JobControl request
	JobControl(ctx context.Context, params *JobControlParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// JobInfo request
	JobInfo(ctx context.Context, params *JobInfoParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// JobState request
	JobState(ctx context.Context, params *JobStateParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListArrayJobs request
	ListArrayJobs(ctx context.Context, params *ListArrayJobsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListJobCategories request
	ListJobCategories(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListJobs request
	ListJobs(ctx context.Context, params *ListJobsParams, 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) AddArrayJobWithBodyWithResponse 

func (c *ClientWithResponses) AddArrayJobWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddArrayJobResponse, error)

AddArrayJobWithBodyWithResponse request with arbitrary body returning *AddArrayJobResponse

func (*ClientWithResponses) AddArrayJobWithResponse 

func (c *ClientWithResponses) AddArrayJobWithResponse(ctx context.Context, body AddArrayJobJSONRequestBody, reqEditors ...RequestEditorFn) (*AddArrayJobResponse, error)

func (*ClientWithResponses) AddJobWithBodyWithResponse 

func (c *ClientWithResponses) AddJobWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddJobResponse, error)

AddJobWithBodyWithResponse request with arbitrary body returning *AddJobResponse

func (*ClientWithResponses) AddJobWithResponse 

func (c *ClientWithResponses) AddJobWithResponse(ctx context.Context, body AddJobJSONRequestBody, reqEditors ...RequestEditorFn) (*AddJobResponse, error)

func (*ClientWithResponses) DeleteJobWithResponse 

func (c *ClientWithResponses) DeleteJobWithResponse(ctx context.Context, params *DeleteJobParams, reqEditors ...RequestEditorFn) (*DeleteJobResponse, error)

DeleteJobWithResponse request returning *DeleteJobResponse

func (*ClientWithResponses) JobControlWithResponse 

func (c *ClientWithResponses) JobControlWithResponse(ctx context.Context, params *JobControlParams, reqEditors ...RequestEditorFn) (*JobControlResponse, error)

JobControlWithResponse request returning *JobControlResponse

func (*ClientWithResponses) JobInfoWithResponse 

func (c *ClientWithResponses) JobInfoWithResponse(ctx context.Context, params *JobInfoParams, reqEditors ...RequestEditorFn) (*JobInfoResponse, error)

JobInfoWithResponse request returning *JobInfoResponse

func (*ClientWithResponses) JobStateWithResponse 

func (c *ClientWithResponses) JobStateWithResponse(ctx context.Context, params *JobStateParams, reqEditors ...RequestEditorFn) (*JobStateResponse, error)

JobStateWithResponse request returning *JobStateResponse

func (*ClientWithResponses) ListArrayJobsWithResponse 

func (c *ClientWithResponses) ListArrayJobsWithResponse(ctx context.Context, params *ListArrayJobsParams, reqEditors ...RequestEditorFn) (*ListArrayJobsResponse, error)

ListArrayJobsWithResponse request returning *ListArrayJobsResponse

func (*ClientWithResponses) ListJobCategoriesWithResponse 

func (c *ClientWithResponses) ListJobCategoriesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListJobCategoriesResponse, error)

ListJobCategoriesWithResponse request returning *ListJobCategoriesResponse

func (*ClientWithResponses) ListJobsWithResponse 

func (c *ClientWithResponses) ListJobsWithResponse(ctx context.Context, params *ListJobsParams, reqEditors ...RequestEditorFn) (*ListJobsResponse, error)

ListJobsWithResponse request returning *ListJobsResponse

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// AddArrayJob request  with any body
	AddArrayJobWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddArrayJobResponse, error)

	AddArrayJobWithResponse(ctx context.Context, body AddArrayJobJSONRequestBody, reqEditors ...RequestEditorFn) (*AddArrayJobResponse, error)

	// AddJob request  with any body
	AddJobWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddJobResponse, error)

	AddJobWithResponse(ctx context.Context, body AddJobJSONRequestBody, reqEditors ...RequestEditorFn) (*AddJobResponse, error)

	// DeleteJob request
	DeleteJobWithResponse(ctx context.Context, params *DeleteJobParams, reqEditors ...RequestEditorFn) (*DeleteJobResponse, error)

	// JobControl request
	JobControlWithResponse(ctx context.Context, params *JobControlParams, reqEditors ...RequestEditorFn) (*JobControlResponse, error)

	// JobInfo request
	JobInfoWithResponse(ctx context.Context, params *JobInfoParams, reqEditors ...RequestEditorFn) (*JobInfoResponse, error)

	// JobState request
	JobStateWithResponse(ctx context.Context, params *JobStateParams, reqEditors ...RequestEditorFn) (*JobStateResponse, error)

	// ListArrayJobs request
	ListArrayJobsWithResponse(ctx context.Context, params *ListArrayJobsParams, reqEditors ...RequestEditorFn) (*ListArrayJobsResponse, error)

	// ListJobCategories request
	ListJobCategoriesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListJobCategoriesResponse, error)

	// ListJobs request
	ListJobsWithResponse(ctx context.Context, params *ListJobsParams, reqEditors ...RequestEditorFn) (*ListJobsResponse, error)
}

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

type DeleteJobParams 

type DeleteJobParams struct {

	// ID of the job to manipulate
	JobID string `json:"jobID"`
}

DeleteJobParams defines parameters for DeleteJob.

type DeleteJobResponse 

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

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 Error 

type Error string

error string

type HttpRequestDoer 

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type JobControlParams 

type JobControlParams struct {

	// ID of the job to manipulate
	JobID string `json:"jobID"`

	// action to perform (suspend, resume, hold, release, terminate)
	Action JobControlParamsAction `json:"action"`
}

JobControlParams defines parameters for JobControl.

type JobControlParamsAction 

type JobControlParamsAction string

JobControlParamsAction defines parameters for JobControl.

type JobControlResponse 

type JobControlResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Error
}

func ParseJobControlResponse 

func ParseJobControlResponse(rsp *http.Response) (*JobControlResponse, error)

ParseJobControlResponse parses an HTTP response from a JobControlWithResponse call

func (JobControlResponse) Status 

func (r JobControlResponse) Status() string

Status returns HTTPResponse.Status

func (JobControlResponse) StatusCode 

func (r JobControlResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type JobID 

type JobID string

JobID defines model for JobID.

type JobInfo 

type JobInfo struct {
	AllocatedMachines []string           `json:"allocatedMachines"`
	Annotation        string             `json:"annotation"`
	CpuTime           int64              `json:"cpuTime"`
	DispatchTime      time.Time          `json:"dispatchTime"`
	ExitStatus        int                `json:"exitStatus"`
	Extension         *JobInfo_Extension `json:"extension,omitempty"`
	FinishTime        time.Time          `json:"finishTime"`
	Id                string             `json:"id"`
	JobOwner          string             `json:"jobOwner"`
	QueueName         string             `json:"queueName"`
	Slots             int                `json:"slots"`
	State             string             `json:"state"`
	SubState          string             `json:"subState"`
	SubmissionMachine string             `json:"submissionMachine"`
	SubmissionTime    time.Time          `json:"submissionTime"`
	TerminatingSignal string             `json:"terminatingSignal"`
	WallclockTime     int64              `json:"wallclockTime"`
}

JobInfo defines model for JobInfo.

type JobInfoOutput 

type JobInfoOutput struct {
	// Embedded struct due to allOf(#/components/schemas/JobInfo)
	JobInfo `yaml:",inline"`
	// Embedded struct due to allOf(#/components/schemas/Error)
	Error `yaml:",inline"`
}

JobInfoOutput defines model for JobInfoOutput.

type JobInfoParams 

type JobInfoParams struct {

	// ID if the job for which the JobInfo should be returned
	JobID string `json:"jobID"`
}

JobInfoParams defines parameters for JobInfo.

type JobInfoResponse 

type JobInfoResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *JobInfoOutput
}

func ParseJobInfoResponse 

func ParseJobInfoResponse(rsp *http.Response) (*JobInfoResponse, error)

ParseJobInfoResponse parses an HTTP response from a JobInfoWithResponse call

func (JobInfoResponse) Status 

func (r JobInfoResponse) Status() string

Status returns HTTPResponse.Status

func (JobInfoResponse) StatusCode 

func (r JobInfoResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type JobInfo_Extension added in v0.3.13 

type JobInfo_Extension struct {
	AdditionalProperties map[string]string `json:"-"`
}

JobInfo_Extension defines model for JobInfo.Extension.

func (JobInfo_Extension) Get added in v0.3.13 

func (a JobInfo_Extension) Get(fieldName string) (value string, found bool)

Getter for additional properties for JobInfo_Extension. Returns the specified element and whether it was found

func (JobInfo_Extension) MarshalJSON added in v0.3.13 

func (a JobInfo_Extension) MarshalJSON() ([]byte, error)

Override default JSON handling for JobInfo_Extension to handle AdditionalProperties

func (*JobInfo_Extension) Set added in v0.3.13 

func (a *JobInfo_Extension) Set(fieldName string, value string)

Setter for additional properties for JobInfo_Extension

func (*JobInfo_Extension) UnmarshalJSON added in v0.3.13 

func (a *JobInfo_Extension) UnmarshalJSON(b []byte) error

Override default JSON handling for JobInfo_Extension to handle AdditionalProperties

type JobState 

type JobState string

JobState defines model for JobState. 

const (
	JobStateDone JobState = "done"

	JobStateFailed JobState = "failed"

	JobStateQueued JobState = "queued"

	JobStateQueuedHeld JobState = "queuedHeld"

	JobStateRequeued JobState = "requeued"

	JobStateRequeuedHeld JobState = "requeuedHeld"

	JobStateRunning JobState = "running"

	JobStateSuspended JobState = "suspended"

	JobStateUndetermined JobState = "undetermined"

	JobStateUnset JobState = "unset"
)

Defines values for JobState.

type JobStateOutput 

type JobStateOutput struct {
	// Embedded struct due to allOf(#/components/schemas/JobState)
	JobState `yaml:",inline"`
	// Embedded struct due to allOf(#/components/schemas/JobSubState)
	JobSubState `yaml:",inline"`
}

JobStateOutput defines model for JobStateOutput.

type JobStateParams 

type JobStateParams struct {

	// job ID the current job state should be queried for
	JobID string `json:"jobID"`
}

JobStateParams defines parameters for JobState.

type JobStateResponse 

type JobStateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *JobStateOutput
}

func ParseJobStateResponse 

func ParseJobStateResponse(rsp *http.Response) (*JobStateResponse, error)

ParseJobStateResponse parses an HTTP response from a JobStateWithResponse call

func (JobStateResponse) Status 

func (r JobStateResponse) Status() string

Status returns HTTPResponse.Status

func (JobStateResponse) StatusCode 

func (r JobStateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type JobSubState 

type JobSubState string

JobSubState defines model for JobSubState.

type JobTemplate 

type JobTemplate struct {
	AccountingID      string                     `json:"accountingID"`
	Args              []string                   `json:"args"`
	CandidateMachines []string                   `json:"candidateMachines"`
	DeadlineTime      time.Time                  `json:"deadlineTime"`
	Email             []string                   `json:"email"`
	EmailOnStarted    bool                       `json:"emailOnStarted"`
	EmailOnTerminated bool                       `json:"emailOnTerminated"`
	ErrorPath         string                     `json:"errorPath"`
	Extension         *JobTemplate_Extension     `json:"extension,omitempty"`
	InputPath         string                     `json:"inputPath"`
	JobCategory       string                     `json:"jobCategory"`
	JobEnvironment    JobTemplate_JobEnvironment `json:"jobEnvironment"`
	JobName           string                     `json:"jobName"`
	JoinFiles         bool                       `json:"joinFiles"`
	MachineArch       string                     `json:"machineArch"`
	MachineOs         string                     `json:"machineOs"`
	MaxSlots          int64                      `json:"maxSlots"`
	MinPhysMemory     int64                      `json:"minPhysMemory"`
	MinSlots          int64                      `json:"minSlots"`
	OutputPath        string                     `json:"outputPath"`
	Priority          int64                      `json:"priority"`
	QueueName         string                     `json:"queueName"`
	ReRunnable        bool                       `json:"reRunnable"`
	RemoteCommand     string                     `json:"remoteCommand"`
	ReservationID     string                     `json:"reservationID"`
	ResourceLimits    JobTemplate_ResourceLimits `json:"resourceLimits"`
	StageInFiles      JobTemplate_StageInFiles   `json:"stageInFiles"`
	StageOutFiles     JobTemplate_StageOutFiles  `json:"stageOutFiles"`
	StartTime         time.Time                  `json:"startTime"`
	SubmitAsHold      bool                       `json:"submitAsHold"`
	WorkingDirectory  string                     `json:"workingDirectory"`
}

DRMAA2 job template definition

type JobTemplate_Extension added in v0.3.13 

type JobTemplate_Extension struct {
	AdditionalProperties map[string]string `json:"-"`
}

JobTemplate_Extension defines model for JobTemplate.Extension.

func (JobTemplate_Extension) Get added in v0.3.13 

func (a JobTemplate_Extension) Get(fieldName string) (value string, found bool)

Getter for additional properties for JobTemplate_Extension. Returns the specified element and whether it was found

func (JobTemplate_Extension) MarshalJSON added in v0.3.13 

func (a JobTemplate_Extension) MarshalJSON() ([]byte, error)

Override default JSON handling for JobTemplate_Extension to handle AdditionalProperties

func (*JobTemplate_Extension) Set added in v0.3.13 

func (a *JobTemplate_Extension) Set(fieldName string, value string)

Setter for additional properties for JobTemplate_Extension

func (*JobTemplate_Extension) UnmarshalJSON added in v0.3.13 

func (a *JobTemplate_Extension) UnmarshalJSON(b []byte) error

Override default JSON handling for JobTemplate_Extension to handle AdditionalProperties

type JobTemplate_JobEnvironment 

type JobTemplate_JobEnvironment struct {
	AdditionalProperties map[string]string `json:"-"`
}

JobTemplate_JobEnvironment defines model for JobTemplate.JobEnvironment.

func (JobTemplate_JobEnvironment) Get 

func (a JobTemplate_JobEnvironment) Get(fieldName string) (value string, found bool)

Getter for additional properties for JobTemplate_JobEnvironment. Returns the specified element and whether it was found

func (JobTemplate_JobEnvironment) MarshalJSON 

func (a JobTemplate_JobEnvironment) MarshalJSON() ([]byte, error)

Override default JSON handling for JobTemplate_JobEnvironment to handle AdditionalProperties

func (*JobTemplate_JobEnvironment) Set 

func (a *JobTemplate_JobEnvironment) Set(fieldName string, value string)

Setter for additional properties for JobTemplate_JobEnvironment

func (*JobTemplate_JobEnvironment) UnmarshalJSON 

func (a *JobTemplate_JobEnvironment) UnmarshalJSON(b []byte) error

Override default JSON handling for JobTemplate_JobEnvironment to handle AdditionalProperties

type JobTemplate_ResourceLimits 

type JobTemplate_ResourceLimits struct {
	AdditionalProperties map[string]string `json:"-"`
}

JobTemplate_ResourceLimits defines model for JobTemplate.ResourceLimits.

func (JobTemplate_ResourceLimits) Get 

func (a JobTemplate_ResourceLimits) Get(fieldName string) (value string, found bool)

Getter for additional properties for JobTemplate_ResourceLimits. Returns the specified element and whether it was found

func (JobTemplate_ResourceLimits) MarshalJSON 

func (a JobTemplate_ResourceLimits) MarshalJSON() ([]byte, error)

Override default JSON handling for JobTemplate_ResourceLimits to handle AdditionalProperties

func (*JobTemplate_ResourceLimits) Set 

func (a *JobTemplate_ResourceLimits) Set(fieldName string, value string)

Setter for additional properties for JobTemplate_ResourceLimits

func (*JobTemplate_ResourceLimits) UnmarshalJSON 

func (a *JobTemplate_ResourceLimits) UnmarshalJSON(b []byte) error

Override default JSON handling for JobTemplate_ResourceLimits to handle AdditionalProperties

type JobTemplate_StageInFiles 

type JobTemplate_StageInFiles struct {
	AdditionalProperties map[string]string `json:"-"`
}

JobTemplate_StageInFiles defines model for JobTemplate.StageInFiles.

func (JobTemplate_StageInFiles) Get 

func (a JobTemplate_StageInFiles) Get(fieldName string) (value string, found bool)

Getter for additional properties for JobTemplate_StageInFiles. Returns the specified element and whether it was found

func (JobTemplate_StageInFiles) MarshalJSON 

func (a JobTemplate_StageInFiles) MarshalJSON() ([]byte, error)

Override default JSON handling for JobTemplate_StageInFiles to handle AdditionalProperties

func (*JobTemplate_StageInFiles) Set 

func (a *JobTemplate_StageInFiles) Set(fieldName string, value string)

Setter for additional properties for JobTemplate_StageInFiles

func (*JobTemplate_StageInFiles) UnmarshalJSON 

func (a *JobTemplate_StageInFiles) UnmarshalJSON(b []byte) error

Override default JSON handling for JobTemplate_StageInFiles to handle AdditionalProperties

type JobTemplate_StageOutFiles 

type JobTemplate_StageOutFiles struct {
	AdditionalProperties map[string]string `json:"-"`
}

JobTemplate_StageOutFiles defines model for JobTemplate.StageOutFiles.

func (JobTemplate_StageOutFiles) Get 

func (a JobTemplate_StageOutFiles) Get(fieldName string) (value string, found bool)

Getter for additional properties for JobTemplate_StageOutFiles. Returns the specified element and whether it was found

func (JobTemplate_StageOutFiles) MarshalJSON 

func (a JobTemplate_StageOutFiles) MarshalJSON() ([]byte, error)

Override default JSON handling for JobTemplate_StageOutFiles to handle AdditionalProperties

func (*JobTemplate_StageOutFiles) Set 

func (a *JobTemplate_StageOutFiles) Set(fieldName string, value string)

Setter for additional properties for JobTemplate_StageOutFiles

func (*JobTemplate_StageOutFiles) UnmarshalJSON 

func (a *JobTemplate_StageOutFiles) UnmarshalJSON(b []byte) error

Override default JSON handling for JobTemplate_StageOutFiles to handle AdditionalProperties

type ListArrayJobsParams 

type ListArrayJobsParams struct {

	// array job ID
	ArrayJobID string `json:"arrayJobID"`

	// number of records to skip for pagination
	Skip *int32 `json:"skip,omitempty"`

	// Maximum number of records to return. If not given the number of records are not limited.
	Limit *int32 `json:"limit,omitempty"`
}

ListArrayJobsParams defines parameters for ListArrayJobs.

type ListArrayJobsResponse 

type ListArrayJobsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]JobID
}

func ParseListArrayJobsResponse 

func ParseListArrayJobsResponse(rsp *http.Response) (*ListArrayJobsResponse, error)

ParseListArrayJobsResponse parses an HTTP response from a ListArrayJobsWithResponse call

func (ListArrayJobsResponse) Status 

func (r ListArrayJobsResponse) Status() string

Status returns HTTPResponse.Status

func (ListArrayJobsResponse) StatusCode 

func (r ListArrayJobsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListJobCategoriesResponse 

type ListJobCategoriesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]string
}

func ParseListJobCategoriesResponse 

func ParseListJobCategoriesResponse(rsp *http.Response) (*ListJobCategoriesResponse, error)

ParseListJobCategoriesResponse parses an HTTP response from a ListJobCategoriesWithResponse call

func (ListJobCategoriesResponse) Status 

func (r ListJobCategoriesResponse) Status() string

Status returns HTTPResponse.Status

func (ListJobCategoriesResponse) StatusCode 

func (r ListJobCategoriesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListJobsParams 

type ListJobsParams struct {

	// number of records to skip for pagination
	Skip *int32 `json:"skip,omitempty"`

	// maximum number of records to return
	Limit *int32 `json:"limit,omitempty"`
}

ListJobsParams defines parameters for ListJobs.

type ListJobsResponse 

type ListJobsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]JobID
}

func ParseListJobsResponse 

func ParseListJobsResponse(rsp *http.Response) (*ListJobsResponse, error)

ParseListJobsResponse parses an HTTP response from a ListJobsWithResponse call

func (ListJobsResponse) Status 

func (r ListJobsResponse) Status() string

Status returns HTTPResponse.Status

func (ListJobsResponse) StatusCode 

func (r ListJobsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn 

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

RequestEditorFn is the function signature for the RequestEditor callback function

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.