icons

package
v0.3.0 Latest Latest
Warning

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

 Go to latest Published: Aug 27, 2021 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 icons API

func (*Client) Delete 

func (a *Client) Delete(params *DeleteParams, opts ...ClientOption) (*DeleteNoContent, error)

Delete deletes an icon

Delete an existing icon by its unique id.

func (*Client) Download 

func (a *Client) Download(params *DownloadParams, opts ...ClientOption) (*DownloadOK, error)

Download downloads an icon

Download an existing icon by its unique id.

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

func (*Client) Upload 

func (a *Client) Upload(params *UploadParams, opts ...ClientOption) (*UploadCreated, error)

Upload uploads an icon

Create an icon.

type ClientOption added in v0.2.20 

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService added in v0.2.18 

type ClientService interface {
	Delete(params *DeleteParams, opts ...ClientOption) (*DeleteNoContent, error)

	Download(params *DownloadParams, opts ...ClientOption) (*DownloadOK, error)

	Upload(params *UploadParams, opts ...ClientOption) (*UploadCreated, 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 icons API client.

type DeleteForbidden 

type DeleteForbidden struct {
}
DeleteForbidden describes a response with status code 403, with default header values.

Forbidden.

func NewDeleteForbidden 

func NewDeleteForbidden() *DeleteForbidden

NewDeleteForbidden creates a DeleteForbidden with default headers values

func (*DeleteForbidden) Error 

func (o *DeleteForbidden) Error() string

type DeleteNoContent 

type DeleteNoContent struct {
}
DeleteNoContent describes a response with status code 204, with default header values.

Success - delete the icon

func NewDeleteNoContent 

func NewDeleteNoContent() *DeleteNoContent

NewDeleteNoContent creates a DeleteNoContent with default headers values

func (*DeleteNoContent) Error 

func (o *DeleteNoContent) Error() string

type DeleteParams 

type DeleteParams struct {

	/* APIVersion.

	   The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.
	*/
	APIVersion *string

	/* ID.

	   Icon id

	   Format: uuid
	*/
	ID strfmt.UUID

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

DeleteParams contains all the parameters to send to the API endpoint 

for the delete operation.

Typically these are written to a http.Request.

func NewDeleteParams 

func NewDeleteParams() *DeleteParams

NewDeleteParams creates a new DeleteParams 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 NewDeleteParamsWithContext 

func NewDeleteParamsWithContext(ctx context.Context) *DeleteParams

NewDeleteParamsWithContext creates a new DeleteParams object with the ability to set a context for a request.

func NewDeleteParamsWithHTTPClient 

func NewDeleteParamsWithHTTPClient(client *http.Client) *DeleteParams

NewDeleteParamsWithHTTPClient creates a new DeleteParams object with the ability to set a custom HTTPClient for a request.

func NewDeleteParamsWithTimeout 

func NewDeleteParamsWithTimeout(timeout time.Duration) *DeleteParams

NewDeleteParamsWithTimeout creates a new DeleteParams object with the ability to set a timeout on a request.

func (*DeleteParams) SetAPIVersion added in v0.2.9 

func (o *DeleteParams) SetAPIVersion(aPIVersion *string)

SetAPIVersion adds the apiVersion to the delete params

func (*DeleteParams) SetContext 

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

SetContext adds the context to the delete params

func (*DeleteParams) SetDefaults added in v0.2.20 

func (o *DeleteParams) SetDefaults()

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

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

func (*DeleteParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the delete params

func (*DeleteParams) SetID 

func (o *DeleteParams) SetID(id strfmt.UUID)

SetID adds the id to the delete params

func (*DeleteParams) SetTimeout 

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

SetTimeout adds the timeout to the delete params

func (*DeleteParams) WithAPIVersion added in v0.2.9 

func (o *DeleteParams) WithAPIVersion(aPIVersion *string) *DeleteParams

WithAPIVersion adds the aPIVersion to the delete params

func (*DeleteParams) WithContext 

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

WithContext adds the context to the delete params

func (*DeleteParams) WithDefaults added in v0.2.20 

func (o *DeleteParams) WithDefaults() *DeleteParams

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

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

func (*DeleteParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the delete params

func (*DeleteParams) WithID 

func (o *DeleteParams) WithID(id strfmt.UUID) *DeleteParams

WithID adds the id to the delete params

func (*DeleteParams) WithTimeout 

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

WithTimeout adds the timeout to the delete params

func (*DeleteParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type DeleteReader 

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

DeleteReader is a Reader for the Delete structure.

func (*DeleteReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type DownloadBadRequest 

type DownloadBadRequest struct {
	Payload *models.Error
}
DownloadBadRequest describes a response with status code 400, with default header values.

Invalid request - bad data.

func NewDownloadBadRequest 

func NewDownloadBadRequest() *DownloadBadRequest

NewDownloadBadRequest creates a DownloadBadRequest with default headers values

func (*DownloadBadRequest) Error 

func (o *DownloadBadRequest) Error() string

func (*DownloadBadRequest) GetPayload added in v0.2.9 

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

type DownloadNotFound 

type DownloadNotFound struct {
	Payload *models.Error
}
DownloadNotFound describes a response with status code 404, with default header values.

Icon not found.

func NewDownloadNotFound 

func NewDownloadNotFound() *DownloadNotFound

NewDownloadNotFound creates a DownloadNotFound with default headers values

func (*DownloadNotFound) Error 

func (o *DownloadNotFound) Error() string

func (*DownloadNotFound) GetPayload added in v0.2.9 

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

type DownloadOK 

type DownloadOK struct {
	Payload strfmt.Base64
}
DownloadOK describes a response with status code 200, with default header values.

Success - return the catalog icon.

func NewDownloadOK 

func NewDownloadOK() *DownloadOK

NewDownloadOK creates a DownloadOK with default headers values

func (*DownloadOK) Error 

func (o *DownloadOK) Error() string

func (*DownloadOK) GetPayload 

func (o *DownloadOK) GetPayload() strfmt.Base64

type DownloadParams 

type DownloadParams struct {

	/* APIVersion.

	   The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.
	*/
	APIVersion *string

	/* ID.

	   Icon id

	   Format: uuid
	*/
	ID strfmt.UUID

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

DownloadParams contains all the parameters to send to the API endpoint 

for the download operation.

Typically these are written to a http.Request.

func NewDownloadParams 

func NewDownloadParams() *DownloadParams

NewDownloadParams creates a new DownloadParams 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 NewDownloadParamsWithContext 

func NewDownloadParamsWithContext(ctx context.Context) *DownloadParams

NewDownloadParamsWithContext creates a new DownloadParams object with the ability to set a context for a request.

func NewDownloadParamsWithHTTPClient 

func NewDownloadParamsWithHTTPClient(client *http.Client) *DownloadParams

NewDownloadParamsWithHTTPClient creates a new DownloadParams object with the ability to set a custom HTTPClient for a request.

func NewDownloadParamsWithTimeout 

func NewDownloadParamsWithTimeout(timeout time.Duration) *DownloadParams

NewDownloadParamsWithTimeout creates a new DownloadParams object with the ability to set a timeout on a request.

func (*DownloadParams) SetAPIVersion added in v0.2.9 

func (o *DownloadParams) SetAPIVersion(aPIVersion *string)

SetAPIVersion adds the apiVersion to the download params

func (*DownloadParams) SetContext 

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

SetContext adds the context to the download params

func (*DownloadParams) SetDefaults added in v0.2.20 

func (o *DownloadParams) SetDefaults()

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

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

func (*DownloadParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the download params

func (*DownloadParams) SetID 

func (o *DownloadParams) SetID(id strfmt.UUID)

SetID adds the id to the download params

func (*DownloadParams) SetTimeout 

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

SetTimeout adds the timeout to the download params

func (*DownloadParams) WithAPIVersion added in v0.2.9 

func (o *DownloadParams) WithAPIVersion(aPIVersion *string) *DownloadParams

WithAPIVersion adds the aPIVersion to the download params

func (*DownloadParams) WithContext 

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

WithContext adds the context to the download params

func (*DownloadParams) WithDefaults added in v0.2.20 

func (o *DownloadParams) WithDefaults() *DownloadParams

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

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

func (*DownloadParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the download params

func (*DownloadParams) WithID 

func (o *DownloadParams) WithID(id strfmt.UUID) *DownloadParams

WithID adds the id to the download params

func (*DownloadParams) WithTimeout 

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

WithTimeout adds the timeout to the download params

func (*DownloadParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type DownloadReader 

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

DownloadReader is a Reader for the Download structure.

func (*DownloadReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type UploadBadRequest 

type UploadBadRequest struct {
	Payload *models.Error
}
UploadBadRequest describes a response with status code 400, with default header values.

Invalid request - bad data.

func NewUploadBadRequest 

func NewUploadBadRequest() *UploadBadRequest

NewUploadBadRequest creates a UploadBadRequest with default headers values

func (*UploadBadRequest) Error 

func (o *UploadBadRequest) Error() string

func (*UploadBadRequest) GetPayload added in v0.2.9 

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

type UploadCreated 

type UploadCreated struct {
}
UploadCreated describes a response with status code 201, with default header values.

Success - create an icon.

func NewUploadCreated 

func NewUploadCreated() *UploadCreated

NewUploadCreated creates a UploadCreated with default headers values

func (*UploadCreated) Error 

func (o *UploadCreated) Error() string

type UploadForbidden 

type UploadForbidden struct {
}
UploadForbidden describes a response with status code 403, with default header values.

Forbidden.

func NewUploadForbidden 

func NewUploadForbidden() *UploadForbidden

NewUploadForbidden creates a UploadForbidden with default headers values

func (*UploadForbidden) Error 

func (o *UploadForbidden) Error() string

type UploadParams 

type UploadParams struct {

	/* APIVersion.

	   The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.
	*/
	APIVersion *string

	/* File.

	   Icon file
	*/
	File runtime.NamedReadCloser

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

UploadParams contains all the parameters to send to the API endpoint 

for the upload operation.

Typically these are written to a http.Request.

func NewUploadParams 

func NewUploadParams() *UploadParams

NewUploadParams creates a new UploadParams 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 NewUploadParamsWithContext 

func NewUploadParamsWithContext(ctx context.Context) *UploadParams

NewUploadParamsWithContext creates a new UploadParams object with the ability to set a context for a request.

func NewUploadParamsWithHTTPClient 

func NewUploadParamsWithHTTPClient(client *http.Client) *UploadParams

NewUploadParamsWithHTTPClient creates a new UploadParams object with the ability to set a custom HTTPClient for a request.

func NewUploadParamsWithTimeout 

func NewUploadParamsWithTimeout(timeout time.Duration) *UploadParams

NewUploadParamsWithTimeout creates a new UploadParams object with the ability to set a timeout on a request.

func (*UploadParams) SetAPIVersion added in v0.2.9 

func (o *UploadParams) SetAPIVersion(aPIVersion *string)

SetAPIVersion adds the apiVersion to the upload params

func (*UploadParams) SetContext 

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

SetContext adds the context to the upload params

func (*UploadParams) SetDefaults added in v0.2.20 

func (o *UploadParams) SetDefaults()

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

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

func (*UploadParams) SetFile 

func (o *UploadParams) SetFile(file runtime.NamedReadCloser)

SetFile adds the file to the upload params

func (*UploadParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the upload params

func (*UploadParams) SetTimeout 

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

SetTimeout adds the timeout to the upload params

func (*UploadParams) WithAPIVersion added in v0.2.9 

func (o *UploadParams) WithAPIVersion(aPIVersion *string) *UploadParams

WithAPIVersion adds the aPIVersion to the upload params

func (*UploadParams) WithContext 

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

WithContext adds the context to the upload params

func (*UploadParams) WithDefaults added in v0.2.20 

func (o *UploadParams) WithDefaults() *UploadParams

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

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

func (*UploadParams) WithFile 

func (o *UploadParams) WithFile(file runtime.NamedReadCloser) *UploadParams

WithFile adds the file to the upload params

func (*UploadParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the upload params

func (*UploadParams) WithTimeout 

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

WithTimeout adds the timeout to the upload params

func (*UploadParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type UploadReader 

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

UploadReader is a Reader for the Upload structure.

func (*UploadReader) ReadResponse 

func (o *UploadReader) 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.