api_session

package
v0.25.7 Latest Latest
Warning

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

Go to latest
Published: Mar 8, 2023 License: Apache-2.0 Imports: 11 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 api session API

func (*Client) DeleteAPISessions

func (a *Client) DeleteAPISessions(params *DeleteAPISessionsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteAPISessionsOK, error)

DeleteAPISessions deletes an API sessions

Deletes and API sesion by id. Requires admin access.

func (*Client) DetailAPISessions

func (a *Client) DetailAPISessions(params *DetailAPISessionsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DetailAPISessionsOK, error)

DetailAPISessions retrieves a single API session

Retrieves a single API Session by id. Requires admin access.

func (*Client) ListAPISessions

func (a *Client) ListAPISessions(params *ListAPISessionsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListAPISessionsOK, error)
ListAPISessions lists active API sessions

Returns a list of active API sessions. The resources can be sorted, filtered, and paginated. This endpoint

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 {
	DeleteAPISessions(params *DeleteAPISessionsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteAPISessionsOK, error)

	DetailAPISessions(params *DetailAPISessionsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DetailAPISessionsOK, error)

	ListAPISessions(params *ListAPISessionsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListAPISessionsOK, 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 api session API client.

type DeleteAPISessionsForbidden

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

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

func NewDeleteAPISessionsForbidden

func NewDeleteAPISessionsForbidden() *DeleteAPISessionsForbidden

NewDeleteAPISessionsForbidden creates a DeleteAPISessionsForbidden with default headers values

func (*DeleteAPISessionsForbidden) Error

func (*DeleteAPISessionsForbidden) GetPayload

type DeleteAPISessionsNotFound

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

The requested resource does not exist

func NewDeleteAPISessionsNotFound

func NewDeleteAPISessionsNotFound() *DeleteAPISessionsNotFound

NewDeleteAPISessionsNotFound creates a DeleteAPISessionsNotFound with default headers values

func (*DeleteAPISessionsNotFound) Error

func (o *DeleteAPISessionsNotFound) Error() string

func (*DeleteAPISessionsNotFound) GetPayload

type DeleteAPISessionsOK

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

The delete request was successful and the resource has been removed

func NewDeleteAPISessionsOK

func NewDeleteAPISessionsOK() *DeleteAPISessionsOK

NewDeleteAPISessionsOK creates a DeleteAPISessionsOK with default headers values

func (*DeleteAPISessionsOK) Error

func (o *DeleteAPISessionsOK) Error() string

func (*DeleteAPISessionsOK) GetPayload

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

type DeleteAPISessionsParams

type DeleteAPISessionsParams struct {

	/* ID.

	   The id of the requested resource
	*/
	ID string

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

DeleteAPISessionsParams contains all the parameters to send to the API endpoint

for the delete API sessions operation.

Typically these are written to a http.Request.

func NewDeleteAPISessionsParams

func NewDeleteAPISessionsParams() *DeleteAPISessionsParams

NewDeleteAPISessionsParams creates a new DeleteAPISessionsParams 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 NewDeleteAPISessionsParamsWithContext

func NewDeleteAPISessionsParamsWithContext(ctx context.Context) *DeleteAPISessionsParams

NewDeleteAPISessionsParamsWithContext creates a new DeleteAPISessionsParams object with the ability to set a context for a request.

func NewDeleteAPISessionsParamsWithHTTPClient

func NewDeleteAPISessionsParamsWithHTTPClient(client *http.Client) *DeleteAPISessionsParams

NewDeleteAPISessionsParamsWithHTTPClient creates a new DeleteAPISessionsParams object with the ability to set a custom HTTPClient for a request.

func NewDeleteAPISessionsParamsWithTimeout

func NewDeleteAPISessionsParamsWithTimeout(timeout time.Duration) *DeleteAPISessionsParams

NewDeleteAPISessionsParamsWithTimeout creates a new DeleteAPISessionsParams object with the ability to set a timeout on a request.

func (*DeleteAPISessionsParams) SetContext

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

SetContext adds the context to the delete API sessions params

func (*DeleteAPISessionsParams) SetDefaults

func (o *DeleteAPISessionsParams) SetDefaults()

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

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

func (*DeleteAPISessionsParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the delete API sessions params

func (*DeleteAPISessionsParams) SetID

func (o *DeleteAPISessionsParams) SetID(id string)

SetID adds the id to the delete API sessions params

func (*DeleteAPISessionsParams) SetTimeout

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

SetTimeout adds the timeout to the delete API sessions params

func (*DeleteAPISessionsParams) WithContext

WithContext adds the context to the delete API sessions params

func (*DeleteAPISessionsParams) WithDefaults

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

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

func (*DeleteAPISessionsParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the delete API sessions params

func (*DeleteAPISessionsParams) WithID

WithID adds the id to the delete API sessions params

func (*DeleteAPISessionsParams) WithTimeout

WithTimeout adds the timeout to the delete API sessions params

func (*DeleteAPISessionsParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type DeleteAPISessionsReader

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

DeleteAPISessionsReader is a Reader for the DeleteAPISessions structure.

func (*DeleteAPISessionsReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type DetailAPISessionsNotFound

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

The requested resource does not exist

func NewDetailAPISessionsNotFound

func NewDetailAPISessionsNotFound() *DetailAPISessionsNotFound

NewDetailAPISessionsNotFound creates a DetailAPISessionsNotFound with default headers values

func (*DetailAPISessionsNotFound) Error

func (o *DetailAPISessionsNotFound) Error() string

func (*DetailAPISessionsNotFound) GetPayload

type DetailAPISessionsOK

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

Retrieves a singular API Session by id

func NewDetailAPISessionsOK

func NewDetailAPISessionsOK() *DetailAPISessionsOK

NewDetailAPISessionsOK creates a DetailAPISessionsOK with default headers values

func (*DetailAPISessionsOK) Error

func (o *DetailAPISessionsOK) Error() string

func (*DetailAPISessionsOK) GetPayload

type DetailAPISessionsParams

type DetailAPISessionsParams struct {

	/* ID.

	   The id of the requested resource
	*/
	ID string

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

DetailAPISessionsParams contains all the parameters to send to the API endpoint

for the detail API sessions operation.

Typically these are written to a http.Request.

func NewDetailAPISessionsParams

func NewDetailAPISessionsParams() *DetailAPISessionsParams

NewDetailAPISessionsParams creates a new DetailAPISessionsParams 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 NewDetailAPISessionsParamsWithContext

func NewDetailAPISessionsParamsWithContext(ctx context.Context) *DetailAPISessionsParams

NewDetailAPISessionsParamsWithContext creates a new DetailAPISessionsParams object with the ability to set a context for a request.

func NewDetailAPISessionsParamsWithHTTPClient

func NewDetailAPISessionsParamsWithHTTPClient(client *http.Client) *DetailAPISessionsParams

NewDetailAPISessionsParamsWithHTTPClient creates a new DetailAPISessionsParams object with the ability to set a custom HTTPClient for a request.

func NewDetailAPISessionsParamsWithTimeout

func NewDetailAPISessionsParamsWithTimeout(timeout time.Duration) *DetailAPISessionsParams

NewDetailAPISessionsParamsWithTimeout creates a new DetailAPISessionsParams object with the ability to set a timeout on a request.

func (*DetailAPISessionsParams) SetContext

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

SetContext adds the context to the detail API sessions params

func (*DetailAPISessionsParams) SetDefaults

func (o *DetailAPISessionsParams) SetDefaults()

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

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

func (*DetailAPISessionsParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the detail API sessions params

func (*DetailAPISessionsParams) SetID

func (o *DetailAPISessionsParams) SetID(id string)

SetID adds the id to the detail API sessions params

func (*DetailAPISessionsParams) SetTimeout

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

SetTimeout adds the timeout to the detail API sessions params

func (*DetailAPISessionsParams) WithContext

WithContext adds the context to the detail API sessions params

func (*DetailAPISessionsParams) WithDefaults

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

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

func (*DetailAPISessionsParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the detail API sessions params

func (*DetailAPISessionsParams) WithID

WithID adds the id to the detail API sessions params

func (*DetailAPISessionsParams) WithTimeout

WithTimeout adds the timeout to the detail API sessions params

func (*DetailAPISessionsParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type DetailAPISessionsReader

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

DetailAPISessionsReader is a Reader for the DetailAPISessions structure.

func (*DetailAPISessionsReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type DetailAPISessionsUnauthorized

type DetailAPISessionsUnauthorized struct {
	Payload *rest_model.APIErrorEnvelope
}
DetailAPISessionsUnauthorized 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 NewDetailAPISessionsUnauthorized

func NewDetailAPISessionsUnauthorized() *DetailAPISessionsUnauthorized

NewDetailAPISessionsUnauthorized creates a DetailAPISessionsUnauthorized with default headers values

func (*DetailAPISessionsUnauthorized) Error

func (*DetailAPISessionsUnauthorized) GetPayload

type ListAPISessionsBadRequest

type ListAPISessionsBadRequest struct {
	Payload *rest_model.APIErrorEnvelope
}
ListAPISessionsBadRequest 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 NewListAPISessionsBadRequest

func NewListAPISessionsBadRequest() *ListAPISessionsBadRequest

NewListAPISessionsBadRequest creates a ListAPISessionsBadRequest with default headers values

func (*ListAPISessionsBadRequest) Error

func (o *ListAPISessionsBadRequest) Error() string

func (*ListAPISessionsBadRequest) GetPayload

type ListAPISessionsOK

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

A list of active API Sessions

func NewListAPISessionsOK

func NewListAPISessionsOK() *ListAPISessionsOK

NewListAPISessionsOK creates a ListAPISessionsOK with default headers values

func (*ListAPISessionsOK) Error

func (o *ListAPISessionsOK) Error() string

func (*ListAPISessionsOK) GetPayload

type ListAPISessionsParams

type ListAPISessionsParams struct {

	// Filter.
	Filter *string

	// Limit.
	Limit *int64

	// Offset.
	Offset *int64

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

ListAPISessionsParams contains all the parameters to send to the API endpoint

for the list API sessions operation.

Typically these are written to a http.Request.

func NewListAPISessionsParams

func NewListAPISessionsParams() *ListAPISessionsParams

NewListAPISessionsParams creates a new ListAPISessionsParams 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 NewListAPISessionsParamsWithContext

func NewListAPISessionsParamsWithContext(ctx context.Context) *ListAPISessionsParams

NewListAPISessionsParamsWithContext creates a new ListAPISessionsParams object with the ability to set a context for a request.

func NewListAPISessionsParamsWithHTTPClient

func NewListAPISessionsParamsWithHTTPClient(client *http.Client) *ListAPISessionsParams

NewListAPISessionsParamsWithHTTPClient creates a new ListAPISessionsParams object with the ability to set a custom HTTPClient for a request.

func NewListAPISessionsParamsWithTimeout

func NewListAPISessionsParamsWithTimeout(timeout time.Duration) *ListAPISessionsParams

NewListAPISessionsParamsWithTimeout creates a new ListAPISessionsParams object with the ability to set a timeout on a request.

func (*ListAPISessionsParams) SetContext

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

SetContext adds the context to the list API sessions params

func (*ListAPISessionsParams) SetDefaults

func (o *ListAPISessionsParams) SetDefaults()

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

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

func (*ListAPISessionsParams) SetFilter

func (o *ListAPISessionsParams) SetFilter(filter *string)

SetFilter adds the filter to the list API sessions params

func (*ListAPISessionsParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the list API sessions params

func (*ListAPISessionsParams) SetLimit

func (o *ListAPISessionsParams) SetLimit(limit *int64)

SetLimit adds the limit to the list API sessions params

func (*ListAPISessionsParams) SetOffset

func (o *ListAPISessionsParams) SetOffset(offset *int64)

SetOffset adds the offset to the list API sessions params

func (*ListAPISessionsParams) SetTimeout

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

SetTimeout adds the timeout to the list API sessions params

func (*ListAPISessionsParams) WithContext

WithContext adds the context to the list API sessions params

func (*ListAPISessionsParams) WithDefaults

func (o *ListAPISessionsParams) WithDefaults() *ListAPISessionsParams

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

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

func (*ListAPISessionsParams) WithFilter

func (o *ListAPISessionsParams) WithFilter(filter *string) *ListAPISessionsParams

WithFilter adds the filter to the list API sessions params

func (*ListAPISessionsParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the list API sessions params

func (*ListAPISessionsParams) WithLimit

func (o *ListAPISessionsParams) WithLimit(limit *int64) *ListAPISessionsParams

WithLimit adds the limit to the list API sessions params

func (*ListAPISessionsParams) WithOffset

func (o *ListAPISessionsParams) WithOffset(offset *int64) *ListAPISessionsParams

WithOffset adds the offset to the list API sessions params

func (*ListAPISessionsParams) WithTimeout

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

WithTimeout adds the timeout to the list API sessions params

func (*ListAPISessionsParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type ListAPISessionsReader

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

ListAPISessionsReader is a Reader for the ListAPISessions structure.

func (*ListAPISessionsReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type ListAPISessionsUnauthorized

type ListAPISessionsUnauthorized struct {
	Payload *rest_model.APIErrorEnvelope
}
ListAPISessionsUnauthorized 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 NewListAPISessionsUnauthorized

func NewListAPISessionsUnauthorized() *ListAPISessionsUnauthorized

NewListAPISessionsUnauthorized creates a ListAPISessionsUnauthorized with default headers values

func (*ListAPISessionsUnauthorized) Error

func (*ListAPISessionsUnauthorized) GetPayload

Jump to

Keyboard shortcuts

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