admin_configurations

package
v0.42.0 Latest Latest
Warning

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

 Go to latest Published: Apr 10, 2023 License: MIT Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	GetAllConstant       = "all"
	GetExtensionConstant = "extension"
)

Get the enum in GetParams

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

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

Client for admin configurations API

func (*Client) Get deprecated 

func (a *Client) Get(params *GetParams, authInfo runtime.ClientAuthInfoWriter) (*GetOK, *GetInternalServerError, error)

Deprecated: 2022-08-10 - Use GetShort instead. 

Get gets configuration

Required permission: ADMIN:NAMESPACE:{namespace}:REPORTINGCONFIG [READ]

TimeInterval is in nanoseconds. When there's no configuration set, the response is the default value (configurable through envar).

func (*Client) GetShort 

func (a *Client) GetShort(params *GetParams, authInfo runtime.ClientAuthInfoWriter) (*GetOK, error)
GetShort gets configuration

Required permission: ADMIN:NAMESPACE:{namespace}:REPORTINGCONFIG [READ]

TimeInterval is in nanoseconds. When there's no configuration set, the response is the default value (configurable through envar).

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

func (*Client) Upsert deprecated 

func (a *Client) Upsert(params *UpsertParams, authInfo runtime.ClientAuthInfoWriter) (*UpsertOK, *UpsertBadRequest, *UpsertInternalServerError, error)

Deprecated: 2022-08-10 - Use UpsertShort instead. 

Upsert creates update configuration

Required permission: ADMIN:NAMESPACE:{namespace}:REPORTINGCONFIG [CREATE]

The behaviour of this endpoint is upsert based on the namespace. So, you can use this for both creating & updating the configuration. TimeInterval is in nanoseconds.

func (*Client) UpsertShort 

func (a *Client) UpsertShort(params *UpsertParams, authInfo runtime.ClientAuthInfoWriter) (*UpsertOK, error)
UpsertShort creates update configuration

Required permission: ADMIN:NAMESPACE:{namespace}:REPORTINGCONFIG [CREATE]

The behaviour of this endpoint is upsert based on the namespace. So, you can use this for both creating & updating the configuration. TimeInterval is in nanoseconds.

type ClientService 

type ClientService interface {
	Get(params *GetParams, authInfo runtime.ClientAuthInfoWriter) (*GetOK, *GetInternalServerError, error)
	GetShort(params *GetParams, authInfo runtime.ClientAuthInfoWriter) (*GetOK, error)
	Upsert(params *UpsertParams, authInfo runtime.ClientAuthInfoWriter) (*UpsertOK, *UpsertBadRequest, *UpsertInternalServerError, error)
	UpsertShort(params *UpsertParams, authInfo runtime.ClientAuthInfoWriter) (*UpsertOK, 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 configurations API client.

type GetInternalServerError 

type GetInternalServerError struct {
	Payload *reportingclientmodels.RestapiErrorResponse
}

GetInternalServerError handles this case with default header values. 

GetInternalServerError get internal server error

func NewGetInternalServerError 

func NewGetInternalServerError() *GetInternalServerError

NewGetInternalServerError creates a GetInternalServerError with default headers values

func (*GetInternalServerError) Error 

func (o *GetInternalServerError) Error() string

func (*GetInternalServerError) GetPayload 

func (o *GetInternalServerError) GetPayload() *reportingclientmodels.RestapiErrorResponse

func (*GetInternalServerError) ToJSONString 

func (o *GetInternalServerError) ToJSONString() string

type GetOK 

type GetOK struct {
	Payload *reportingclientmodels.RestapiConfigResponse
}

GetOK handles this case with default header values. 

GetOK get o k

func NewGetOK 

func NewGetOK() *GetOK

NewGetOK creates a GetOK with default headers values

func (*GetOK) Error 

func (o *GetOK) Error() string

func (*GetOK) GetPayload 

func (o *GetOK) GetPayload() *reportingclientmodels.RestapiConfigResponse

func (*GetOK) ToJSONString 

func (o *GetOK) ToJSONString() string

type GetParams 

type GetParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Category
	      configuration category flag.
	  			set this to 'all' to retrieve all category configurations
	  			set this to 'extension' to retrieve [EXTENSION] category configurations
	  			leave it blank to retrieve core categories [UGC,USER,CHAT] configurations


	*/
	Category *string
	/*Namespace*/
	Namespace string

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

GetParams contains all the parameters to send to the API endpoint for the get operation typically these are written to a http.Request

func NewGetParams 

func NewGetParams() *GetParams

NewGetParams creates a new GetParams object with the default values initialized.

func NewGetParamsWithContext 

func NewGetParamsWithContext(ctx context.Context) *GetParams

NewGetParamsWithContext creates a new GetParams object with the default values initialized, and the ability to set a context for a request

func NewGetParamsWithHTTPClient 

func NewGetParamsWithHTTPClient(client *http.Client) *GetParams

NewGetParamsWithHTTPClient creates a new GetParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewGetParamsWithTimeout 

func NewGetParamsWithTimeout(timeout time.Duration) *GetParams

NewGetParamsWithTimeout creates a new GetParams object with the default values initialized, and the ability to set a timeout on a request

func (*GetParams) SetAuthInfoWriter 

func (o *GetParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the get params

func (*GetParams) SetCategory 

func (o *GetParams) SetCategory(category *string)

SetCategory adds the category to the get params

func (*GetParams) SetContext 

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

SetContext adds the context to the get params

func (*GetParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the get params

func (*GetParams) SetHTTPClientTransport 

func (o *GetParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the get params

func (*GetParams) SetNamespace 

func (o *GetParams) SetNamespace(namespace string)

SetNamespace adds the namespace to the get params

func (*GetParams) SetTimeout 

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

SetTimeout adds the timeout to the get params

func (*GetParams) WithCategory 

func (o *GetParams) WithCategory(category *string) *GetParams

WithCategory adds the category to the get params

func (*GetParams) WithContext 

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

WithContext adds the context to the get params

func (*GetParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the get params

func (*GetParams) WithNamespace 

func (o *GetParams) WithNamespace(namespace string) *GetParams

WithNamespace adds the namespace to the get params

func (*GetParams) WithTimeout 

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

WithTimeout adds the timeout to the get params

func (*GetParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type GetReader 

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

GetReader is a Reader for the Get structure.

func (*GetReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type UpsertBadRequest 

type UpsertBadRequest struct {
	Payload *reportingclientmodels.RestapiErrorResponse
}

UpsertBadRequest handles this case with default header values. 

UpsertBadRequest upsert bad request

func NewUpsertBadRequest 

func NewUpsertBadRequest() *UpsertBadRequest

NewUpsertBadRequest creates a UpsertBadRequest with default headers values

func (*UpsertBadRequest) Error 

func (o *UpsertBadRequest) Error() string

func (*UpsertBadRequest) GetPayload 

func (o *UpsertBadRequest) GetPayload() *reportingclientmodels.RestapiErrorResponse

func (*UpsertBadRequest) ToJSONString 

func (o *UpsertBadRequest) ToJSONString() string

type UpsertInternalServerError 

type UpsertInternalServerError struct {
	Payload *reportingclientmodels.RestapiErrorResponse
}

UpsertInternalServerError handles this case with default header values. 

UpsertInternalServerError upsert internal server error

func NewUpsertInternalServerError 

func NewUpsertInternalServerError() *UpsertInternalServerError

NewUpsertInternalServerError creates a UpsertInternalServerError with default headers values

func (*UpsertInternalServerError) Error 

func (o *UpsertInternalServerError) Error() string

func (*UpsertInternalServerError) GetPayload 

func (o *UpsertInternalServerError) GetPayload() *reportingclientmodels.RestapiErrorResponse

func (*UpsertInternalServerError) ToJSONString 

func (o *UpsertInternalServerError) ToJSONString() string

type UpsertOK 

type UpsertOK struct {
	Payload *reportingclientmodels.RestapiConfigResponse
}

UpsertOK handles this case with default header values. 

UpsertOK upsert o k

func NewUpsertOK 

func NewUpsertOK() *UpsertOK

NewUpsertOK creates a UpsertOK with default headers values

func (*UpsertOK) Error 

func (o *UpsertOK) Error() string

func (*UpsertOK) GetPayload 

func (o *UpsertOK) GetPayload() *reportingclientmodels.RestapiConfigResponse

func (*UpsertOK) ToJSONString 

func (o *UpsertOK) ToJSONString() string

type UpsertParams 

type UpsertParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Body*/
	Body *reportingclientmodels.RestapiReportingLimit
	/*Namespace*/
	Namespace string

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

UpsertParams contains all the parameters to send to the API endpoint for the upsert operation typically these are written to a http.Request

func NewUpsertParams 

func NewUpsertParams() *UpsertParams

NewUpsertParams creates a new UpsertParams object with the default values initialized.

func NewUpsertParamsWithContext 

func NewUpsertParamsWithContext(ctx context.Context) *UpsertParams

NewUpsertParamsWithContext creates a new UpsertParams object with the default values initialized, and the ability to set a context for a request

func NewUpsertParamsWithHTTPClient 

func NewUpsertParamsWithHTTPClient(client *http.Client) *UpsertParams

NewUpsertParamsWithHTTPClient creates a new UpsertParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewUpsertParamsWithTimeout 

func NewUpsertParamsWithTimeout(timeout time.Duration) *UpsertParams

NewUpsertParamsWithTimeout creates a new UpsertParams object with the default values initialized, and the ability to set a timeout on a request

func (*UpsertParams) SetAuthInfoWriter 

func (o *UpsertParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the upsert params

func (*UpsertParams) SetBody 

func (o *UpsertParams) SetBody(body *reportingclientmodels.RestapiReportingLimit)

SetBody adds the body to the upsert params

func (*UpsertParams) SetContext 

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

SetContext adds the context to the upsert params

func (*UpsertParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the upsert params

func (*UpsertParams) SetHTTPClientTransport 

func (o *UpsertParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the upsert params

func (*UpsertParams) SetNamespace 

func (o *UpsertParams) SetNamespace(namespace string)

SetNamespace adds the namespace to the upsert params

func (*UpsertParams) SetTimeout 

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

SetTimeout adds the timeout to the upsert params

func (*UpsertParams) WithBody 

func (o *UpsertParams) WithBody(body *reportingclientmodels.RestapiReportingLimit) *UpsertParams

WithBody adds the body to the upsert params

func (*UpsertParams) WithContext 

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

WithContext adds the context to the upsert params

func (*UpsertParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the upsert params

func (*UpsertParams) WithNamespace 

func (o *UpsertParams) WithNamespace(namespace string) *UpsertParams

WithNamespace adds the namespace to the upsert params

func (*UpsertParams) WithTimeout 

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

WithTimeout adds the timeout to the upsert params

func (*UpsertParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type UpsertReader 

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

UpsertReader is a Reader for the Upsert structure.

func (*UpsertReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

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.