proxy_sql

package
Version: v2.18.0+incompatible Latest Latest
Warning

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

Go to latest
Published: May 17, 2021 License: AGPL-3.0 Imports: 13 Imported by: 1

Documentation

Index

Constants

View Source
const (

	// AddProxySQLBodyMetricsModeAUTO captures enum value "AUTO"
	AddProxySQLBodyMetricsModeAUTO string = "AUTO"

	// AddProxySQLBodyMetricsModePULL captures enum value "PULL"
	AddProxySQLBodyMetricsModePULL string = "PULL"

	// AddProxySQLBodyMetricsModePUSH captures enum value "PUSH"
	AddProxySQLBodyMetricsModePUSH string = "PUSH"
)
View Source
const (

	// AddProxySQLOKBodyProxysqlExporterStatusAGENTSTATUSINVALID captures enum value "AGENT_STATUS_INVALID"
	AddProxySQLOKBodyProxysqlExporterStatusAGENTSTATUSINVALID string = "AGENT_STATUS_INVALID"

	// AddProxySQLOKBodyProxysqlExporterStatusSTARTING captures enum value "STARTING"
	AddProxySQLOKBodyProxysqlExporterStatusSTARTING string = "STARTING"

	// AddProxySQLOKBodyProxysqlExporterStatusRUNNING captures enum value "RUNNING"
	AddProxySQLOKBodyProxysqlExporterStatusRUNNING string = "RUNNING"

	// AddProxySQLOKBodyProxysqlExporterStatusWAITING captures enum value "WAITING"
	AddProxySQLOKBodyProxysqlExporterStatusWAITING string = "WAITING"

	// AddProxySQLOKBodyProxysqlExporterStatusSTOPPING captures enum value "STOPPING"
	AddProxySQLOKBodyProxysqlExporterStatusSTOPPING string = "STOPPING"

	// AddProxySQLOKBodyProxysqlExporterStatusDONE captures enum value "DONE"
	AddProxySQLOKBodyProxysqlExporterStatusDONE string = "DONE"
)
View Source
const (

	// AddProxySQLParamsBodyAddNodeNodeTypeNODETYPEINVALID captures enum value "NODE_TYPE_INVALID"
	AddProxySQLParamsBodyAddNodeNodeTypeNODETYPEINVALID string = "NODE_TYPE_INVALID"

	// AddProxySQLParamsBodyAddNodeNodeTypeGENERICNODE captures enum value "GENERIC_NODE"
	AddProxySQLParamsBodyAddNodeNodeTypeGENERICNODE string = "GENERIC_NODE"

	// AddProxySQLParamsBodyAddNodeNodeTypeCONTAINERNODE captures enum value "CONTAINER_NODE"
	AddProxySQLParamsBodyAddNodeNodeTypeCONTAINERNODE string = "CONTAINER_NODE"

	// AddProxySQLParamsBodyAddNodeNodeTypeREMOTENODE captures enum value "REMOTE_NODE"
	AddProxySQLParamsBodyAddNodeNodeTypeREMOTENODE string = "REMOTE_NODE"

	// AddProxySQLParamsBodyAddNodeNodeTypeREMOTERDSNODE captures enum value "REMOTE_RDS_NODE"
	AddProxySQLParamsBodyAddNodeNodeTypeREMOTERDSNODE string = "REMOTE_RDS_NODE"

	// AddProxySQLParamsBodyAddNodeNodeTypeREMOTEAZUREDATABASENODE captures enum value "REMOTE_AZURE_DATABASE_NODE"
	AddProxySQLParamsBodyAddNodeNodeTypeREMOTEAZUREDATABASENODE string = "REMOTE_AZURE_DATABASE_NODE"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AddProxySQLBody

type AddProxySQLBody struct {

	// Node identifier on which a service is been running.
	// Exactly one of these parameters should be present: node_id, node_name, add_node.
	NodeID string `json:"node_id,omitempty"`

	// Node name on which a service is been running.
	// Exactly one of these parameters should be present: node_id, node_name, add_node.
	NodeName string `json:"node_name,omitempty"`

	// Unique across all Services user-defined name. Required.
	ServiceName string `json:"service_name,omitempty"`

	// Node and Service access address (DNS name or IP).
	// Address (and port) or socket is required.
	Address string `json:"address,omitempty"`

	// Service Access port.
	// Port is required when the address present.
	Port int64 `json:"port,omitempty"`

	// Service Access socket.
	// Address (and port) or socket is required.
	Socket string `json:"socket,omitempty"`

	// The "pmm-agent" identifier which should run agents. Required.
	PMMAgentID string `json:"pmm_agent_id,omitempty"`

	// Environment name.
	Environment string `json:"environment,omitempty"`

	// Cluster name.
	Cluster string `json:"cluster,omitempty"`

	// Replication set name.
	ReplicationSet string `json:"replication_set,omitempty"`

	// ProxySQL username for scraping metrics.
	Username string `json:"username,omitempty"`

	// ProxySQL password for scraping metrics.
	Password string `json:"password,omitempty"`

	// Custom user-assigned labels for Service.
	CustomLabels map[string]string `json:"custom_labels,omitempty"`

	// Skip connection check.
	SkipConnectionCheck bool `json:"skip_connection_check,omitempty"`

	// Use TLS for database connections.
	TLS bool `json:"tls,omitempty"`

	// Skip TLS certificate and hostname validation.
	TLSSkipVerify bool `json:"tls_skip_verify,omitempty"`

	// MetricsMode defines desired metrics mode for agent,
	// it can be pull, push or auto mode chosen by server.
	// Enum: [AUTO PULL PUSH]
	MetricsMode *string `json:"metrics_mode,omitempty"`

	// List of collector names to disable in this exporter.
	DisableCollectors []string `json:"disable_collectors"`

	// add node
	AddNode *AddProxySQLParamsBodyAddNode `json:"add_node,omitempty"`
}

AddProxySQLBody add proxy SQL body swagger:model AddProxySQLBody

func (*AddProxySQLBody) MarshalBinary

func (o *AddProxySQLBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AddProxySQLBody) UnmarshalBinary

func (o *AddProxySQLBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AddProxySQLBody) Validate

func (o *AddProxySQLBody) Validate(formats strfmt.Registry) error

Validate validates this add proxy SQL body

type AddProxySQLDefault

type AddProxySQLDefault struct {
	Payload *AddProxySQLDefaultBody
	// contains filtered or unexported fields
}

AddProxySQLDefault handles this case with default header values.

An unexpected error response.

func NewAddProxySQLDefault

func NewAddProxySQLDefault(code int) *AddProxySQLDefault

NewAddProxySQLDefault creates a AddProxySQLDefault with default headers values

func (*AddProxySQLDefault) Code

func (o *AddProxySQLDefault) Code() int

Code gets the status code for the add proxy SQL default response

func (*AddProxySQLDefault) Error

func (o *AddProxySQLDefault) Error() string

func (*AddProxySQLDefault) GetPayload

func (o *AddProxySQLDefault) GetPayload() *AddProxySQLDefaultBody

type AddProxySQLDefaultBody

type AddProxySQLDefaultBody struct {

	// error
	Error string `json:"error,omitempty"`

	// code
	Code int32 `json:"code,omitempty"`

	// message
	Message string `json:"message,omitempty"`

	// details
	Details []*DetailsItems0 `json:"details"`
}

AddProxySQLDefaultBody add proxy SQL default body swagger:model AddProxySQLDefaultBody

func (*AddProxySQLDefaultBody) MarshalBinary

func (o *AddProxySQLDefaultBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AddProxySQLDefaultBody) UnmarshalBinary

func (o *AddProxySQLDefaultBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AddProxySQLDefaultBody) Validate

func (o *AddProxySQLDefaultBody) Validate(formats strfmt.Registry) error

Validate validates this add proxy SQL default body

type AddProxySQLOK

type AddProxySQLOK struct {
	Payload *AddProxySQLOKBody
}

AddProxySQLOK handles this case with default header values.

A successful response.

func NewAddProxySQLOK

func NewAddProxySQLOK() *AddProxySQLOK

NewAddProxySQLOK creates a AddProxySQLOK with default headers values

func (*AddProxySQLOK) Error

func (o *AddProxySQLOK) Error() string

func (*AddProxySQLOK) GetPayload

func (o *AddProxySQLOK) GetPayload() *AddProxySQLOKBody

type AddProxySQLOKBody

type AddProxySQLOKBody struct {

	// proxysql exporter
	ProxysqlExporter *AddProxySQLOKBodyProxysqlExporter `json:"proxysql_exporter,omitempty"`

	// service
	Service *AddProxySQLOKBodyService `json:"service,omitempty"`
}

AddProxySQLOKBody add proxy SQL OK body swagger:model AddProxySQLOKBody

func (*AddProxySQLOKBody) MarshalBinary

func (o *AddProxySQLOKBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AddProxySQLOKBody) UnmarshalBinary

func (o *AddProxySQLOKBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AddProxySQLOKBody) Validate

func (o *AddProxySQLOKBody) Validate(formats strfmt.Registry) error

Validate validates this add proxy SQL OK body

type AddProxySQLOKBodyProxysqlExporter

type AddProxySQLOKBodyProxysqlExporter struct {

	// Unique randomly generated instance identifier.
	AgentID string `json:"agent_id,omitempty"`

	// The pmm-agent identifier which runs this instance.
	PMMAgentID string `json:"pmm_agent_id,omitempty"`

	// Desired Agent status: enabled (false) or disabled (true).
	Disabled bool `json:"disabled,omitempty"`

	// Service identifier.
	ServiceID string `json:"service_id,omitempty"`

	// ProxySQL username for scraping metrics.
	Username string `json:"username,omitempty"`

	// Use TLS for database connections.
	TLS bool `json:"tls,omitempty"`

	// Skip TLS certificate and hostname validation.
	TLSSkipVerify bool `json:"tls_skip_verify,omitempty"`

	// Custom user-assigned labels.
	CustomLabels map[string]string `json:"custom_labels,omitempty"`

	// True if exporter uses push metrics mode.
	PushMetricsEnabled bool `json:"push_metrics_enabled,omitempty"`

	// List of disabled collector names.
	DisabledCollectors []string `json:"disabled_collectors"`

	// AgentStatus represents actual Agent status.
	//
	//  - STARTING: Agent is starting.
	//  - RUNNING: Agent is running.
	//  - WAITING: Agent encountered error and will be restarted automatically soon.
	//  - STOPPING: Agent is stopping.
	//  - DONE: Agent finished.
	// Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE]
	Status *string `json:"status,omitempty"`

	// Listen port for scraping metrics.
	ListenPort int64 `json:"listen_port,omitempty"`
}

AddProxySQLOKBodyProxysqlExporter ProxySQLExporter runs on Generic or Container Node and exposes ProxySQL Service metrics. swagger:model AddProxySQLOKBodyProxysqlExporter

func (*AddProxySQLOKBodyProxysqlExporter) MarshalBinary

func (o *AddProxySQLOKBodyProxysqlExporter) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AddProxySQLOKBodyProxysqlExporter) UnmarshalBinary

func (o *AddProxySQLOKBodyProxysqlExporter) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AddProxySQLOKBodyProxysqlExporter) Validate

Validate validates this add proxy SQL OK body proxysql exporter

type AddProxySQLOKBodyService

type AddProxySQLOKBodyService struct {

	// Unique randomly generated instance identifier.
	ServiceID string `json:"service_id,omitempty"`

	// Unique across all Services user-defined name.
	ServiceName string `json:"service_name,omitempty"`

	// Node identifier where this instance runs.
	NodeID string `json:"node_id,omitempty"`

	// Access address (DNS name or IP).
	// Address (and port) or socket is required.
	Address string `json:"address,omitempty"`

	// Access port.
	// Port is required when the address present.
	Port int64 `json:"port,omitempty"`

	// Access unix socket.
	// Address (and port) or socket is required.
	Socket string `json:"socket,omitempty"`

	// Environment name.
	Environment string `json:"environment,omitempty"`

	// Cluster name.
	Cluster string `json:"cluster,omitempty"`

	// Replication set name.
	ReplicationSet string `json:"replication_set,omitempty"`

	// Custom user-assigned labels.
	CustomLabels map[string]string `json:"custom_labels,omitempty"`
}

AddProxySQLOKBodyService ProxySQLService represents a generic ProxySQL instance. swagger:model AddProxySQLOKBodyService

func (*AddProxySQLOKBodyService) MarshalBinary

func (o *AddProxySQLOKBodyService) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AddProxySQLOKBodyService) UnmarshalBinary

func (o *AddProxySQLOKBodyService) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AddProxySQLOKBodyService) Validate

func (o *AddProxySQLOKBodyService) Validate(formats strfmt.Registry) error

Validate validates this add proxy SQL OK body service

type AddProxySQLParams

type AddProxySQLParams struct {

	/*Body*/
	Body AddProxySQLBody

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

AddProxySQLParams contains all the parameters to send to the API endpoint for the add proxy SQL operation typically these are written to a http.Request

func NewAddProxySQLParams

func NewAddProxySQLParams() *AddProxySQLParams

NewAddProxySQLParams creates a new AddProxySQLParams object with the default values initialized.

func NewAddProxySQLParamsWithContext

func NewAddProxySQLParamsWithContext(ctx context.Context) *AddProxySQLParams

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

func NewAddProxySQLParamsWithHTTPClient

func NewAddProxySQLParamsWithHTTPClient(client *http.Client) *AddProxySQLParams

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

func NewAddProxySQLParamsWithTimeout

func NewAddProxySQLParamsWithTimeout(timeout time.Duration) *AddProxySQLParams

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

func (*AddProxySQLParams) SetBody

func (o *AddProxySQLParams) SetBody(body AddProxySQLBody)

SetBody adds the body to the add proxy SQL params

func (*AddProxySQLParams) SetContext

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

SetContext adds the context to the add proxy SQL params

func (*AddProxySQLParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the add proxy SQL params

func (*AddProxySQLParams) SetTimeout

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

SetTimeout adds the timeout to the add proxy SQL params

func (*AddProxySQLParams) WithBody

WithBody adds the body to the add proxy SQL params

func (*AddProxySQLParams) WithContext

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

WithContext adds the context to the add proxy SQL params

func (*AddProxySQLParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the add proxy SQL params

func (*AddProxySQLParams) WithTimeout

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

WithTimeout adds the timeout to the add proxy SQL params

func (*AddProxySQLParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type AddProxySQLParamsBodyAddNode

type AddProxySQLParamsBodyAddNode struct {

	// NodeType describes supported Node types.
	// Enum: [NODE_TYPE_INVALID GENERIC_NODE CONTAINER_NODE REMOTE_NODE REMOTE_RDS_NODE REMOTE_AZURE_DATABASE_NODE]
	NodeType *string `json:"node_type,omitempty"`

	// Unique across all Nodes user-defined name.
	NodeName string `json:"node_name,omitempty"`

	// Linux machine-id.
	MachineID string `json:"machine_id,omitempty"`

	// Linux distribution name and version.
	Distro string `json:"distro,omitempty"`

	// Container identifier. If specified, must be a unique Docker container identifier.
	ContainerID string `json:"container_id,omitempty"`

	// Container name.
	ContainerName string `json:"container_name,omitempty"`

	// Node model.
	NodeModel string `json:"node_model,omitempty"`

	// Node region.
	Region string `json:"region,omitempty"`

	// Node availability zone.
	Az string `json:"az,omitempty"`

	// Custom user-assigned labels for Node.
	CustomLabels map[string]string `json:"custom_labels,omitempty"`
}

AddProxySQLParamsBodyAddNode AddNodeParams is a params to add new node to inventory while adding new service. swagger:model AddProxySQLParamsBodyAddNode

func (*AddProxySQLParamsBodyAddNode) MarshalBinary

func (o *AddProxySQLParamsBodyAddNode) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AddProxySQLParamsBodyAddNode) UnmarshalBinary

func (o *AddProxySQLParamsBodyAddNode) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AddProxySQLParamsBodyAddNode) Validate

func (o *AddProxySQLParamsBodyAddNode) Validate(formats strfmt.Registry) error

Validate validates this add proxy SQL params body add node

type AddProxySQLReader

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

AddProxySQLReader is a Reader for the AddProxySQL structure.

func (*AddProxySQLReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type Client

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

Client for proxy sql API

func (*Client) AddProxySQL

func (a *Client) AddProxySQL(params *AddProxySQLParams) (*AddProxySQLOK, error)

AddProxySQL adds proxy SQL adds proxy SQL service and starts several agents it automatically adds a service to inventory which is running on provided node id then adds proxysql exporter with provided pmm agent id and other parameters

func (*Client) SetTransport

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

SetTransport changes the transport on the client

type ClientService

type ClientService interface {
	AddProxySQL(params *AddProxySQLParams) (*AddProxySQLOK, 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 proxy sql API client.

type DetailsItems0

type DetailsItems0 struct {

	// A URL/resource name that uniquely identifies the type of the serialized
	// protocol buffer message. This string must contain at least
	// one "/" character. The last segment of the URL's path must represent
	// the fully qualified name of the type (as in
	// `path/google.protobuf.Duration`). The name should be in a canonical form
	// (e.g., leading "." is not accepted).
	//
	// In practice, teams usually precompile into the binary all types that they
	// expect it to use in the context of Any. However, for URLs which use the
	// scheme `http`, `https`, or no scheme, one can optionally set up a type
	// server that maps type URLs to message definitions as follows:
	//
	// * If no scheme is provided, `https` is assumed.
	// * An HTTP GET on the URL must yield a [google.protobuf.Type][]
	//   value in binary format, or produce an error.
	// * Applications are allowed to cache lookup results based on the
	//   URL, or have them precompiled into a binary to avoid any
	//   lookup. Therefore, binary compatibility needs to be preserved
	//   on changes to types. (Use versioned type names to manage
	//   breaking changes.)
	//
	// Note: this functionality is not currently available in the official
	// protobuf release, and it is not used for type URLs beginning with
	// type.googleapis.com.
	//
	// Schemes other than `http`, `https` (or the empty scheme) might be
	// used with implementation specific semantics.
	TypeURL string `json:"type_url,omitempty"`

	// Must be a valid serialized protocol buffer of the above specified type.
	// Format: byte
	Value strfmt.Base64 `json:"value,omitempty"`
}

DetailsItems0 `Any` contains an arbitrary serialized protocol buffer message along with a // URL that describes the type of the serialized message. // // Protobuf library provides support to pack/unpack Any values in the form // of utility functions or additional generated methods of the Any type. // // Example 1: Pack and unpack a message in C++. // // Foo foo = ...; // Any any; // any.PackFrom(foo); // ... // if (any.UnpackTo(&foo)) { // ... // } // // Example 2: Pack and unpack a message in Java. // // Foo foo = ...; // Any any = Any.pack(foo); // ... // if (any.is(Foo.class)) { // foo = any.unpack(Foo.class); // } // // Example 3: Pack and unpack a message in Python. // // foo = Foo(...) // any = Any() // any.Pack(foo) // ... // if any.Is(Foo.DESCRIPTOR): // any.Unpack(foo) // ... // // Example 4: Pack and unpack a message in Go // // foo := &pb.Foo{...} // any, err := ptypes.MarshalAny(foo) // ... // foo := &pb.Foo{} // if err := ptypes.UnmarshalAny(any, foo); err != nil { // ... // } // // The pack methods provided by protobuf library will by default use // 'type.googleapis.com/full.type.name' as the type URL and the unpack // methods only use the fully qualified type name after the last '/' // in the type URL, for example "foo.bar.com/x/y.z" will yield type // name "y.z". // // // JSON // ==== // The JSON representation of an `Any` value uses the regular // representation of the deserialized, embedded message, with an // additional field `@type` which contains the type URL. Example: // // package google.profile; // message Person { // string first_name = 1; // string last_name = 2; // } // // { // "@type": "type.googleapis.com/google.profile.Person", // "firstName": <string>, // "lastName": <string> // } // // If the embedded message type is well-known and has a custom JSON // representation, that representation will be embedded adding a field // `value` which holds the custom JSON in addition to the `@type` // field. Example (for message [google.protobuf.Duration][]): // // { // "@type": "type.googleapis.com/google.protobuf.Duration", // "value": "1.212s" // } swagger:model DetailsItems0

func (*DetailsItems0) MarshalBinary

func (o *DetailsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DetailsItems0) UnmarshalBinary

func (o *DetailsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DetailsItems0) Validate

func (o *DetailsItems0) Validate(formats strfmt.Registry) error

Validate validates this details items0

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL