Documentation
¶
Index ¶
- Constants
- type AddProxySQLBody
- type AddProxySQLDefault
- type AddProxySQLDefaultBody
- type AddProxySQLOK
- type AddProxySQLOKBody
- type AddProxySQLOKBodyProxysqlExporter
- type AddProxySQLOKBodyService
- type AddProxySQLParams
- func (o *AddProxySQLParams) SetBody(body AddProxySQLBody)
- func (o *AddProxySQLParams) SetContext(ctx context.Context)
- func (o *AddProxySQLParams) SetHTTPClient(client *http.Client)
- func (o *AddProxySQLParams) SetTimeout(timeout time.Duration)
- func (o *AddProxySQLParams) WithBody(body AddProxySQLBody) *AddProxySQLParams
- func (o *AddProxySQLParams) WithContext(ctx context.Context) *AddProxySQLParams
- func (o *AddProxySQLParams) WithHTTPClient(client *http.Client) *AddProxySQLParams
- func (o *AddProxySQLParams) WithTimeout(timeout time.Duration) *AddProxySQLParams
- func (o *AddProxySQLParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type AddProxySQLParamsBodyAddNode
- type AddProxySQLReader
- type Client
Constants ¶
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" )
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" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddProxySQLBody ¶
type AddProxySQLBody struct {
// add node
AddNode *AddProxySQLParamsBodyAddNode `json:"add_node,omitempty"`
// Node and Service access address (DNS name or IP). Required.
Address string `json:"address,omitempty"`
// Cluster name.
Cluster string `json:"cluster,omitempty"`
// custom labels
CustomLabels map[string]string `json:"custom_labels,omitempty"`
// Environment name.
Environment string `json:"environment,omitempty"`
// 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"`
// ProxySQL password for scraping metrics.
Password string `json:"password,omitempty"`
// The "pmm-agent" identifier which should run agents. Required.
PMMAgentID string `json:"pmm_agent_id,omitempty"`
// Service Access port. Required.
Port int64 `json:"port,omitempty"`
// Replication set name.
ReplicationSet string `json:"replication_set,omitempty"`
// Unique across all Services user-defined name. Required.
ServiceName string `json:"service_name,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"`
// ProxySQL username for scraping metrics.
Username string `json:"username,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
type AddProxySQLDefault ¶
type AddProxySQLDefault struct {
Payload *AddProxySQLDefaultBody
// contains filtered or unexported fields
}
AddProxySQLDefault handles this case with default header values.
An 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 {
// code
Code int32 `json:"code,omitempty"`
// error
Error string `json:"error,omitempty"`
// message
Message string `json:"message,omitempty"`
}
AddProxySQLDefaultBody ErrorResponse is a message returned on HTTP error. 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
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
type AddProxySQLOKBodyProxysqlExporter ¶
type AddProxySQLOKBodyProxysqlExporter struct {
// Unique randomly generated instance identifier.
AgentID string `json:"agent_id,omitempty"`
// Custom user-assigned labels.
CustomLabels map[string]string `json:"custom_labels,omitempty"`
// Desired Agent status: enabled (false) or disabled (true).
Disabled bool `json:"disabled,omitempty"`
// Listen port for scraping metrics.
ListenPort int64 `json:"listen_port,omitempty"`
// The pmm-agent identifier which runs this instance.
PMMAgentID string `json:"pmm_agent_id,omitempty"`
// Service identifier.
ServiceID string `json:"service_id,omitempty"`
// 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"`
// Use TLS for database connections.
TLS bool `json:"tls,omitempty"`
// Skip TLS certificate and hostname validation.
TLSSkipVerify bool `json:"tls_skip_verify,omitempty"`
// ProxySQL username for scraping metrics.
Username string `json:"username,omitempty"`
}
AddProxySQLOKBodyProxysqlExporter ProxySQLExporter runs on Generic or Container Node and exposes MySQL 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
type AddProxySQLOKBodyService ¶
type AddProxySQLOKBodyService struct {
// Access address (DNS name or IP).
Address string `json:"address,omitempty"`
// Cluster name.
Cluster string `json:"cluster,omitempty"`
// Custom user-assigned labels.
CustomLabels map[string]string `json:"custom_labels,omitempty"`
// Environment name.
Environment string `json:"environment,omitempty"`
// Node identifier where this instance runs.
NodeID string `json:"node_id,omitempty"`
// Access port.
Port int64 `json:"port,omitempty"`
// Replication set name.
ReplicationSet string `json:"replication_set,omitempty"`
// Unique randomly generated instance identifier.
ServiceID string `json:"service_id,omitempty"`
// Unique across all Services user-defined name.
ServiceName string `json:"service_name,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
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 ¶
func (o *AddProxySQLParams) WithBody(body AddProxySQLBody) *AddProxySQLParams
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 {
// Node availability zone.
Az string `json:"az,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"`
// Custom user-assigned labels.
CustomLabels map[string]string `json:"custom_labels,omitempty"`
// Linux distribution name and version.
Distro string `json:"distro,omitempty"`
// Linux machine-id.
MachineID string `json:"machine_id,omitempty"`
// Node model.
NodeModel string `json:"node_model,omitempty"`
// Unique across all Nodes user-defined name.
NodeName string `json:"node_name,omitempty"`
// NodeType describes supported Node types.
// Enum: [NODE_TYPE_INVALID GENERIC_NODE CONTAINER_NODE REMOTE_NODE]
NodeType *string `json:"node_type,omitempty"`
// Node region.
Region string `json:"region,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
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 New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client
New creates a new proxy sql API client.
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