configuration

package
v1.40.2 Latest Latest
Warning

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

 Go to latest Published: Nov 3, 2026 License: MIT Imports: 12 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 configuration API.

func (*Client) GetConfiguration 

func (a *Client) GetConfiguration(params *GetConfigurationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetConfigurationOK, error)

GetConfiguration shows the cluster environment.

This method does not support injected context. However, timeout and opentracing contexts are honored whenever enabled.

If you need to pass a specific context, use Client.GetConfigurationContext instead.

func (*Client) GetConfigurationContext added in v1.40.2 

func (a *Client) GetConfigurationContext(ctx context.Context, params *GetConfigurationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetConfigurationOK, error)

GetConfigurationContext shows the cluster environment.

Do not use the deprecated [GetConfigurationParams.Context] with this method: it would be ignored.

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption may be used to customize the behavior of Client methods.

type ClientService 

type ClientService interface {

	// GetConfiguration show the cluster environment.
	GetConfiguration(params *GetConfigurationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetConfigurationOK, error)

	// GetConfigurationContext show the cluster environment.
	GetConfigurationContext(ctx context.Context, params *GetConfigurationParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetConfigurationOK, error)

	SetTransport(transport runtime.ContextualTransport)
}

ClientService is the interface for Client methods.

func New 

func New(transport runtime.ContextualTransport, formats strfmt.Registry) ClientService

New creates a new configuration API client.

func NewClientWithBasicAuth 

func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService

New creates a new configuration API client with basic auth credentials.

It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.

func NewClientWithBearerToken 

func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService

New creates a new configuration API client with a bearer token for authentication.

It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.

type GetConfigurationForbidden 

type GetConfigurationForbidden struct {
}

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

Forbidden

func NewGetConfigurationForbidden 

func NewGetConfigurationForbidden() *GetConfigurationForbidden

NewGetConfigurationForbidden creates a GetConfigurationForbidden with default headers values

func (*GetConfigurationForbidden) Code 

func (o *GetConfigurationForbidden) Code() int

Code gets the status code for the get configuration forbidden response

func (*GetConfigurationForbidden) Error 

func (o *GetConfigurationForbidden) Error() string

func (*GetConfigurationForbidden) IsClientError 

func (o *GetConfigurationForbidden) IsClientError() bool

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

func (*GetConfigurationForbidden) IsCode 

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

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

func (*GetConfigurationForbidden) IsRedirect 

func (o *GetConfigurationForbidden) IsRedirect() bool

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

func (*GetConfigurationForbidden) IsServerError 

func (o *GetConfigurationForbidden) IsServerError() bool

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

func (*GetConfigurationForbidden) IsSuccess 

func (o *GetConfigurationForbidden) IsSuccess() bool

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

func (*GetConfigurationForbidden) String 

func (o *GetConfigurationForbidden) String() string

type GetConfigurationInternalServerError 

type GetConfigurationInternalServerError struct {
}

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

Internal Server Error

func NewGetConfigurationInternalServerError 

func NewGetConfigurationInternalServerError() *GetConfigurationInternalServerError

NewGetConfigurationInternalServerError creates a GetConfigurationInternalServerError with default headers values

func (*GetConfigurationInternalServerError) Code 

func (o *GetConfigurationInternalServerError) Code() int

Code gets the status code for the get configuration internal server error response

func (*GetConfigurationInternalServerError) Error 

func (o *GetConfigurationInternalServerError) Error() string

func (*GetConfigurationInternalServerError) IsClientError 

func (o *GetConfigurationInternalServerError) IsClientError() bool

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

func (*GetConfigurationInternalServerError) IsCode 

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

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

func (*GetConfigurationInternalServerError) IsRedirect 

func (o *GetConfigurationInternalServerError) IsRedirect() bool

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

func (*GetConfigurationInternalServerError) IsServerError 

func (o *GetConfigurationInternalServerError) IsServerError() bool

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

func (*GetConfigurationInternalServerError) IsSuccess 

func (o *GetConfigurationInternalServerError) IsSuccess() bool

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

func (*GetConfigurationInternalServerError) String 

func (o *GetConfigurationInternalServerError) String() string

type GetConfigurationOK 

type GetConfigurationOK struct {
	Payload *models.ClusterConfiguration
}

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

Successful operation

func NewGetConfigurationOK 

func NewGetConfigurationOK() *GetConfigurationOK

NewGetConfigurationOK creates a GetConfigurationOK with default headers values

func (*GetConfigurationOK) Code 

func (o *GetConfigurationOK) Code() int

Code gets the status code for the get configuration o k response

func (*GetConfigurationOK) Error 

func (o *GetConfigurationOK) Error() string

func (*GetConfigurationOK) GetPayload 

func (o *GetConfigurationOK) GetPayload() *models.ClusterConfiguration

func (*GetConfigurationOK) IsClientError 

func (o *GetConfigurationOK) IsClientError() bool

IsClientError returns true when this get configuration o k response has a 4xx status code

func (*GetConfigurationOK) IsCode 

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

IsCode returns true when this get configuration o k response a status code equal to that given

func (*GetConfigurationOK) IsRedirect 

func (o *GetConfigurationOK) IsRedirect() bool

IsRedirect returns true when this get configuration o k response has a 3xx status code

func (*GetConfigurationOK) IsServerError 

func (o *GetConfigurationOK) IsServerError() bool

IsServerError returns true when this get configuration o k response has a 5xx status code

func (*GetConfigurationOK) IsSuccess 

func (o *GetConfigurationOK) IsSuccess() bool

IsSuccess returns true when this get configuration o k response has a 2xx status code

func (*GetConfigurationOK) String 

func (o *GetConfigurationOK) String() string

type GetConfigurationParams 

type GetConfigurationParams struct {
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetConfigurationParams contains all the parameters to send to the API endpoint 

for the get configuration operation.

Typically these are written to a http.Request.

func NewGetConfigurationParams 

func NewGetConfigurationParams() *GetConfigurationParams

NewGetConfigurationParams creates a new GetConfigurationParams 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 NewGetConfigurationParamsWithContext deprecated 

func NewGetConfigurationParamsWithContext(ctx context.Context) *GetConfigurationParams

NewGetConfigurationParamsWithContext creates a new GetConfigurationParams object with the ability to set a context for a request.

Deprecated: use the operation call with context to pass the context instead of GetConfigurationParams.

func NewGetConfigurationParamsWithHTTPClient 

func NewGetConfigurationParamsWithHTTPClient(client *http.Client) *GetConfigurationParams

NewGetConfigurationParamsWithHTTPClient creates a new GetConfigurationParams object with the ability to set a custom HTTPClient for a request.

func NewGetConfigurationParamsWithTimeout 

func NewGetConfigurationParamsWithTimeout(timeout time.Duration) *GetConfigurationParams

NewGetConfigurationParamsWithTimeout creates a new GetConfigurationParams object with the ability to set a timeout on a request.

func (*GetConfigurationParams) SetContext deprecated 

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

SetContext adds the context to the get configuration params.

Deprecated: use the operation call with context to pass the context instead of GetConfigurationParams.

func (*GetConfigurationParams) SetDefaults 

func (o *GetConfigurationParams) SetDefaults()

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

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

func (*GetConfigurationParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get configuration params.

func (*GetConfigurationParams) SetTimeout 

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

SetTimeout adds the timeout to the get configuration params.

func (*GetConfigurationParams) WithContext deprecated 

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

WithContext adds the context to the get configuration params.

Deprecated: use the operation call with context to pass the context instead of GetConfigurationParams.

func (*GetConfigurationParams) WithDefaults 

func (o *GetConfigurationParams) WithDefaults() *GetConfigurationParams

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

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

func (*GetConfigurationParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get configuration params.

func (*GetConfigurationParams) WithTimeout 

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

WithTimeout adds the timeout to the get configuration params.

func (*GetConfigurationParams) WriteToRequest 

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

WriteToRequest writes these params to a runtime.ClientRequest.

type GetConfigurationReader 

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

GetConfigurationReader is a Reader for the GetConfiguration structure.

func (*GetConfigurationReader) ReadResponse 

func (o *GetConfigurationReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (any, error)

ReadResponse reads a server response into the received o.

type GetConfigurationUnauthorized 

type GetConfigurationUnauthorized struct {
}

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

Unauthorized

func NewGetConfigurationUnauthorized 

func NewGetConfigurationUnauthorized() *GetConfigurationUnauthorized

NewGetConfigurationUnauthorized creates a GetConfigurationUnauthorized with default headers values

func (*GetConfigurationUnauthorized) Code 

func (o *GetConfigurationUnauthorized) Code() int

Code gets the status code for the get configuration unauthorized response

func (*GetConfigurationUnauthorized) Error 

func (o *GetConfigurationUnauthorized) Error() string

func (*GetConfigurationUnauthorized) IsClientError 

func (o *GetConfigurationUnauthorized) IsClientError() bool

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

func (*GetConfigurationUnauthorized) IsCode 

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

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

func (*GetConfigurationUnauthorized) IsRedirect 

func (o *GetConfigurationUnauthorized) IsRedirect() bool

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

func (*GetConfigurationUnauthorized) IsServerError 

func (o *GetConfigurationUnauthorized) IsServerError() bool

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

func (*GetConfigurationUnauthorized) IsSuccess 

func (o *GetConfigurationUnauthorized) IsSuccess() bool

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

func (*GetConfigurationUnauthorized) String 

func (o *GetConfigurationUnauthorized) String() string

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.