Documentation
¶
Index ¶
- type Client
- type ClientOption
- type ClientService
- type UploadBomForbidden
- type UploadBomNotFound
- type UploadBomOK
- type UploadBomParams
- func (o *UploadBomParams) SetAutoCreate(autoCreate *bool)
- func (o *UploadBomParams) SetBom(bom *string)
- func (o *UploadBomParams) SetContext(ctx context.Context)
- func (o *UploadBomParams) SetDefaults()
- func (o *UploadBomParams) SetHTTPClient(client *http.Client)
- func (o *UploadBomParams) SetProject(project *string)
- func (o *UploadBomParams) SetProjectName(projectName *string)
- func (o *UploadBomParams) SetProjectVersion(projectVersion *string)
- func (o *UploadBomParams) SetTimeout(timeout time.Duration)
- func (o *UploadBomParams) WithAutoCreate(autoCreate *bool) *UploadBomParams
- func (o *UploadBomParams) WithBom(bom *string) *UploadBomParams
- func (o *UploadBomParams) WithContext(ctx context.Context) *UploadBomParams
- func (o *UploadBomParams) WithDefaults() *UploadBomParams
- func (o *UploadBomParams) WithHTTPClient(client *http.Client) *UploadBomParams
- func (o *UploadBomParams) WithProject(project *string) *UploadBomParams
- func (o *UploadBomParams) WithProjectName(projectName *string) *UploadBomParams
- func (o *UploadBomParams) WithProjectVersion(projectVersion *string) *UploadBomParams
- func (o *UploadBomParams) WithTimeout(timeout time.Duration) *UploadBomParams
- func (o *UploadBomParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type UploadBomReader
- type UploadBomUnauthorized
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 bom API
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
func (*Client) UploadBom ¶
func (a *Client) UploadBom(params *UploadBomParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UploadBomOK, error)
UploadBom uploads a supported bill of material format document
Expects CycloneDX along and a valid project UUID. If a UUID is not specified, than the projectName and projectVersion must be specified. Optionally, if autoCreate is specified and 'true' and the project does not exist, the project will be created. In this scenario, the principal making the request will additionally need the PORTFOLIO_MANAGEMENT or PROJECT_CREATION_UPLOAD permission.
type ClientOption ¶
type ClientOption func(*runtime.ClientOperation)
ClientOption is the option for Client methods
type ClientService ¶
type ClientService interface {
UploadBom(params *UploadBomParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*UploadBomOK, 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 bom API client.
type UploadBomForbidden ¶
type UploadBomForbidden struct {
}
UploadBomForbidden describes a response with status code 403, with default header values.
Access to the specified project is forbidden
func NewUploadBomForbidden ¶
func NewUploadBomForbidden() *UploadBomForbidden
NewUploadBomForbidden creates a UploadBomForbidden with default headers values
func (*UploadBomForbidden) Error ¶
func (o *UploadBomForbidden) Error() string
type UploadBomNotFound ¶
type UploadBomNotFound struct {
}
UploadBomNotFound describes a response with status code 404, with default header values.
The project could not be found
func NewUploadBomNotFound ¶
func NewUploadBomNotFound() *UploadBomNotFound
NewUploadBomNotFound creates a UploadBomNotFound with default headers values
func (*UploadBomNotFound) Error ¶
func (o *UploadBomNotFound) Error() string
type UploadBomOK ¶
type UploadBomOK struct {
}
UploadBomOK describes a response with status code 200, with default header values.
Successful
func NewUploadBomOK ¶
func NewUploadBomOK() *UploadBomOK
NewUploadBomOK creates a UploadBomOK with default headers values
func (*UploadBomOK) Error ¶
func (o *UploadBomOK) Error() string
type UploadBomParams ¶
type UploadBomParams struct {
// AutoCreate.
AutoCreate *bool
// Bom.
Bom *string
// Project.
Project *string
// ProjectName.
ProjectName *string
// ProjectVersion.
ProjectVersion *string
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
UploadBomParams contains all the parameters to send to the API endpoint
for the upload bom operation. Typically these are written to a http.Request.
func NewUploadBomParams ¶
func NewUploadBomParams() *UploadBomParams
NewUploadBomParams creates a new UploadBomParams 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 NewUploadBomParamsWithContext ¶
func NewUploadBomParamsWithContext(ctx context.Context) *UploadBomParams
NewUploadBomParamsWithContext creates a new UploadBomParams object with the ability to set a context for a request.
func NewUploadBomParamsWithHTTPClient ¶
func NewUploadBomParamsWithHTTPClient(client *http.Client) *UploadBomParams
NewUploadBomParamsWithHTTPClient creates a new UploadBomParams object with the ability to set a custom HTTPClient for a request.
func NewUploadBomParamsWithTimeout ¶
func NewUploadBomParamsWithTimeout(timeout time.Duration) *UploadBomParams
NewUploadBomParamsWithTimeout creates a new UploadBomParams object with the ability to set a timeout on a request.
func (*UploadBomParams) SetAutoCreate ¶
func (o *UploadBomParams) SetAutoCreate(autoCreate *bool)
SetAutoCreate adds the autoCreate to the upload bom params
func (*UploadBomParams) SetBom ¶
func (o *UploadBomParams) SetBom(bom *string)
SetBom adds the bom to the upload bom params
func (*UploadBomParams) SetContext ¶
func (o *UploadBomParams) SetContext(ctx context.Context)
SetContext adds the context to the upload bom params
func (*UploadBomParams) SetDefaults ¶
func (o *UploadBomParams) SetDefaults()
SetDefaults hydrates default values in the upload bom params (not the query body).
All values with no default are reset to their zero value.
func (*UploadBomParams) SetHTTPClient ¶
func (o *UploadBomParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the upload bom params
func (*UploadBomParams) SetProject ¶
func (o *UploadBomParams) SetProject(project *string)
SetProject adds the project to the upload bom params
func (*UploadBomParams) SetProjectName ¶
func (o *UploadBomParams) SetProjectName(projectName *string)
SetProjectName adds the projectName to the upload bom params
func (*UploadBomParams) SetProjectVersion ¶
func (o *UploadBomParams) SetProjectVersion(projectVersion *string)
SetProjectVersion adds the projectVersion to the upload bom params
func (*UploadBomParams) SetTimeout ¶
func (o *UploadBomParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the upload bom params
func (*UploadBomParams) WithAutoCreate ¶
func (o *UploadBomParams) WithAutoCreate(autoCreate *bool) *UploadBomParams
WithAutoCreate adds the autoCreate to the upload bom params
func (*UploadBomParams) WithBom ¶
func (o *UploadBomParams) WithBom(bom *string) *UploadBomParams
WithBom adds the bom to the upload bom params
func (*UploadBomParams) WithContext ¶
func (o *UploadBomParams) WithContext(ctx context.Context) *UploadBomParams
WithContext adds the context to the upload bom params
func (*UploadBomParams) WithDefaults ¶
func (o *UploadBomParams) WithDefaults() *UploadBomParams
WithDefaults hydrates default values in the upload bom params (not the query body).
All values with no default are reset to their zero value.
func (*UploadBomParams) WithHTTPClient ¶
func (o *UploadBomParams) WithHTTPClient(client *http.Client) *UploadBomParams
WithHTTPClient adds the HTTPClient to the upload bom params
func (*UploadBomParams) WithProject ¶
func (o *UploadBomParams) WithProject(project *string) *UploadBomParams
WithProject adds the project to the upload bom params
func (*UploadBomParams) WithProjectName ¶
func (o *UploadBomParams) WithProjectName(projectName *string) *UploadBomParams
WithProjectName adds the projectName to the upload bom params
func (*UploadBomParams) WithProjectVersion ¶
func (o *UploadBomParams) WithProjectVersion(projectVersion *string) *UploadBomParams
WithProjectVersion adds the projectVersion to the upload bom params
func (*UploadBomParams) WithTimeout ¶
func (o *UploadBomParams) WithTimeout(timeout time.Duration) *UploadBomParams
WithTimeout adds the timeout to the upload bom params
func (*UploadBomParams) WriteToRequest ¶
func (o *UploadBomParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type UploadBomReader ¶
type UploadBomReader struct {
// contains filtered or unexported fields
}
UploadBomReader is a Reader for the UploadBom structure.
func (*UploadBomReader) ReadResponse ¶
func (o *UploadBomReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type UploadBomUnauthorized ¶
type UploadBomUnauthorized struct {
}
UploadBomUnauthorized describes a response with status code 401, with default header values.
Unauthorized
func NewUploadBomUnauthorized ¶
func NewUploadBomUnauthorized() *UploadBomUnauthorized
NewUploadBomUnauthorized creates a UploadBomUnauthorized with default headers values
func (*UploadBomUnauthorized) Error ¶
func (o *UploadBomUnauthorized) Error() string
Source Files