admin

package
v0.0.0-...-59d2d35 Latest Latest
Warning

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

 Go to latest Published: Nov 26, 2024 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 AdminGetSettingsForbidden 

type AdminGetSettingsForbidden struct {
	Payload *models.ErrorResponseBody
}

AdminGetSettingsForbidden describes a response with status code 403, with default header values.

ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.

func NewAdminGetSettingsForbidden 

func NewAdminGetSettingsForbidden() *AdminGetSettingsForbidden

NewAdminGetSettingsForbidden creates a AdminGetSettingsForbidden with default headers values

func (*AdminGetSettingsForbidden) Code 

func (o *AdminGetSettingsForbidden) Code() int

Code gets the status code for the admin get settings forbidden response

func (*AdminGetSettingsForbidden) Error 

func (o *AdminGetSettingsForbidden) Error() string

func (*AdminGetSettingsForbidden) GetPayload 

func (o *AdminGetSettingsForbidden) GetPayload() *models.ErrorResponseBody

func (*AdminGetSettingsForbidden) IsClientError 

func (o *AdminGetSettingsForbidden) IsClientError() bool

IsClientError returns true when this admin get settings forbidden response has a 4xx status code

func (*AdminGetSettingsForbidden) IsCode 

func (o *AdminGetSettingsForbidden) IsCode(code int) bool

IsCode returns true when this admin get settings forbidden response a status code equal to that given

func (*AdminGetSettingsForbidden) IsRedirect 

func (o *AdminGetSettingsForbidden) IsRedirect() bool

IsRedirect returns true when this admin get settings forbidden response has a 3xx status code

func (*AdminGetSettingsForbidden) IsServerError 

func (o *AdminGetSettingsForbidden) IsServerError() bool

IsServerError returns true when this admin get settings forbidden response has a 5xx status code

func (*AdminGetSettingsForbidden) IsSuccess 

func (o *AdminGetSettingsForbidden) IsSuccess() bool

IsSuccess returns true when this admin get settings forbidden response has a 2xx status code

func (*AdminGetSettingsForbidden) String 

func (o *AdminGetSettingsForbidden) String() string

type AdminGetSettingsOK 

type AdminGetSettingsOK struct {
	Payload models.SettingsBag
}

AdminGetSettingsOK describes a response with status code 200, with default header values.

(empty)

func NewAdminGetSettingsOK 

func NewAdminGetSettingsOK() *AdminGetSettingsOK

NewAdminGetSettingsOK creates a AdminGetSettingsOK with default headers values

func (*AdminGetSettingsOK) Code 

func (o *AdminGetSettingsOK) Code() int

Code gets the status code for the admin get settings Ok response

func (*AdminGetSettingsOK) Error 

func (o *AdminGetSettingsOK) Error() string

func (*AdminGetSettingsOK) GetPayload 

func (o *AdminGetSettingsOK) GetPayload() models.SettingsBag

func (*AdminGetSettingsOK) IsClientError 

func (o *AdminGetSettingsOK) IsClientError() bool

IsClientError returns true when this admin get settings Ok response has a 4xx status code

func (*AdminGetSettingsOK) IsCode 

func (o *AdminGetSettingsOK) IsCode(code int) bool

IsCode returns true when this admin get settings Ok response a status code equal to that given

func (*AdminGetSettingsOK) IsRedirect 

func (o *AdminGetSettingsOK) IsRedirect() bool

IsRedirect returns true when this admin get settings Ok response has a 3xx status code

func (*AdminGetSettingsOK) IsServerError 

func (o *AdminGetSettingsOK) IsServerError() bool

IsServerError returns true when this admin get settings Ok response has a 5xx status code

func (*AdminGetSettingsOK) IsSuccess 

func (o *AdminGetSettingsOK) IsSuccess() bool

IsSuccess returns true when this admin get settings Ok response has a 2xx status code

func (*AdminGetSettingsOK) String 

func (o *AdminGetSettingsOK) String() string

type AdminGetSettingsParams 

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

AdminGetSettingsParams contains all the parameters to send to the API endpoint 

for the admin get settings operation.

Typically these are written to a http.Request.

func NewAdminGetSettingsParams 

func NewAdminGetSettingsParams() *AdminGetSettingsParams

NewAdminGetSettingsParams creates a new AdminGetSettingsParams 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 NewAdminGetSettingsParamsWithContext 

func NewAdminGetSettingsParamsWithContext(ctx context.Context) *AdminGetSettingsParams

NewAdminGetSettingsParamsWithContext creates a new AdminGetSettingsParams object with the ability to set a context for a request.

func NewAdminGetSettingsParamsWithHTTPClient 

func NewAdminGetSettingsParamsWithHTTPClient(client *http.Client) *AdminGetSettingsParams

NewAdminGetSettingsParamsWithHTTPClient creates a new AdminGetSettingsParams object with the ability to set a custom HTTPClient for a request.

func NewAdminGetSettingsParamsWithTimeout 

func NewAdminGetSettingsParamsWithTimeout(timeout time.Duration) *AdminGetSettingsParams

NewAdminGetSettingsParamsWithTimeout creates a new AdminGetSettingsParams object with the ability to set a timeout on a request.

func (*AdminGetSettingsParams) SetContext 

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

SetContext adds the context to the admin get settings params

func (*AdminGetSettingsParams) SetDefaults 

func (o *AdminGetSettingsParams) SetDefaults()

SetDefaults hydrates default values in the admin get settings params (not the query body).

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

func (*AdminGetSettingsParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the admin get settings params

func (*AdminGetSettingsParams) SetTimeout 

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

SetTimeout adds the timeout to the admin get settings params

func (*AdminGetSettingsParams) WithContext 

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

WithContext adds the context to the admin get settings params

func (*AdminGetSettingsParams) WithDefaults 

func (o *AdminGetSettingsParams) WithDefaults() *AdminGetSettingsParams

WithDefaults hydrates default values in the admin get settings params (not the query body).

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

func (*AdminGetSettingsParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the admin get settings params

func (*AdminGetSettingsParams) WithTimeout 

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

WithTimeout adds the timeout to the admin get settings params

func (*AdminGetSettingsParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type AdminGetSettingsReader 

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

AdminGetSettingsReader is a Reader for the AdminGetSettings structure.

func (*AdminGetSettingsReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type AdminGetSettingsUnauthorized 

type AdminGetSettingsUnauthorized struct {
	Payload *models.ErrorResponseBody
}

AdminGetSettingsUnauthorized describes a response with status code 401, with default header values.

UnauthorizedError is returned when the request is not authenticated.

func NewAdminGetSettingsUnauthorized 

func NewAdminGetSettingsUnauthorized() *AdminGetSettingsUnauthorized

NewAdminGetSettingsUnauthorized creates a AdminGetSettingsUnauthorized with default headers values

func (*AdminGetSettingsUnauthorized) Code 

func (o *AdminGetSettingsUnauthorized) Code() int

Code gets the status code for the admin get settings unauthorized response

func (*AdminGetSettingsUnauthorized) Error 

func (o *AdminGetSettingsUnauthorized) Error() string

func (*AdminGetSettingsUnauthorized) GetPayload 

func (o *AdminGetSettingsUnauthorized) GetPayload() *models.ErrorResponseBody

func (*AdminGetSettingsUnauthorized) IsClientError 

func (o *AdminGetSettingsUnauthorized) IsClientError() bool

IsClientError returns true when this admin get settings unauthorized response has a 4xx status code

func (*AdminGetSettingsUnauthorized) IsCode 

func (o *AdminGetSettingsUnauthorized) IsCode(code int) bool

IsCode returns true when this admin get settings unauthorized response a status code equal to that given

func (*AdminGetSettingsUnauthorized) IsRedirect 

func (o *AdminGetSettingsUnauthorized) IsRedirect() bool

IsRedirect returns true when this admin get settings unauthorized response has a 3xx status code

func (*AdminGetSettingsUnauthorized) IsServerError 

func (o *AdminGetSettingsUnauthorized) IsServerError() bool

IsServerError returns true when this admin get settings unauthorized response has a 5xx status code

func (*AdminGetSettingsUnauthorized) IsSuccess 

func (o *AdminGetSettingsUnauthorized) IsSuccess() bool

IsSuccess returns true when this admin get settings unauthorized response has a 2xx status code

func (*AdminGetSettingsUnauthorized) String 

func (o *AdminGetSettingsUnauthorized) String() string

type AdminGetStatsForbidden 

type AdminGetStatsForbidden struct {
	Payload *models.ErrorResponseBody
}

AdminGetStatsForbidden describes a response with status code 403, with default header values.

ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.

func NewAdminGetStatsForbidden 

func NewAdminGetStatsForbidden() *AdminGetStatsForbidden

NewAdminGetStatsForbidden creates a AdminGetStatsForbidden with default headers values

func (*AdminGetStatsForbidden) Code 

func (o *AdminGetStatsForbidden) Code() int

Code gets the status code for the admin get stats forbidden response

func (*AdminGetStatsForbidden) Error 

func (o *AdminGetStatsForbidden) Error() string

func (*AdminGetStatsForbidden) GetPayload 

func (o *AdminGetStatsForbidden) GetPayload() *models.ErrorResponseBody

func (*AdminGetStatsForbidden) IsClientError 

func (o *AdminGetStatsForbidden) IsClientError() bool

IsClientError returns true when this admin get stats forbidden response has a 4xx status code

func (*AdminGetStatsForbidden) IsCode 

func (o *AdminGetStatsForbidden) IsCode(code int) bool

IsCode returns true when this admin get stats forbidden response a status code equal to that given

func (*AdminGetStatsForbidden) IsRedirect 

func (o *AdminGetStatsForbidden) IsRedirect() bool

IsRedirect returns true when this admin get stats forbidden response has a 3xx status code

func (*AdminGetStatsForbidden) IsServerError 

func (o *AdminGetStatsForbidden) IsServerError() bool

IsServerError returns true when this admin get stats forbidden response has a 5xx status code

func (*AdminGetStatsForbidden) IsSuccess 

func (o *AdminGetStatsForbidden) IsSuccess() bool

IsSuccess returns true when this admin get stats forbidden response has a 2xx status code

func (*AdminGetStatsForbidden) String 

func (o *AdminGetStatsForbidden) String() string

type AdminGetStatsInternalServerError 

type AdminGetStatsInternalServerError struct {
	Payload *models.ErrorResponseBody
}

AdminGetStatsInternalServerError describes a response with status code 500, with default header values.

InternalServerError is a general error indicating something went wrong internally.

func NewAdminGetStatsInternalServerError 

func NewAdminGetStatsInternalServerError() *AdminGetStatsInternalServerError

NewAdminGetStatsInternalServerError creates a AdminGetStatsInternalServerError with default headers values

func (*AdminGetStatsInternalServerError) Code 

func (o *AdminGetStatsInternalServerError) Code() int

Code gets the status code for the admin get stats internal server error response

func (*AdminGetStatsInternalServerError) Error 

func (o *AdminGetStatsInternalServerError) Error() string

func (*AdminGetStatsInternalServerError) GetPayload 

func (o *AdminGetStatsInternalServerError) GetPayload() *models.ErrorResponseBody

func (*AdminGetStatsInternalServerError) IsClientError 

func (o *AdminGetStatsInternalServerError) IsClientError() bool

IsClientError returns true when this admin get stats internal server error response has a 4xx status code

func (*AdminGetStatsInternalServerError) IsCode 

func (o *AdminGetStatsInternalServerError) IsCode(code int) bool

IsCode returns true when this admin get stats internal server error response a status code equal to that given

func (*AdminGetStatsInternalServerError) IsRedirect 

func (o *AdminGetStatsInternalServerError) IsRedirect() bool

IsRedirect returns true when this admin get stats internal server error response has a 3xx status code

func (*AdminGetStatsInternalServerError) IsServerError 

func (o *AdminGetStatsInternalServerError) IsServerError() bool

IsServerError returns true when this admin get stats internal server error response has a 5xx status code

func (*AdminGetStatsInternalServerError) IsSuccess 

func (o *AdminGetStatsInternalServerError) IsSuccess() bool

IsSuccess returns true when this admin get stats internal server error response has a 2xx status code

func (*AdminGetStatsInternalServerError) String 

func (o *AdminGetStatsInternalServerError) String() string

type AdminGetStatsOK 

type AdminGetStatsOK struct {
	Payload *models.AdminStats
}

AdminGetStatsOK describes a response with status code 200, with default header values.

(empty)

func NewAdminGetStatsOK 

func NewAdminGetStatsOK() *AdminGetStatsOK

NewAdminGetStatsOK creates a AdminGetStatsOK with default headers values

func (*AdminGetStatsOK) Code 

func (o *AdminGetStatsOK) Code() int

Code gets the status code for the admin get stats Ok response

func (*AdminGetStatsOK) Error 

func (o *AdminGetStatsOK) Error() string

func (*AdminGetStatsOK) GetPayload 

func (o *AdminGetStatsOK) GetPayload() *models.AdminStats

func (*AdminGetStatsOK) IsClientError 

func (o *AdminGetStatsOK) IsClientError() bool

IsClientError returns true when this admin get stats Ok response has a 4xx status code

func (*AdminGetStatsOK) IsCode 

func (o *AdminGetStatsOK) IsCode(code int) bool

IsCode returns true when this admin get stats Ok response a status code equal to that given

func (*AdminGetStatsOK) IsRedirect 

func (o *AdminGetStatsOK) IsRedirect() bool

IsRedirect returns true when this admin get stats Ok response has a 3xx status code

func (*AdminGetStatsOK) IsServerError 

func (o *AdminGetStatsOK) IsServerError() bool

IsServerError returns true when this admin get stats Ok response has a 5xx status code

func (*AdminGetStatsOK) IsSuccess 

func (o *AdminGetStatsOK) IsSuccess() bool

IsSuccess returns true when this admin get stats Ok response has a 2xx status code

func (*AdminGetStatsOK) String 

func (o *AdminGetStatsOK) String() string

type AdminGetStatsParams 

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

AdminGetStatsParams contains all the parameters to send to the API endpoint 

for the admin get stats operation.

Typically these are written to a http.Request.

func NewAdminGetStatsParams 

func NewAdminGetStatsParams() *AdminGetStatsParams

NewAdminGetStatsParams creates a new AdminGetStatsParams 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 NewAdminGetStatsParamsWithContext 

func NewAdminGetStatsParamsWithContext(ctx context.Context) *AdminGetStatsParams

NewAdminGetStatsParamsWithContext creates a new AdminGetStatsParams object with the ability to set a context for a request.

func NewAdminGetStatsParamsWithHTTPClient 

func NewAdminGetStatsParamsWithHTTPClient(client *http.Client) *AdminGetStatsParams

NewAdminGetStatsParamsWithHTTPClient creates a new AdminGetStatsParams object with the ability to set a custom HTTPClient for a request.

func NewAdminGetStatsParamsWithTimeout 

func NewAdminGetStatsParamsWithTimeout(timeout time.Duration) *AdminGetStatsParams

NewAdminGetStatsParamsWithTimeout creates a new AdminGetStatsParams object with the ability to set a timeout on a request.

func (*AdminGetStatsParams) SetContext 

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

SetContext adds the context to the admin get stats params

func (*AdminGetStatsParams) SetDefaults 

func (o *AdminGetStatsParams) SetDefaults()

SetDefaults hydrates default values in the admin get stats params (not the query body).

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

func (*AdminGetStatsParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the admin get stats params

func (*AdminGetStatsParams) SetTimeout 

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

SetTimeout adds the timeout to the admin get stats params

func (*AdminGetStatsParams) WithContext 

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

WithContext adds the context to the admin get stats params

func (*AdminGetStatsParams) WithDefaults 

func (o *AdminGetStatsParams) WithDefaults() *AdminGetStatsParams

WithDefaults hydrates default values in the admin get stats params (not the query body).

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

func (*AdminGetStatsParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the admin get stats params

func (*AdminGetStatsParams) WithTimeout 

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

WithTimeout adds the timeout to the admin get stats params

func (*AdminGetStatsParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type AdminGetStatsReader 

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

AdminGetStatsReader is a Reader for the AdminGetStats structure.

func (*AdminGetStatsReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type AdminGetStatsUnauthorized 

type AdminGetStatsUnauthorized struct {
	Payload *models.ErrorResponseBody
}

AdminGetStatsUnauthorized describes a response with status code 401, with default header values.

UnauthorizedError is returned when the request is not authenticated.

func NewAdminGetStatsUnauthorized 

func NewAdminGetStatsUnauthorized() *AdminGetStatsUnauthorized

NewAdminGetStatsUnauthorized creates a AdminGetStatsUnauthorized with default headers values

func (*AdminGetStatsUnauthorized) Code 

func (o *AdminGetStatsUnauthorized) Code() int

Code gets the status code for the admin get stats unauthorized response

func (*AdminGetStatsUnauthorized) Error 

func (o *AdminGetStatsUnauthorized) Error() string

func (*AdminGetStatsUnauthorized) GetPayload 

func (o *AdminGetStatsUnauthorized) GetPayload() *models.ErrorResponseBody

func (*AdminGetStatsUnauthorized) IsClientError 

func (o *AdminGetStatsUnauthorized) IsClientError() bool

IsClientError returns true when this admin get stats unauthorized response has a 4xx status code

func (*AdminGetStatsUnauthorized) IsCode 

func (o *AdminGetStatsUnauthorized) IsCode(code int) bool

IsCode returns true when this admin get stats unauthorized response a status code equal to that given

func (*AdminGetStatsUnauthorized) IsRedirect 

func (o *AdminGetStatsUnauthorized) IsRedirect() bool

IsRedirect returns true when this admin get stats unauthorized response has a 3xx status code

func (*AdminGetStatsUnauthorized) IsServerError 

func (o *AdminGetStatsUnauthorized) IsServerError() bool

IsServerError returns true when this admin get stats unauthorized response has a 5xx status code

func (*AdminGetStatsUnauthorized) IsSuccess 

func (o *AdminGetStatsUnauthorized) IsSuccess() bool

IsSuccess returns true when this admin get stats unauthorized response has a 2xx status code

func (*AdminGetStatsUnauthorized) String 

func (o *AdminGetStatsUnauthorized) String() string

type Client 

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

Client for admin API

func (*Client) AdminGetSettings 

func (a *Client) AdminGetSettings(opts ...ClientOption) (*AdminGetSettingsOK, error)

AdminGetSettings fetches settings

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `settings:read` and scopes: `settings:*`, `settings:auth.saml:` and `settings:auth.saml:enabled` (property level).

func (*Client) AdminGetSettingsWithParams 

func (a *Client) AdminGetSettingsWithParams(params *AdminGetSettingsParams, opts ...ClientOption) (*AdminGetSettingsOK, error)

func (*Client) AdminGetStats 

func (a *Client) AdminGetStats(opts ...ClientOption) (*AdminGetStatsOK, error)

AdminGetStats fetches grafana stats

Only works with Basic Authentication (username and password). See introduction for an explanation. If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `server:stats:read`.

func (*Client) AdminGetStatsWithParams 

func (a *Client) AdminGetStatsWithParams(params *AdminGetStatsParams, opts ...ClientOption) (*AdminGetStatsOK, error)

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

func WithAuthInfo 

func WithAuthInfo(authInfo runtime.ClientAuthInfoWriter) ClientOption

WithAuthInfo changes the transport on the client

type ClientService 

type ClientService interface {
	AdminGetSettings(opts ...ClientOption) (*AdminGetSettingsOK, error)
	AdminGetSettingsWithParams(params *AdminGetSettingsParams, opts ...ClientOption) (*AdminGetSettingsOK, error)

	AdminGetStats(opts ...ClientOption) (*AdminGetStatsOK, error)
	AdminGetStatsWithParams(params *AdminGetStatsParams, opts ...ClientOption) (*AdminGetStatsOK, 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 admin API client.

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.