link

package
v0.24.34 Latest Latest
Warning

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

Go to latest
Published: Sep 26, 2023 License: Apache-2.0 Imports: 10 Imported by: 1

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 link API

func (a *Client) DeleteLink(params *DeleteLinkParams, opts ...ClientOption) (*DeleteLinkOK, error)

DeleteLink deletes a link

Delete a link by id. Requires admin access.

func (a *Client) DetailLink(params *DetailLinkParams, opts ...ClientOption) (*DetailLinkOK, error)

DetailLink retrieves a single link

Retrieves a single link by id. Requires admin access.

func (a *Client) ListLinks(params *ListLinksParams, opts ...ClientOption) (*ListLinksOK, error)

ListLinks lists links

Retrieves a list of link resources; does not supports filtering, sorting, or pagination. Requires admin access.

func (a *Client) PatchLink(params *PatchLinkParams, opts ...ClientOption) (*PatchLinkOK, error)

PatchLink updates the supplied fields on a link

Update the supplied fields on a link. Requires admin access.

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 {
	DeleteLink(params *DeleteLinkParams, opts ...ClientOption) (*DeleteLinkOK, error)

	DetailLink(params *DetailLinkParams, opts ...ClientOption) (*DetailLinkOK, error)

	ListLinks(params *ListLinksParams, opts ...ClientOption) (*ListLinksOK, error)

	PatchLink(params *PatchLinkParams, opts ...ClientOption) (*PatchLinkOK, 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 link API client.

type DeleteLinkBadRequest

type DeleteLinkBadRequest struct {
	Payload *rest_model.APIErrorEnvelope
}
DeleteLinkBadRequest describes a response with status code 400, with default header values.

The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information

func NewDeleteLinkBadRequest

func NewDeleteLinkBadRequest() *DeleteLinkBadRequest

NewDeleteLinkBadRequest creates a DeleteLinkBadRequest with default headers values

func (*DeleteLinkBadRequest) Error

func (o *DeleteLinkBadRequest) Error() string

func (*DeleteLinkBadRequest) GetPayload

type DeleteLinkOK

type DeleteLinkOK struct {
	Payload *rest_model.Empty
}
DeleteLinkOK describes a response with status code 200, with default header values.

The delete request was successful and the resource has been removed

func NewDeleteLinkOK

func NewDeleteLinkOK() *DeleteLinkOK

NewDeleteLinkOK creates a DeleteLinkOK with default headers values

func (*DeleteLinkOK) Error

func (o *DeleteLinkOK) Error() string

func (*DeleteLinkOK) GetPayload

func (o *DeleteLinkOK) GetPayload() *rest_model.Empty

type DeleteLinkParams

type DeleteLinkParams struct {

	/* ID.

	   The id of the requested resource
	*/
	ID string

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

DeleteLinkParams contains all the parameters to send to the API endpoint

for the delete link operation.

Typically these are written to a http.Request.

func NewDeleteLinkParams

func NewDeleteLinkParams() *DeleteLinkParams

NewDeleteLinkParams creates a new DeleteLinkParams 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 NewDeleteLinkParamsWithContext

func NewDeleteLinkParamsWithContext(ctx context.Context) *DeleteLinkParams

NewDeleteLinkParamsWithContext creates a new DeleteLinkParams object with the ability to set a context for a request.

func NewDeleteLinkParamsWithHTTPClient

func NewDeleteLinkParamsWithHTTPClient(client *http.Client) *DeleteLinkParams

NewDeleteLinkParamsWithHTTPClient creates a new DeleteLinkParams object with the ability to set a custom HTTPClient for a request.

func NewDeleteLinkParamsWithTimeout

func NewDeleteLinkParamsWithTimeout(timeout time.Duration) *DeleteLinkParams

NewDeleteLinkParamsWithTimeout creates a new DeleteLinkParams object with the ability to set a timeout on a request.

func (*DeleteLinkParams) SetContext

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

SetContext adds the context to the delete link params

func (*DeleteLinkParams) SetDefaults

func (o *DeleteLinkParams) SetDefaults()

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

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

func (*DeleteLinkParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the delete link params

func (*DeleteLinkParams) SetID

func (o *DeleteLinkParams) SetID(id string)

SetID adds the id to the delete link params

func (*DeleteLinkParams) SetTimeout

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

SetTimeout adds the timeout to the delete link params

func (*DeleteLinkParams) WithContext

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

WithContext adds the context to the delete link params

func (*DeleteLinkParams) WithDefaults

func (o *DeleteLinkParams) WithDefaults() *DeleteLinkParams

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

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

func (*DeleteLinkParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the delete link params

func (*DeleteLinkParams) WithID

func (o *DeleteLinkParams) WithID(id string) *DeleteLinkParams

WithID adds the id to the delete link params

func (*DeleteLinkParams) WithTimeout

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

WithTimeout adds the timeout to the delete link params

func (*DeleteLinkParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type DeleteLinkReader

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

DeleteLinkReader is a Reader for the DeleteLink structure.

func (*DeleteLinkReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type DeleteLinkUnauthorized

type DeleteLinkUnauthorized struct {
	Payload *rest_model.APIErrorEnvelope
}
DeleteLinkUnauthorized describes a response with status code 401, with default header values.

The currently supplied session does not have the correct access rights to request this resource

func NewDeleteLinkUnauthorized

func NewDeleteLinkUnauthorized() *DeleteLinkUnauthorized

NewDeleteLinkUnauthorized creates a DeleteLinkUnauthorized with default headers values

func (*DeleteLinkUnauthorized) Error

func (o *DeleteLinkUnauthorized) Error() string

func (*DeleteLinkUnauthorized) GetPayload

type DetailLinkNotFound

type DetailLinkNotFound struct {
	Payload *rest_model.APIErrorEnvelope
}
DetailLinkNotFound describes a response with status code 404, with default header values.

The requested resource does not exist

func NewDetailLinkNotFound

func NewDetailLinkNotFound() *DetailLinkNotFound

NewDetailLinkNotFound creates a DetailLinkNotFound with default headers values

func (*DetailLinkNotFound) Error

func (o *DetailLinkNotFound) Error() string

func (*DetailLinkNotFound) GetPayload

type DetailLinkOK

type DetailLinkOK struct {
	Payload *rest_model.DetailLinkEnvelope
}
DetailLinkOK describes a response with status code 200, with default header values.

A single link

func NewDetailLinkOK

func NewDetailLinkOK() *DetailLinkOK

NewDetailLinkOK creates a DetailLinkOK with default headers values

func (*DetailLinkOK) Error

func (o *DetailLinkOK) Error() string

func (*DetailLinkOK) GetPayload

func (o *DetailLinkOK) GetPayload() *rest_model.DetailLinkEnvelope

type DetailLinkParams

type DetailLinkParams struct {

	/* ID.

	   The id of the requested resource
	*/
	ID string

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

DetailLinkParams contains all the parameters to send to the API endpoint

for the detail link operation.

Typically these are written to a http.Request.

func NewDetailLinkParams

func NewDetailLinkParams() *DetailLinkParams

NewDetailLinkParams creates a new DetailLinkParams 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 NewDetailLinkParamsWithContext

func NewDetailLinkParamsWithContext(ctx context.Context) *DetailLinkParams

NewDetailLinkParamsWithContext creates a new DetailLinkParams object with the ability to set a context for a request.

func NewDetailLinkParamsWithHTTPClient

func NewDetailLinkParamsWithHTTPClient(client *http.Client) *DetailLinkParams

NewDetailLinkParamsWithHTTPClient creates a new DetailLinkParams object with the ability to set a custom HTTPClient for a request.

func NewDetailLinkParamsWithTimeout

func NewDetailLinkParamsWithTimeout(timeout time.Duration) *DetailLinkParams

NewDetailLinkParamsWithTimeout creates a new DetailLinkParams object with the ability to set a timeout on a request.

func (*DetailLinkParams) SetContext

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

SetContext adds the context to the detail link params

func (*DetailLinkParams) SetDefaults

func (o *DetailLinkParams) SetDefaults()

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

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

func (*DetailLinkParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the detail link params

func (*DetailLinkParams) SetID

func (o *DetailLinkParams) SetID(id string)

SetID adds the id to the detail link params

func (*DetailLinkParams) SetTimeout

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

SetTimeout adds the timeout to the detail link params

func (*DetailLinkParams) WithContext

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

WithContext adds the context to the detail link params

func (*DetailLinkParams) WithDefaults

func (o *DetailLinkParams) WithDefaults() *DetailLinkParams

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

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

func (*DetailLinkParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the detail link params

func (*DetailLinkParams) WithID

func (o *DetailLinkParams) WithID(id string) *DetailLinkParams

WithID adds the id to the detail link params

func (*DetailLinkParams) WithTimeout

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

WithTimeout adds the timeout to the detail link params

func (*DetailLinkParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type DetailLinkReader

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

DetailLinkReader is a Reader for the DetailLink structure.

func (*DetailLinkReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type DetailLinkUnauthorized

type DetailLinkUnauthorized struct {
	Payload *rest_model.APIErrorEnvelope
}
DetailLinkUnauthorized describes a response with status code 401, with default header values.

The currently supplied session does not have the correct access rights to request this resource

func NewDetailLinkUnauthorized

func NewDetailLinkUnauthorized() *DetailLinkUnauthorized

NewDetailLinkUnauthorized creates a DetailLinkUnauthorized with default headers values

func (*DetailLinkUnauthorized) Error

func (o *DetailLinkUnauthorized) Error() string

func (*DetailLinkUnauthorized) GetPayload

type ListLinksOK

type ListLinksOK struct {
	Payload *rest_model.ListLinksEnvelope
}
ListLinksOK describes a response with status code 200, with default header values.

A list of links

func NewListLinksOK

func NewListLinksOK() *ListLinksOK

NewListLinksOK creates a ListLinksOK with default headers values

func (*ListLinksOK) Error

func (o *ListLinksOK) Error() string

func (*ListLinksOK) GetPayload

func (o *ListLinksOK) GetPayload() *rest_model.ListLinksEnvelope

type ListLinksParams

type ListLinksParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

ListLinksParams contains all the parameters to send to the API endpoint

for the list links operation.

Typically these are written to a http.Request.

func NewListLinksParams

func NewListLinksParams() *ListLinksParams

NewListLinksParams creates a new ListLinksParams 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 NewListLinksParamsWithContext

func NewListLinksParamsWithContext(ctx context.Context) *ListLinksParams

NewListLinksParamsWithContext creates a new ListLinksParams object with the ability to set a context for a request.

func NewListLinksParamsWithHTTPClient

func NewListLinksParamsWithHTTPClient(client *http.Client) *ListLinksParams

NewListLinksParamsWithHTTPClient creates a new ListLinksParams object with the ability to set a custom HTTPClient for a request.

func NewListLinksParamsWithTimeout

func NewListLinksParamsWithTimeout(timeout time.Duration) *ListLinksParams

NewListLinksParamsWithTimeout creates a new ListLinksParams object with the ability to set a timeout on a request.

func (*ListLinksParams) SetContext

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

SetContext adds the context to the list links params

func (*ListLinksParams) SetDefaults

func (o *ListLinksParams) SetDefaults()

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

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

func (*ListLinksParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the list links params

func (*ListLinksParams) SetTimeout

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

SetTimeout adds the timeout to the list links params

func (*ListLinksParams) WithContext

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

WithContext adds the context to the list links params

func (*ListLinksParams) WithDefaults

func (o *ListLinksParams) WithDefaults() *ListLinksParams

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

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

func (*ListLinksParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the list links params

func (*ListLinksParams) WithTimeout

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

WithTimeout adds the timeout to the list links params

func (*ListLinksParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type ListLinksReader

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

ListLinksReader is a Reader for the ListLinks structure.

func (*ListLinksReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type ListLinksUnauthorized

type ListLinksUnauthorized struct {
	Payload *rest_model.APIErrorEnvelope
}
ListLinksUnauthorized describes a response with status code 401, with default header values.

The currently supplied session does not have the correct access rights to request this resource

func NewListLinksUnauthorized

func NewListLinksUnauthorized() *ListLinksUnauthorized

NewListLinksUnauthorized creates a ListLinksUnauthorized with default headers values

func (*ListLinksUnauthorized) Error

func (o *ListLinksUnauthorized) Error() string

func (*ListLinksUnauthorized) GetPayload

type PatchLinkBadRequest

type PatchLinkBadRequest struct {
	Payload *rest_model.APIErrorEnvelope
}
PatchLinkBadRequest describes a response with status code 400, with default header values.

The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information

func NewPatchLinkBadRequest

func NewPatchLinkBadRequest() *PatchLinkBadRequest

NewPatchLinkBadRequest creates a PatchLinkBadRequest with default headers values

func (*PatchLinkBadRequest) Error

func (o *PatchLinkBadRequest) Error() string

func (*PatchLinkBadRequest) GetPayload

type PatchLinkNotFound

type PatchLinkNotFound struct {
	Payload *rest_model.APIErrorEnvelope
}
PatchLinkNotFound describes a response with status code 404, with default header values.

The requested resource does not exist

func NewPatchLinkNotFound

func NewPatchLinkNotFound() *PatchLinkNotFound

NewPatchLinkNotFound creates a PatchLinkNotFound with default headers values

func (*PatchLinkNotFound) Error

func (o *PatchLinkNotFound) Error() string

func (*PatchLinkNotFound) GetPayload

type PatchLinkOK

type PatchLinkOK struct {
	Payload *rest_model.Empty
}
PatchLinkOK describes a response with status code 200, with default header values.

The patch request was successful and the resource has been altered

func NewPatchLinkOK

func NewPatchLinkOK() *PatchLinkOK

NewPatchLinkOK creates a PatchLinkOK with default headers values

func (*PatchLinkOK) Error

func (o *PatchLinkOK) Error() string

func (*PatchLinkOK) GetPayload

func (o *PatchLinkOK) GetPayload() *rest_model.Empty

type PatchLinkParams

type PatchLinkParams struct {

	/* ID.

	   The id of the requested resource
	*/
	ID string

	/* Link.

	   A link patch object
	*/
	Link *rest_model.LinkPatch

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

PatchLinkParams contains all the parameters to send to the API endpoint

for the patch link operation.

Typically these are written to a http.Request.

func NewPatchLinkParams

func NewPatchLinkParams() *PatchLinkParams

NewPatchLinkParams creates a new PatchLinkParams 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 NewPatchLinkParamsWithContext

func NewPatchLinkParamsWithContext(ctx context.Context) *PatchLinkParams

NewPatchLinkParamsWithContext creates a new PatchLinkParams object with the ability to set a context for a request.

func NewPatchLinkParamsWithHTTPClient

func NewPatchLinkParamsWithHTTPClient(client *http.Client) *PatchLinkParams

NewPatchLinkParamsWithHTTPClient creates a new PatchLinkParams object with the ability to set a custom HTTPClient for a request.

func NewPatchLinkParamsWithTimeout

func NewPatchLinkParamsWithTimeout(timeout time.Duration) *PatchLinkParams

NewPatchLinkParamsWithTimeout creates a new PatchLinkParams object with the ability to set a timeout on a request.

func (*PatchLinkParams) SetContext

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

SetContext adds the context to the patch link params

func (*PatchLinkParams) SetDefaults

func (o *PatchLinkParams) SetDefaults()

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

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

func (*PatchLinkParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the patch link params

func (*PatchLinkParams) SetID

func (o *PatchLinkParams) SetID(id string)

SetID adds the id to the patch link params

func (o *PatchLinkParams) SetLink(link *rest_model.LinkPatch)

SetLink adds the link to the patch link params

func (*PatchLinkParams) SetTimeout

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

SetTimeout adds the timeout to the patch link params

func (*PatchLinkParams) WithContext

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

WithContext adds the context to the patch link params

func (*PatchLinkParams) WithDefaults

func (o *PatchLinkParams) WithDefaults() *PatchLinkParams

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

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

func (*PatchLinkParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the patch link params

func (*PatchLinkParams) WithID

func (o *PatchLinkParams) WithID(id string) *PatchLinkParams

WithID adds the id to the patch link params

WithLink adds the link to the patch link params

func (*PatchLinkParams) WithTimeout

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

WithTimeout adds the timeout to the patch link params

func (*PatchLinkParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type PatchLinkReader

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

PatchLinkReader is a Reader for the PatchLink structure.

func (*PatchLinkReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type PatchLinkUnauthorized

type PatchLinkUnauthorized struct {
	Payload *rest_model.APIErrorEnvelope
}
PatchLinkUnauthorized describes a response with status code 401, with default header values.

The currently supplied session does not have the correct access rights to request this resource

func NewPatchLinkUnauthorized

func NewPatchLinkUnauthorized() *PatchLinkUnauthorized

NewPatchLinkUnauthorized creates a PatchLinkUnauthorized with default headers values

func (*PatchLinkUnauthorized) Error

func (o *PatchLinkUnauthorized) Error() string

func (*PatchLinkUnauthorized) GetPayload

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL