enrollment

package
v0.20.80 Latest Latest
Warning

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

 Go to latest Published: Oct 10, 2021 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 enrollment API

func (*Client) DeleteEnrollment 

func (a *Client) DeleteEnrollment(params *DeleteEnrollmentParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteEnrollmentOK, error)

DeleteEnrollment deletes an outstanding enrollment

Delete an outstanding enrollment by id. Requires admin access.

func (*Client) DetailEnrollment 

func (a *Client) DetailEnrollment(params *DetailEnrollmentParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DetailEnrollmentOK, error)

DetailEnrollment retrieves an outstanding enrollment

Retrieves a single outstanding enrollment by id. Requires admin access.

func (*Client) ListEnrollments 

func (a *Client) ListEnrollments(params *ListEnrollmentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListEnrollmentsOK, error)

ListEnrollments lists outstanding enrollments

Retrieves a list of outstanding enrollments; supports filtering, sorting, and pagination. 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 {
	DeleteEnrollment(params *DeleteEnrollmentParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DeleteEnrollmentOK, error)

	DetailEnrollment(params *DetailEnrollmentParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*DetailEnrollmentOK, error)

	ListEnrollments(params *ListEnrollmentsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*ListEnrollmentsOK, 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 enrollment API client.

type DeleteEnrollmentBadRequest 

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

func NewDeleteEnrollmentBadRequest() *DeleteEnrollmentBadRequest

NewDeleteEnrollmentBadRequest creates a DeleteEnrollmentBadRequest with default headers values

func (*DeleteEnrollmentBadRequest) Error 

func (o *DeleteEnrollmentBadRequest) Error() string

func (*DeleteEnrollmentBadRequest) GetPayload 

func (o *DeleteEnrollmentBadRequest) GetPayload() *rest_model.APIErrorEnvelope

type DeleteEnrollmentOK 

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

The delete request was successful and the resource has been removed

func NewDeleteEnrollmentOK 

func NewDeleteEnrollmentOK() *DeleteEnrollmentOK

NewDeleteEnrollmentOK creates a DeleteEnrollmentOK with default headers values

func (*DeleteEnrollmentOK) Error 

func (o *DeleteEnrollmentOK) Error() string

func (*DeleteEnrollmentOK) GetPayload 

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

type DeleteEnrollmentParams 

type DeleteEnrollmentParams struct {

	/* ID.

	   The id of the requested resource
	*/
	ID string

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

DeleteEnrollmentParams contains all the parameters to send to the API endpoint 

for the delete enrollment operation.

Typically these are written to a http.Request.

func NewDeleteEnrollmentParams 

func NewDeleteEnrollmentParams() *DeleteEnrollmentParams

NewDeleteEnrollmentParams creates a new DeleteEnrollmentParams 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 NewDeleteEnrollmentParamsWithContext 

func NewDeleteEnrollmentParamsWithContext(ctx context.Context) *DeleteEnrollmentParams

NewDeleteEnrollmentParamsWithContext creates a new DeleteEnrollmentParams object with the ability to set a context for a request.

func NewDeleteEnrollmentParamsWithHTTPClient 

func NewDeleteEnrollmentParamsWithHTTPClient(client *http.Client) *DeleteEnrollmentParams

NewDeleteEnrollmentParamsWithHTTPClient creates a new DeleteEnrollmentParams object with the ability to set a custom HTTPClient for a request.

func NewDeleteEnrollmentParamsWithTimeout 

func NewDeleteEnrollmentParamsWithTimeout(timeout time.Duration) *DeleteEnrollmentParams

NewDeleteEnrollmentParamsWithTimeout creates a new DeleteEnrollmentParams object with the ability to set a timeout on a request.

func (*DeleteEnrollmentParams) SetContext 

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

SetContext adds the context to the delete enrollment params

func (*DeleteEnrollmentParams) SetDefaults 

func (o *DeleteEnrollmentParams) SetDefaults()

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

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

func (*DeleteEnrollmentParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the delete enrollment params

func (*DeleteEnrollmentParams) SetID 

func (o *DeleteEnrollmentParams) SetID(id string)

SetID adds the id to the delete enrollment params

func (*DeleteEnrollmentParams) SetTimeout 

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

SetTimeout adds the timeout to the delete enrollment params

func (*DeleteEnrollmentParams) WithContext 

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

WithContext adds the context to the delete enrollment params

func (*DeleteEnrollmentParams) WithDefaults 

func (o *DeleteEnrollmentParams) WithDefaults() *DeleteEnrollmentParams

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

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

func (*DeleteEnrollmentParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the delete enrollment params

func (*DeleteEnrollmentParams) WithID 

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

WithID adds the id to the delete enrollment params

func (*DeleteEnrollmentParams) WithTimeout 

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

WithTimeout adds the timeout to the delete enrollment params

func (*DeleteEnrollmentParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type DeleteEnrollmentReader 

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

DeleteEnrollmentReader is a Reader for the DeleteEnrollment structure.

func (*DeleteEnrollmentReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type DeleteEnrollmentUnauthorized 

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

func NewDeleteEnrollmentUnauthorized() *DeleteEnrollmentUnauthorized

NewDeleteEnrollmentUnauthorized creates a DeleteEnrollmentUnauthorized with default headers values

func (*DeleteEnrollmentUnauthorized) Error 

func (o *DeleteEnrollmentUnauthorized) Error() string

func (*DeleteEnrollmentUnauthorized) GetPayload 

func (o *DeleteEnrollmentUnauthorized) GetPayload() *rest_model.APIErrorEnvelope

type DetailEnrollmentNotFound 

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

The requested resource does not exist

func NewDetailEnrollmentNotFound 

func NewDetailEnrollmentNotFound() *DetailEnrollmentNotFound

NewDetailEnrollmentNotFound creates a DetailEnrollmentNotFound with default headers values

func (*DetailEnrollmentNotFound) Error 

func (o *DetailEnrollmentNotFound) Error() string

func (*DetailEnrollmentNotFound) GetPayload 

func (o *DetailEnrollmentNotFound) GetPayload() *rest_model.APIErrorEnvelope

type DetailEnrollmentOK 

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

A singular enrollment resource

func NewDetailEnrollmentOK 

func NewDetailEnrollmentOK() *DetailEnrollmentOK

NewDetailEnrollmentOK creates a DetailEnrollmentOK with default headers values

func (*DetailEnrollmentOK) Error 

func (o *DetailEnrollmentOK) Error() string

func (*DetailEnrollmentOK) GetPayload 

func (o *DetailEnrollmentOK) GetPayload() *rest_model.DetailEnrollmentEnvelope

type DetailEnrollmentParams 

type DetailEnrollmentParams struct {

	/* ID.

	   The id of the requested resource
	*/
	ID string

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

DetailEnrollmentParams contains all the parameters to send to the API endpoint 

for the detail enrollment operation.

Typically these are written to a http.Request.

func NewDetailEnrollmentParams 

func NewDetailEnrollmentParams() *DetailEnrollmentParams

NewDetailEnrollmentParams creates a new DetailEnrollmentParams 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 NewDetailEnrollmentParamsWithContext 

func NewDetailEnrollmentParamsWithContext(ctx context.Context) *DetailEnrollmentParams

NewDetailEnrollmentParamsWithContext creates a new DetailEnrollmentParams object with the ability to set a context for a request.

func NewDetailEnrollmentParamsWithHTTPClient 

func NewDetailEnrollmentParamsWithHTTPClient(client *http.Client) *DetailEnrollmentParams

NewDetailEnrollmentParamsWithHTTPClient creates a new DetailEnrollmentParams object with the ability to set a custom HTTPClient for a request.

func NewDetailEnrollmentParamsWithTimeout 

func NewDetailEnrollmentParamsWithTimeout(timeout time.Duration) *DetailEnrollmentParams

NewDetailEnrollmentParamsWithTimeout creates a new DetailEnrollmentParams object with the ability to set a timeout on a request.

func (*DetailEnrollmentParams) SetContext 

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

SetContext adds the context to the detail enrollment params

func (*DetailEnrollmentParams) SetDefaults 

func (o *DetailEnrollmentParams) SetDefaults()

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

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

func (*DetailEnrollmentParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the detail enrollment params

func (*DetailEnrollmentParams) SetID 

func (o *DetailEnrollmentParams) SetID(id string)

SetID adds the id to the detail enrollment params

func (*DetailEnrollmentParams) SetTimeout 

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

SetTimeout adds the timeout to the detail enrollment params

func (*DetailEnrollmentParams) WithContext 

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

WithContext adds the context to the detail enrollment params

func (*DetailEnrollmentParams) WithDefaults 

func (o *DetailEnrollmentParams) WithDefaults() *DetailEnrollmentParams

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

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

func (*DetailEnrollmentParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the detail enrollment params

func (*DetailEnrollmentParams) WithID 

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

WithID adds the id to the detail enrollment params

func (*DetailEnrollmentParams) WithTimeout 

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

WithTimeout adds the timeout to the detail enrollment params

func (*DetailEnrollmentParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type DetailEnrollmentReader 

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

DetailEnrollmentReader is a Reader for the DetailEnrollment structure.

func (*DetailEnrollmentReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type DetailEnrollmentUnauthorized 

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

func NewDetailEnrollmentUnauthorized() *DetailEnrollmentUnauthorized

NewDetailEnrollmentUnauthorized creates a DetailEnrollmentUnauthorized with default headers values

func (*DetailEnrollmentUnauthorized) Error 

func (o *DetailEnrollmentUnauthorized) Error() string

func (*DetailEnrollmentUnauthorized) GetPayload 

func (o *DetailEnrollmentUnauthorized) GetPayload() *rest_model.APIErrorEnvelope

type ListEnrollmentsBadRequest added in v0.19.176 

type ListEnrollmentsBadRequest struct {
	Payload *rest_model.APIErrorEnvelope
}
ListEnrollmentsBadRequest 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 NewListEnrollmentsBadRequest added in v0.19.176 

func NewListEnrollmentsBadRequest() *ListEnrollmentsBadRequest

NewListEnrollmentsBadRequest creates a ListEnrollmentsBadRequest with default headers values

func (*ListEnrollmentsBadRequest) Error added in v0.19.176 

func (o *ListEnrollmentsBadRequest) Error() string

func (*ListEnrollmentsBadRequest) GetPayload added in v0.19.176 

func (o *ListEnrollmentsBadRequest) GetPayload() *rest_model.APIErrorEnvelope

type ListEnrollmentsOK 

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

A list of enrollments

func NewListEnrollmentsOK 

func NewListEnrollmentsOK() *ListEnrollmentsOK

NewListEnrollmentsOK creates a ListEnrollmentsOK with default headers values

func (*ListEnrollmentsOK) Error 

func (o *ListEnrollmentsOK) Error() string

func (*ListEnrollmentsOK) GetPayload 

func (o *ListEnrollmentsOK) GetPayload() *rest_model.ListEnrollmentsEnvelope

type ListEnrollmentsParams 

type ListEnrollmentsParams struct {

	// Filter.
	Filter *string

	// Limit.
	Limit *int64

	// Offset.
	Offset *int64

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

ListEnrollmentsParams contains all the parameters to send to the API endpoint 

for the list enrollments operation.

Typically these are written to a http.Request.

func NewListEnrollmentsParams 

func NewListEnrollmentsParams() *ListEnrollmentsParams

NewListEnrollmentsParams creates a new ListEnrollmentsParams 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 NewListEnrollmentsParamsWithContext 

func NewListEnrollmentsParamsWithContext(ctx context.Context) *ListEnrollmentsParams

NewListEnrollmentsParamsWithContext creates a new ListEnrollmentsParams object with the ability to set a context for a request.

func NewListEnrollmentsParamsWithHTTPClient 

func NewListEnrollmentsParamsWithHTTPClient(client *http.Client) *ListEnrollmentsParams

NewListEnrollmentsParamsWithHTTPClient creates a new ListEnrollmentsParams object with the ability to set a custom HTTPClient for a request.

func NewListEnrollmentsParamsWithTimeout 

func NewListEnrollmentsParamsWithTimeout(timeout time.Duration) *ListEnrollmentsParams

NewListEnrollmentsParamsWithTimeout creates a new ListEnrollmentsParams object with the ability to set a timeout on a request.

func (*ListEnrollmentsParams) SetContext 

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

SetContext adds the context to the list enrollments params

func (*ListEnrollmentsParams) SetDefaults 

func (o *ListEnrollmentsParams) SetDefaults()

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

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

func (*ListEnrollmentsParams) SetFilter 

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

SetFilter adds the filter to the list enrollments params

func (*ListEnrollmentsParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the list enrollments params

func (*ListEnrollmentsParams) SetLimit 

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

SetLimit adds the limit to the list enrollments params

func (*ListEnrollmentsParams) SetOffset 

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

SetOffset adds the offset to the list enrollments params

func (*ListEnrollmentsParams) SetTimeout 

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

SetTimeout adds the timeout to the list enrollments params

func (*ListEnrollmentsParams) WithContext 

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

WithContext adds the context to the list enrollments params

func (*ListEnrollmentsParams) WithDefaults 

func (o *ListEnrollmentsParams) WithDefaults() *ListEnrollmentsParams

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

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

func (*ListEnrollmentsParams) WithFilter 

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

WithFilter adds the filter to the list enrollments params

func (*ListEnrollmentsParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the list enrollments params

func (*ListEnrollmentsParams) WithLimit 

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

WithLimit adds the limit to the list enrollments params

func (*ListEnrollmentsParams) WithOffset 

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

WithOffset adds the offset to the list enrollments params

func (*ListEnrollmentsParams) WithTimeout 

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

WithTimeout adds the timeout to the list enrollments params

func (*ListEnrollmentsParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type ListEnrollmentsReader 

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

ListEnrollmentsReader is a Reader for the ListEnrollments structure.

func (*ListEnrollmentsReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type ListEnrollmentsUnauthorized 

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

func NewListEnrollmentsUnauthorized() *ListEnrollmentsUnauthorized

NewListEnrollmentsUnauthorized creates a ListEnrollmentsUnauthorized with default headers values

func (*ListEnrollmentsUnauthorized) Error 

func (o *ListEnrollmentsUnauthorized) Error() string

func (*ListEnrollmentsUnauthorized) GetPayload 

func (o *ListEnrollmentsUnauthorized) GetPayload() *rest_model.APIErrorEnvelope

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.