package
0.0.0-20240620101759-427d89f7620c
Repository: https://github.com/openshift/backplane-api.git
Documentation: pkg.go.dev

# Functions

GetSwagger returns the Swagger specification corresponding to the generated code in this file.
Creates a new Client, with reasonable defaults.
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.
NewCreateJobRequest calls the generic CreateJob builder with application/json body.
NewCreateJobRequestWithBody generates requests for CreateJob with any type of body.
NewCreateTestScriptRunRequest calls the generic CreateTestScriptRun builder with application/json body.
NewCreateTestScriptRunRequestWithBody generates requests for CreateTestScriptRun with any type of body.
NewDeleteBackplaneClusterClusterIdRequest generates requests for DeleteBackplaneClusterClusterId.
NewDeleteJobRequest generates requests for DeleteJob.
NewGetAllJobsRequest generates requests for GetAllJobs.
NewGetAssumeRoleSequenceRequest generates requests for GetAssumeRoleSequence.
NewGetBackplaneClusterClusterIdRequest generates requests for GetBackplaneClusterClusterId.
NewGetCloudConsoleRequest generates requests for GetCloudConsole.
NewGetCloudCredentialsRequest generates requests for GetCloudCredentials.
NewGetJobLogsRequest generates requests for GetJobLogs.
NewGetRunRequest generates requests for GetRun.
NewGetScriptsByClusterRequest generates requests for GetScriptsByCluster.
NewGetTestScriptRunLogsRequest generates requests for GetTestScriptRunLogs.
NewGetTestScriptRunRequest generates requests for GetTestScriptRun.
NewHeadBackplaneClusterClusterIdRequest generates requests for HeadBackplaneClusterClusterId.
NewLoginClusterRequest generates requests for LoginCluster.
NewOptionsBackplaneClusterClusterIdRequest generates requests for OptionsBackplaneClusterClusterId.
NewPatchBackplaneClusterClusterIdRequest generates requests for PatchBackplaneClusterClusterId.
NewPostBackplaneClusterClusterIdRequest generates requests for PostBackplaneClusterClusterId.
NewPutBackplaneClusterClusterIdRequest generates requests for PutBackplaneClusterClusterId.
NewTraceBackplaneClusterClusterIdRequest generates requests for TraceBackplaneClusterClusterId.
ParseCreateJobResponse parses an HTTP response from a CreateJobWithResponse call.
ParseCreateTestScriptRunResponse parses an HTTP response from a CreateTestScriptRunWithResponse call.
ParseDeleteBackplaneClusterClusterIdResponse parses an HTTP response from a DeleteBackplaneClusterClusterIdWithResponse call.
ParseDeleteJobResponse parses an HTTP response from a DeleteJobWithResponse call.
ParseGetAllJobsResponse parses an HTTP response from a GetAllJobsWithResponse call.
ParseGetAssumeRoleSequenceResponse parses an HTTP response from a GetAssumeRoleSequenceWithResponse call.
ParseGetBackplaneClusterClusterIdResponse parses an HTTP response from a GetBackplaneClusterClusterIdWithResponse call.
ParseGetCloudConsoleResponse parses an HTTP response from a GetCloudConsoleWithResponse call.
ParseGetCloudCredentialsResponse parses an HTTP response from a GetCloudCredentialsWithResponse call.
ParseGetJobLogsResponse parses an HTTP response from a GetJobLogsWithResponse call.
ParseGetRunResponse parses an HTTP response from a GetRunWithResponse call.
ParseGetScriptsByClusterResponse parses an HTTP response from a GetScriptsByClusterWithResponse call.
ParseGetTestScriptRunLogsResponse parses an HTTP response from a GetTestScriptRunLogsWithResponse call.
ParseGetTestScriptRunResponse parses an HTTP response from a GetTestScriptRunWithResponse call.
ParseHeadBackplaneClusterClusterIdResponse parses an HTTP response from a HeadBackplaneClusterClusterIdWithResponse call.
ParseLoginClusterResponse parses an HTTP response from a LoginClusterWithResponse call.
ParseOptionsBackplaneClusterClusterIdResponse parses an HTTP response from a OptionsBackplaneClusterClusterIdWithResponse call.
ParsePatchBackplaneClusterClusterIdResponse parses an HTTP response from a PatchBackplaneClusterClusterIdWithResponse call.
ParsePostBackplaneClusterClusterIdResponse parses an HTTP response from a PostBackplaneClusterClusterIdWithResponse call.
ParsePutBackplaneClusterClusterIdResponse parses an HTTP response from a PutBackplaneClusterClusterIdWithResponse call.
ParseTraceBackplaneClusterClusterIdResponse parses an HTTP response from a TraceBackplaneClusterClusterIdWithResponse call.
Constructs a synthetic filesystem for resolving external references when loading openapi specifications.
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

No description provided by the author
Defines values for JobStatusStatus.
Defines values for JobStatusStatus.
Defines values for JobStatusStatus.
Defines values for JobStatusStatus.
Defines values for JobStatusStatus.
Defines values for JobStatusStatus.
Defines values for ScriptLanguage.
Defines values for ScriptLanguage.
Defines values for ScriptMetadataLanguage.
Defines values for ScriptMetadataLanguage.
Defines values for TestJobResultStatus.
Defines values for TestJobResultStatus.
Defines values for TestJobResultStatus.
Defines values for TestJobResultStatus.

# Structs

AssumableRole Roles and there corresponding ARN.
AssumeRoleSequenceResponse Response for assume role handler.
Client which conforms to the OpenAPI3 specification for this service.
ClientWithResponses builds on ClientInterface to offer response payloads.
CloudCredentialsResponse Response for cloud handler.
CreateJob defines model for CreateJob.
No description provided by the author
CreateTestJob Body for creating a test job.
No description provided by the author
No description provided by the author
No description provided by the author
EnvDecl defines model for EnvDecl.
EnvRealised defines model for EnvRealised.
Error defines model for Error.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetJobLogsParams defines parameters for GetJobLogs.
No description provided by the author
No description provided by the author
GetScriptsByClusterParams defines parameters for GetScriptsByCluster.
No description provided by the author
GetTestScriptRunLogsParams defines parameters for GetTestScriptRunLogs.
No description provided by the author
No description provided by the author
No description provided by the author
Job defines model for Job.
JobStatus defines model for JobStatus.
LabelDecl defines model for LabelDecl.
No description provided by the author
LoginResponse Login status response.
Logs defines model for Logs.
No description provided by the author
No description provided by the author
PolicyRule defines model for PolicyRule.
No description provided by the author
No description provided by the author
RBAC RBAC declaration.
RoleRbacDecl defines model for RoleRbacDecl.
Script defines model for Script.
ScriptMetadata Script metadata.
TestJobResult Body of response for a test job run.
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.
CreateJobJSONRequestBody defines body for CreateJob for application/json ContentType.
CreateTestScriptRunJSONRequestBody defines body for CreateTestScriptRun for application/json ContentType.
JobStatusStatus status of the script.
RequestEditorFn is the function signature for the RequestEditor callback function.
ScriptLanguage The script language.
ScriptMetadataLanguage defines model for ScriptMetadata.Language.
Scripts defines model for Scripts.
TestJobResultStatus Test run status.