results

package
v1.0.12 Latest Latest
Warning

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

 Go to latest Published: Feb 18, 2025 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

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

Client for results API

func (*Client) GetResult 

func (a *Client) GetResult(params *GetResultParams, opts ...ClientOption) (*GetResultOK, error)

GetResult gets a repository s scorecard result

func (*Client) PostResult 

func (a *Client) PostResult(params *PostResultParams, opts ...ClientOption) (*PostResultCreated, error)

PostResult publishes a repository s o ID c verified scorecard result

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService 

type ClientService interface {
	GetResult(params *GetResultParams, opts ...ClientOption) (*GetResultOK, error)

	PostResult(params *PostResultParams, opts ...ClientOption) (*PostResultCreated, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New 

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new results API client.

type GetResultBadRequest 

type GetResultBadRequest struct {
	Payload *models.Error
}

GetResultBadRequest describes a response with status code 400, with default header values.

The request provided to the server was invalid

func NewGetResultBadRequest 

func NewGetResultBadRequest() *GetResultBadRequest

NewGetResultBadRequest creates a GetResultBadRequest with default headers values

func (*GetResultBadRequest) Error 

func (o *GetResultBadRequest) Error() string

func (*GetResultBadRequest) GetPayload 

func (o *GetResultBadRequest) GetPayload() *models.Error

func (*GetResultBadRequest) IsClientError added in v1.0.1 

func (o *GetResultBadRequest) IsClientError() bool

IsClientError returns true when this get result bad request response has a 4xx status code

func (*GetResultBadRequest) IsCode added in v1.0.1 

func (o *GetResultBadRequest) IsCode(code int) bool

IsCode returns true when this get result bad request response a status code equal to that given

func (*GetResultBadRequest) IsRedirect added in v1.0.1 

func (o *GetResultBadRequest) IsRedirect() bool

IsRedirect returns true when this get result bad request response has a 3xx status code

func (*GetResultBadRequest) IsServerError added in v1.0.1 

func (o *GetResultBadRequest) IsServerError() bool

IsServerError returns true when this get result bad request response has a 5xx status code

func (*GetResultBadRequest) IsSuccess added in v1.0.1 

func (o *GetResultBadRequest) IsSuccess() bool

IsSuccess returns true when this get result bad request response has a 2xx status code

func (*GetResultBadRequest) String added in v1.0.1 

func (o *GetResultBadRequest) String() string

type GetResultDefault 

type GetResultDefault struct {
	Payload *models.Error
	// contains filtered or unexported fields
}

GetResultDefault describes a response with status code -1, with default header values.

There was an internal error in the server while processing the request

func NewGetResultDefault 

func NewGetResultDefault(code int) *GetResultDefault

NewGetResultDefault creates a GetResultDefault with default headers values

func (*GetResultDefault) Code 

func (o *GetResultDefault) Code() int

Code gets the status code for the get result default response

func (*GetResultDefault) Error 

func (o *GetResultDefault) Error() string

func (*GetResultDefault) GetPayload 

func (o *GetResultDefault) GetPayload() *models.Error

func (*GetResultDefault) IsClientError added in v1.0.1 

func (o *GetResultDefault) IsClientError() bool

IsClientError returns true when this get result default response has a 4xx status code

func (*GetResultDefault) IsCode added in v1.0.1 

func (o *GetResultDefault) IsCode(code int) bool

IsCode returns true when this get result default response a status code equal to that given

func (*GetResultDefault) IsRedirect added in v1.0.1 

func (o *GetResultDefault) IsRedirect() bool

IsRedirect returns true when this get result default response has a 3xx status code

func (*GetResultDefault) IsServerError added in v1.0.1 

func (o *GetResultDefault) IsServerError() bool

IsServerError returns true when this get result default response has a 5xx status code

func (*GetResultDefault) IsSuccess added in v1.0.1 

func (o *GetResultDefault) IsSuccess() bool

IsSuccess returns true when this get result default response has a 2xx status code

func (*GetResultDefault) String added in v1.0.1 

func (o *GetResultDefault) String() string

type GetResultNotFound 

type GetResultNotFound struct {
}

GetResultNotFound describes a response with status code 404, with default header values.

The content requested could not be found

func NewGetResultNotFound 

func NewGetResultNotFound() *GetResultNotFound

NewGetResultNotFound creates a GetResultNotFound with default headers values

func (*GetResultNotFound) Error 

func (o *GetResultNotFound) Error() string

func (*GetResultNotFound) IsClientError added in v1.0.1 

func (o *GetResultNotFound) IsClientError() bool

IsClientError returns true when this get result not found response has a 4xx status code

func (*GetResultNotFound) IsCode added in v1.0.1 

func (o *GetResultNotFound) IsCode(code int) bool

IsCode returns true when this get result not found response a status code equal to that given

func (*GetResultNotFound) IsRedirect added in v1.0.1 

func (o *GetResultNotFound) IsRedirect() bool

IsRedirect returns true when this get result not found response has a 3xx status code

func (*GetResultNotFound) IsServerError added in v1.0.1 

func (o *GetResultNotFound) IsServerError() bool

IsServerError returns true when this get result not found response has a 5xx status code

func (*GetResultNotFound) IsSuccess added in v1.0.1 

func (o *GetResultNotFound) IsSuccess() bool

IsSuccess returns true when this get result not found response has a 2xx status code

func (*GetResultNotFound) String added in v1.0.1 

func (o *GetResultNotFound) String() string

type GetResultOK 

type GetResultOK struct {
	Payload *models.ScorecardResult
}

GetResultOK describes a response with status code 200, with default header values.

A JSON object of the repository's ScorecardResult

func NewGetResultOK 

func NewGetResultOK() *GetResultOK

NewGetResultOK creates a GetResultOK with default headers values

func (*GetResultOK) Error 

func (o *GetResultOK) Error() string

func (*GetResultOK) GetPayload 

func (o *GetResultOK) GetPayload() *models.ScorecardResult

func (*GetResultOK) IsClientError added in v1.0.1 

func (o *GetResultOK) IsClientError() bool

IsClientError returns true when this get result o k response has a 4xx status code

func (*GetResultOK) IsCode added in v1.0.1 

func (o *GetResultOK) IsCode(code int) bool

IsCode returns true when this get result o k response a status code equal to that given

func (*GetResultOK) IsRedirect added in v1.0.1 

func (o *GetResultOK) IsRedirect() bool

IsRedirect returns true when this get result o k response has a 3xx status code

func (*GetResultOK) IsServerError added in v1.0.1 

func (o *GetResultOK) IsServerError() bool

IsServerError returns true when this get result o k response has a 5xx status code

func (*GetResultOK) IsSuccess added in v1.0.1 

func (o *GetResultOK) IsSuccess() bool

IsSuccess returns true when this get result o k response has a 2xx status code

func (*GetResultOK) String added in v1.0.1 

func (o *GetResultOK) String() string

type GetResultParams 

type GetResultParams struct {

	/* Commit.

	   SHA1 commit hash expressed in hexadecimal format
	*/
	Commit *string

	/* Org.

	   Name of the owner/organization of the repository
	*/
	Org string

	/* Platform.

	   VCS platform. eg. github.com
	*/
	Platform string

	/* Repo.

	   Name of the repository
	*/
	Repo string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetResultParams contains all the parameters to send to the API endpoint 

for the get result operation.

Typically these are written to a http.Request.

func NewGetResultParams 

func NewGetResultParams() *GetResultParams

NewGetResultParams creates a new GetResultParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetResultParamsWithContext 

func NewGetResultParamsWithContext(ctx context.Context) *GetResultParams

NewGetResultParamsWithContext creates a new GetResultParams object with the ability to set a context for a request.

func NewGetResultParamsWithHTTPClient 

func NewGetResultParamsWithHTTPClient(client *http.Client) *GetResultParams

NewGetResultParamsWithHTTPClient creates a new GetResultParams object with the ability to set a custom HTTPClient for a request.

func NewGetResultParamsWithTimeout 

func NewGetResultParamsWithTimeout(timeout time.Duration) *GetResultParams

NewGetResultParamsWithTimeout creates a new GetResultParams object with the ability to set a timeout on a request.

func (*GetResultParams) SetCommit 

func (o *GetResultParams) SetCommit(commit *string)

SetCommit adds the commit to the get result params

func (*GetResultParams) SetContext 

func (o *GetResultParams) SetContext(ctx context.Context)

SetContext adds the context to the get result params

func (*GetResultParams) SetDefaults 

func (o *GetResultParams) SetDefaults()

SetDefaults hydrates default values in the get result params (not the query body).

All values with no default are reset to their zero value.

func (*GetResultParams) SetHTTPClient 

func (o *GetResultParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get result params

func (*GetResultParams) SetOrg 

func (o *GetResultParams) SetOrg(org string)

SetOrg adds the org to the get result params

func (*GetResultParams) SetPlatform 

func (o *GetResultParams) SetPlatform(platform string)

SetPlatform adds the platform to the get result params

func (*GetResultParams) SetRepo 

func (o *GetResultParams) SetRepo(repo string)

SetRepo adds the repo to the get result params

func (*GetResultParams) SetTimeout 

func (o *GetResultParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get result params

func (*GetResultParams) WithCommit 

func (o *GetResultParams) WithCommit(commit *string) *GetResultParams

WithCommit adds the commit to the get result params

func (*GetResultParams) WithContext 

func (o *GetResultParams) WithContext(ctx context.Context) *GetResultParams

WithContext adds the context to the get result params

func (*GetResultParams) WithDefaults 

func (o *GetResultParams) WithDefaults() *GetResultParams

WithDefaults hydrates default values in the get result params (not the query body).

All values with no default are reset to their zero value.

func (*GetResultParams) WithHTTPClient 

func (o *GetResultParams) WithHTTPClient(client *http.Client) *GetResultParams

WithHTTPClient adds the HTTPClient to the get result params

func (*GetResultParams) WithOrg 

func (o *GetResultParams) WithOrg(org string) *GetResultParams

WithOrg adds the org to the get result params

func (*GetResultParams) WithPlatform 

func (o *GetResultParams) WithPlatform(platform string) *GetResultParams

WithPlatform adds the platform to the get result params

func (*GetResultParams) WithRepo 

func (o *GetResultParams) WithRepo(repo string) *GetResultParams

WithRepo adds the repo to the get result params

func (*GetResultParams) WithTimeout 

func (o *GetResultParams) WithTimeout(timeout time.Duration) *GetResultParams

WithTimeout adds the timeout to the get result params

func (*GetResultParams) WriteToRequest 

func (o *GetResultParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetResultReader 

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

GetResultReader is a Reader for the GetResult structure.

func (*GetResultReader) ReadResponse 

func (o *GetResultReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type PostResultBadRequest 

type PostResultBadRequest struct {
	Payload *models.Error
}

PostResultBadRequest describes a response with status code 400, with default header values.

The request provided to the server was invalid

func NewPostResultBadRequest 

func NewPostResultBadRequest() *PostResultBadRequest

NewPostResultBadRequest creates a PostResultBadRequest with default headers values

func (*PostResultBadRequest) Error 

func (o *PostResultBadRequest) Error() string

func (*PostResultBadRequest) GetPayload 

func (o *PostResultBadRequest) GetPayload() *models.Error

func (*PostResultBadRequest) IsClientError added in v1.0.1 

func (o *PostResultBadRequest) IsClientError() bool

IsClientError returns true when this post result bad request response has a 4xx status code

func (*PostResultBadRequest) IsCode added in v1.0.1 

func (o *PostResultBadRequest) IsCode(code int) bool

IsCode returns true when this post result bad request response a status code equal to that given

func (*PostResultBadRequest) IsRedirect added in v1.0.1 

func (o *PostResultBadRequest) IsRedirect() bool

IsRedirect returns true when this post result bad request response has a 3xx status code

func (*PostResultBadRequest) IsServerError added in v1.0.1 

func (o *PostResultBadRequest) IsServerError() bool

IsServerError returns true when this post result bad request response has a 5xx status code

func (*PostResultBadRequest) IsSuccess added in v1.0.1 

func (o *PostResultBadRequest) IsSuccess() bool

IsSuccess returns true when this post result bad request response has a 2xx status code

func (*PostResultBadRequest) String added in v1.0.1 

func (o *PostResultBadRequest) String() string

type PostResultCreated 

type PostResultCreated struct {
	Payload string
}

PostResultCreated describes a response with status code 201, with default header values.

Successfully updated ScorecardResult

func NewPostResultCreated 

func NewPostResultCreated() *PostResultCreated

NewPostResultCreated creates a PostResultCreated with default headers values

func (*PostResultCreated) Error 

func (o *PostResultCreated) Error() string

func (*PostResultCreated) GetPayload 

func (o *PostResultCreated) GetPayload() string

func (*PostResultCreated) IsClientError added in v1.0.1 

func (o *PostResultCreated) IsClientError() bool

IsClientError returns true when this post result created response has a 4xx status code

func (*PostResultCreated) IsCode added in v1.0.1 

func (o *PostResultCreated) IsCode(code int) bool

IsCode returns true when this post result created response a status code equal to that given

func (*PostResultCreated) IsRedirect added in v1.0.1 

func (o *PostResultCreated) IsRedirect() bool

IsRedirect returns true when this post result created response has a 3xx status code

func (*PostResultCreated) IsServerError added in v1.0.1 

func (o *PostResultCreated) IsServerError() bool

IsServerError returns true when this post result created response has a 5xx status code

func (*PostResultCreated) IsSuccess added in v1.0.1 

func (o *PostResultCreated) IsSuccess() bool

IsSuccess returns true when this post result created response has a 2xx status code

func (*PostResultCreated) String added in v1.0.1 

func (o *PostResultCreated) String() string

type PostResultDefault 

type PostResultDefault struct {
	Payload *models.Error
	// contains filtered or unexported fields
}

PostResultDefault describes a response with status code -1, with default header values.

There was an internal error in the server while processing the request

func NewPostResultDefault 

func NewPostResultDefault(code int) *PostResultDefault

NewPostResultDefault creates a PostResultDefault with default headers values

func (*PostResultDefault) Code 

func (o *PostResultDefault) Code() int

Code gets the status code for the post result default response

func (*PostResultDefault) Error 

func (o *PostResultDefault) Error() string

func (*PostResultDefault) GetPayload 

func (o *PostResultDefault) GetPayload() *models.Error

func (*PostResultDefault) IsClientError added in v1.0.1 

func (o *PostResultDefault) IsClientError() bool

IsClientError returns true when this post result default response has a 4xx status code

func (*PostResultDefault) IsCode added in v1.0.1 

func (o *PostResultDefault) IsCode(code int) bool

IsCode returns true when this post result default response a status code equal to that given

func (*PostResultDefault) IsRedirect added in v1.0.1 

func (o *PostResultDefault) IsRedirect() bool

IsRedirect returns true when this post result default response has a 3xx status code

func (*PostResultDefault) IsServerError added in v1.0.1 

func (o *PostResultDefault) IsServerError() bool

IsServerError returns true when this post result default response has a 5xx status code

func (*PostResultDefault) IsSuccess added in v1.0.1 

func (o *PostResultDefault) IsSuccess() bool

IsSuccess returns true when this post result default response has a 2xx status code

func (*PostResultDefault) String added in v1.0.1 

func (o *PostResultDefault) String() string

type PostResultParams 

type PostResultParams struct {

	/* Org.

	   Name of the owner/organization of the repository
	*/
	Org string

	/* Platform.

	   VCS platform. eg. github.com
	*/
	Platform string

	// Publish.
	Publish *models.VerifiedScorecardResult

	/* Repo.

	   Name of the repository
	*/
	Repo string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

PostResultParams contains all the parameters to send to the API endpoint 

for the post result operation.

Typically these are written to a http.Request.

func NewPostResultParams 

func NewPostResultParams() *PostResultParams

NewPostResultParams creates a new PostResultParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewPostResultParamsWithContext 

func NewPostResultParamsWithContext(ctx context.Context) *PostResultParams

NewPostResultParamsWithContext creates a new PostResultParams object with the ability to set a context for a request.

func NewPostResultParamsWithHTTPClient 

func NewPostResultParamsWithHTTPClient(client *http.Client) *PostResultParams

NewPostResultParamsWithHTTPClient creates a new PostResultParams object with the ability to set a custom HTTPClient for a request.

func NewPostResultParamsWithTimeout 

func NewPostResultParamsWithTimeout(timeout time.Duration) *PostResultParams

NewPostResultParamsWithTimeout creates a new PostResultParams object with the ability to set a timeout on a request.

func (*PostResultParams) SetContext 

func (o *PostResultParams) SetContext(ctx context.Context)

SetContext adds the context to the post result params

func (*PostResultParams) SetDefaults 

func (o *PostResultParams) SetDefaults()

SetDefaults hydrates default values in the post result params (not the query body).

All values with no default are reset to their zero value.

func (*PostResultParams) SetHTTPClient 

func (o *PostResultParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the post result params

func (*PostResultParams) SetOrg 

func (o *PostResultParams) SetOrg(org string)

SetOrg adds the org to the post result params

func (*PostResultParams) SetPlatform 

func (o *PostResultParams) SetPlatform(platform string)

SetPlatform adds the platform to the post result params

func (*PostResultParams) SetPublish 

func (o *PostResultParams) SetPublish(publish *models.VerifiedScorecardResult)

SetPublish adds the publish to the post result params

func (*PostResultParams) SetRepo 

func (o *PostResultParams) SetRepo(repo string)

SetRepo adds the repo to the post result params

func (*PostResultParams) SetTimeout 

func (o *PostResultParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the post result params

func (*PostResultParams) WithContext 

func (o *PostResultParams) WithContext(ctx context.Context) *PostResultParams

WithContext adds the context to the post result params

func (*PostResultParams) WithDefaults 

func (o *PostResultParams) WithDefaults() *PostResultParams

WithDefaults hydrates default values in the post result params (not the query body).

All values with no default are reset to their zero value.

func (*PostResultParams) WithHTTPClient 

func (o *PostResultParams) WithHTTPClient(client *http.Client) *PostResultParams

WithHTTPClient adds the HTTPClient to the post result params

func (*PostResultParams) WithOrg 

func (o *PostResultParams) WithOrg(org string) *PostResultParams

WithOrg adds the org to the post result params

func (*PostResultParams) WithPlatform 

func (o *PostResultParams) WithPlatform(platform string) *PostResultParams

WithPlatform adds the platform to the post result params

func (*PostResultParams) WithPublish 

func (o *PostResultParams) WithPublish(publish *models.VerifiedScorecardResult) *PostResultParams

WithPublish adds the publish to the post result params

func (*PostResultParams) WithRepo 

func (o *PostResultParams) WithRepo(repo string) *PostResultParams

WithRepo adds the repo to the post result params

func (*PostResultParams) WithTimeout 

func (o *PostResultParams) WithTimeout(timeout time.Duration) *PostResultParams

WithTimeout adds the timeout to the post result params

func (*PostResultParams) WriteToRequest 

func (o *PostResultParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type PostResultReader 

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

PostResultReader is a Reader for the PostResult structure.

func (*PostResultReader) ReadResponse 

func (o *PostResultReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

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.