# README
Distributed scheduler client
Welcome 👋
This repository contains client library/SDK for the distributed scheduler.
Every version has OpenAPI specification that is used to generate the client using oapi-codegen generator.
Installation
go get github.com/GLCharge/distributed-scheduler-client@latest"
Usage
import client "https://github.com/GLCharge/distributed-scheduler-client
Generation
This code base, was generated using oapi-codegen.
You can generate the SDK manually by running the Makefile script:
make gen-client
# Functions
Creates a new Client, with reasonable defaults.
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.
NewDeleteJobsIdRequest generates requests for DeleteJobsId.
NewGetJobsIdExecutionsRequest generates requests for GetJobsIdExecutions.
NewGetJobsIdRequest generates requests for GetJobsId.
NewGetJobsRequest generates requests for GetJobs.
NewPostJobsRequest calls the generic PostJobs builder with application/json body.
NewPostJobsRequestWithBody generates requests for PostJobs with any type of body.
NewPutJobsIdRequest calls the generic PutJobsId builder with application/json body.
NewPutJobsIdRequestWithBody generates requests for PutJobsId with any type of body.
ParseDeleteJobsIdResponse parses an HTTP response from a DeleteJobsIdWithResponse call.
ParseGetJobsIdExecutionsResponse parses an HTTP response from a GetJobsIdExecutionsWithResponse call.
ParseGetJobsIdResponse parses an HTTP response from a GetJobsIdWithResponse call.
ParseGetJobsResponse parses an HTTP response from a GetJobsWithResponse call.
ParsePostJobsResponse parses an HTTP response from a PostJobsWithResponse call.
ParsePutJobsIdResponse parses an HTTP response from a PutJobsIdWithResponse call.
WithBaseURL overrides the baseURL.
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client.
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request.
# Constants
Defines values for ModelAuthType.
Defines values for ModelAuthType.
Defines values for ModelAuthType.
Defines values for ModelBodyEncoding.
Defines values for ModelJobStatus.
Defines values for ModelJobStatus.
Defines values for ModelJobType.
Defines values for ModelJobType.
# Structs
Client which conforms to the OpenAPI3 specification for this service.
ClientWithResponses builds on ClientInterface to offer response payloads.
No description provided by the author
GetJobsIdExecutionsParams defines parameters for GetJobsIdExecutions.
No description provided by the author
No description provided by the author
GetJobsParams defines parameters for GetJobs.
No description provided by the author
HandlersErrorResponse defines model for handlers.ErrorResponse.
ModelAMQPJob defines model for model.AMQPJob.
ModelAuth defines model for model.Auth.
ModelHTTPJob defines model for model.HTTPJob.
ModelJob defines model for model.Job.
ModelJobCreate defines model for model.JobCreate.
ModelJobExecution defines model for model.JobExecution.
ModelJobUpdate defines model for model.JobUpdate.
No description provided by the author
No description provided by the author
# Interfaces
The interface specification for the client above.
ClientWithResponsesInterface is the interface specification for the client with responses above.
Doer performs HTTP requests.
# Type aliases
ClientOption allows setting custom parameters during construction.
ModelAuthType defines model for model.AuthType.
ModelBodyEncoding defines model for model.BodyEncoding.
ModelJobStatus defines model for model.JobStatus.
ModelJobType defines model for model.JobType.
PostJobsJSONRequestBody defines body for PostJobs for application/json ContentType.
PutJobsIdJSONRequestBody defines body for PutJobsId for application/json ContentType.
RequestEditorFn is the function signature for the RequestEditor callback function.