Documentation
¶
Index ¶
- Constants
- type AddPostgreSQLBody
- type AddPostgreSQLDefault
- type AddPostgreSQLDefaultBody
- type AddPostgreSQLOK
- type AddPostgreSQLOKBody
- type AddPostgreSQLOKBodyPostgresExporter
- type AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgent
- type AddPostgreSQLOKBodyService
- type AddPostgreSQLParams
- func (o *AddPostgreSQLParams) SetBody(body AddPostgreSQLBody)
- func (o *AddPostgreSQLParams) SetContext(ctx context.Context)
- func (o *AddPostgreSQLParams) SetHTTPClient(client *http.Client)
- func (o *AddPostgreSQLParams) SetTimeout(timeout time.Duration)
- func (o *AddPostgreSQLParams) WithBody(body AddPostgreSQLBody) *AddPostgreSQLParams
- func (o *AddPostgreSQLParams) WithContext(ctx context.Context) *AddPostgreSQLParams
- func (o *AddPostgreSQLParams) WithHTTPClient(client *http.Client) *AddPostgreSQLParams
- func (o *AddPostgreSQLParams) WithTimeout(timeout time.Duration) *AddPostgreSQLParams
- func (o *AddPostgreSQLParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type AddPostgreSQLParamsBodyAddNode
- type AddPostgreSQLReader
- type Client
Constants ¶
const ( // AddPostgreSQLOKBodyPostgresExporterStatusAGENTSTATUSINVALID captures enum value "AGENT_STATUS_INVALID" AddPostgreSQLOKBodyPostgresExporterStatusAGENTSTATUSINVALID string = "AGENT_STATUS_INVALID" // AddPostgreSQLOKBodyPostgresExporterStatusSTARTING captures enum value "STARTING" AddPostgreSQLOKBodyPostgresExporterStatusSTARTING string = "STARTING" // AddPostgreSQLOKBodyPostgresExporterStatusRUNNING captures enum value "RUNNING" AddPostgreSQLOKBodyPostgresExporterStatusRUNNING string = "RUNNING" // AddPostgreSQLOKBodyPostgresExporterStatusWAITING captures enum value "WAITING" AddPostgreSQLOKBodyPostgresExporterStatusWAITING string = "WAITING" // AddPostgreSQLOKBodyPostgresExporterStatusSTOPPING captures enum value "STOPPING" AddPostgreSQLOKBodyPostgresExporterStatusSTOPPING string = "STOPPING" // AddPostgreSQLOKBodyPostgresExporterStatusDONE captures enum value "DONE" AddPostgreSQLOKBodyPostgresExporterStatusDONE string = "DONE" )
const ( // AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgentStatusAGENTSTATUSINVALID captures enum value "AGENT_STATUS_INVALID" AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgentStatusAGENTSTATUSINVALID string = "AGENT_STATUS_INVALID" // AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgentStatusSTARTING captures enum value "STARTING" AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgentStatusSTARTING string = "STARTING" // AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgentStatusRUNNING captures enum value "RUNNING" AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgentStatusRUNNING string = "RUNNING" // AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgentStatusWAITING captures enum value "WAITING" AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgentStatusWAITING string = "WAITING" // AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgentStatusSTOPPING captures enum value "STOPPING" AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgentStatusSTOPPING string = "STOPPING" // AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgentStatusDONE captures enum value "DONE" AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgentStatusDONE string = "DONE" )
const ( // AddPostgreSQLParamsBodyAddNodeNodeTypeNODETYPEINVALID captures enum value "NODE_TYPE_INVALID" AddPostgreSQLParamsBodyAddNodeNodeTypeNODETYPEINVALID string = "NODE_TYPE_INVALID" // AddPostgreSQLParamsBodyAddNodeNodeTypeGENERICNODE captures enum value "GENERIC_NODE" AddPostgreSQLParamsBodyAddNodeNodeTypeGENERICNODE string = "GENERIC_NODE" // AddPostgreSQLParamsBodyAddNodeNodeTypeCONTAINERNODE captures enum value "CONTAINER_NODE" AddPostgreSQLParamsBodyAddNodeNodeTypeCONTAINERNODE string = "CONTAINER_NODE" // AddPostgreSQLParamsBodyAddNodeNodeTypeREMOTENODE captures enum value "REMOTE_NODE" AddPostgreSQLParamsBodyAddNodeNodeTypeREMOTENODE string = "REMOTE_NODE" // AddPostgreSQLParamsBodyAddNodeNodeTypeREMOTERDSNODE captures enum value "REMOTE_RDS_NODE" AddPostgreSQLParamsBodyAddNodeNodeTypeREMOTERDSNODE string = "REMOTE_RDS_NODE" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddPostgreSQLBody ¶
type AddPostgreSQLBody 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). Required.
Address string `json:"address,omitempty"`
// Service Access port. Required.
Port int64 `json:"port,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"`
// PostgreSQL username for scraping metrics.
Username string `json:"username,omitempty"`
// PostgreSQL password for scraping metrics.
Password string `json:"password,omitempty"`
// If true, adds qan-postgresql-pgstatements-agent for provided service.
QANPostgresqlPgstatementsAgent bool `json:"qan_postgresql_pgstatements_agent,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. Uses sslmode=required instead of verify-full.
TLSSkipVerify bool `json:"tls_skip_verify,omitempty"`
// add node
AddNode *AddPostgreSQLParamsBodyAddNode `json:"add_node,omitempty"`
}
AddPostgreSQLBody add postgre SQL body swagger:model AddPostgreSQLBody
func (*AddPostgreSQLBody) MarshalBinary ¶
func (o *AddPostgreSQLBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddPostgreSQLBody) UnmarshalBinary ¶
func (o *AddPostgreSQLBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddPostgreSQLDefault ¶
type AddPostgreSQLDefault struct {
Payload *AddPostgreSQLDefaultBody
// contains filtered or unexported fields
}
AddPostgreSQLDefault handles this case with default header values.
An error response.
func NewAddPostgreSQLDefault ¶
func NewAddPostgreSQLDefault(code int) *AddPostgreSQLDefault
NewAddPostgreSQLDefault creates a AddPostgreSQLDefault with default headers values
func (*AddPostgreSQLDefault) Code ¶
func (o *AddPostgreSQLDefault) Code() int
Code gets the status code for the add postgre SQL default response
func (*AddPostgreSQLDefault) Error ¶
func (o *AddPostgreSQLDefault) Error() string
func (*AddPostgreSQLDefault) GetPayload ¶
func (o *AddPostgreSQLDefault) GetPayload() *AddPostgreSQLDefaultBody
type AddPostgreSQLDefaultBody ¶
type AddPostgreSQLDefaultBody struct {
// code
Code int32 `json:"code,omitempty"`
// error
Error string `json:"error,omitempty"`
// message
Message string `json:"message,omitempty"`
}
AddPostgreSQLDefaultBody ErrorResponse is a message returned on HTTP error. swagger:model AddPostgreSQLDefaultBody
func (*AddPostgreSQLDefaultBody) MarshalBinary ¶
func (o *AddPostgreSQLDefaultBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddPostgreSQLDefaultBody) UnmarshalBinary ¶
func (o *AddPostgreSQLDefaultBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddPostgreSQLOK ¶
type AddPostgreSQLOK struct {
Payload *AddPostgreSQLOKBody
}
AddPostgreSQLOK handles this case with default header values.
A successful response.
func NewAddPostgreSQLOK ¶
func NewAddPostgreSQLOK() *AddPostgreSQLOK
NewAddPostgreSQLOK creates a AddPostgreSQLOK with default headers values
func (*AddPostgreSQLOK) Error ¶
func (o *AddPostgreSQLOK) Error() string
func (*AddPostgreSQLOK) GetPayload ¶
func (o *AddPostgreSQLOK) GetPayload() *AddPostgreSQLOKBody
type AddPostgreSQLOKBody ¶
type AddPostgreSQLOKBody struct {
// postgres exporter
PostgresExporter *AddPostgreSQLOKBodyPostgresExporter `json:"postgres_exporter,omitempty"`
// qan postgresql pgstatements agent
QANPostgresqlPgstatementsAgent *AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgent `json:"qan_postgresql_pgstatements_agent,omitempty"`
// service
Service *AddPostgreSQLOKBodyService `json:"service,omitempty"`
}
AddPostgreSQLOKBody add postgre SQL OK body swagger:model AddPostgreSQLOKBody
func (*AddPostgreSQLOKBody) MarshalBinary ¶
func (o *AddPostgreSQLOKBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddPostgreSQLOKBody) UnmarshalBinary ¶
func (o *AddPostgreSQLOKBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddPostgreSQLOKBodyPostgresExporter ¶
type AddPostgreSQLOKBodyPostgresExporter 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"`
// PostgreSQL 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. Uses sslmode=required instead of verify-full.
TLSSkipVerify bool `json:"tls_skip_verify,omitempty"`
// Custom user-assigned labels.
CustomLabels map[string]string `json:"custom_labels,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"`
// Listen port for scraping metrics.
ListenPort int64 `json:"listen_port,omitempty"`
}
AddPostgreSQLOKBodyPostgresExporter PostgresExporter runs on Generic or Container Node and exposes PostgreSQL Service metrics. swagger:model AddPostgreSQLOKBodyPostgresExporter
func (*AddPostgreSQLOKBodyPostgresExporter) MarshalBinary ¶
func (o *AddPostgreSQLOKBodyPostgresExporter) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddPostgreSQLOKBodyPostgresExporter) UnmarshalBinary ¶
func (o *AddPostgreSQLOKBodyPostgresExporter) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgent ¶
type AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgent 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"`
// PostgreSQL username for getting pg stat statements data.
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"`
// 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"`
}
AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgent QANPostgreSQLPgStatementsAgent runs within pmm-agent and sends PostgreSQL Query Analytics data to the PMM Server. swagger:model AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgent
func (*AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgent) MarshalBinary ¶
func (o *AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgent) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgent) UnmarshalBinary ¶
func (o *AddPostgreSQLOKBodyQANPostgresqlPgstatementsAgent) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddPostgreSQLOKBodyService ¶
type AddPostgreSQLOKBodyService 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 string `json:"address,omitempty"`
// Access port.
Port int64 `json:"port,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"`
}
AddPostgreSQLOKBodyService PostgreSQLService represents a generic PostgreSQL instance. swagger:model AddPostgreSQLOKBodyService
func (*AddPostgreSQLOKBodyService) MarshalBinary ¶
func (o *AddPostgreSQLOKBodyService) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddPostgreSQLOKBodyService) UnmarshalBinary ¶
func (o *AddPostgreSQLOKBodyService) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddPostgreSQLParams ¶
type AddPostgreSQLParams struct {
/*Body*/
Body AddPostgreSQLBody
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
AddPostgreSQLParams contains all the parameters to send to the API endpoint for the add postgre SQL operation typically these are written to a http.Request
func NewAddPostgreSQLParams ¶
func NewAddPostgreSQLParams() *AddPostgreSQLParams
NewAddPostgreSQLParams creates a new AddPostgreSQLParams object with the default values initialized.
func NewAddPostgreSQLParamsWithContext ¶
func NewAddPostgreSQLParamsWithContext(ctx context.Context) *AddPostgreSQLParams
NewAddPostgreSQLParamsWithContext creates a new AddPostgreSQLParams object with the default values initialized, and the ability to set a context for a request
func NewAddPostgreSQLParamsWithHTTPClient ¶
func NewAddPostgreSQLParamsWithHTTPClient(client *http.Client) *AddPostgreSQLParams
NewAddPostgreSQLParamsWithHTTPClient creates a new AddPostgreSQLParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewAddPostgreSQLParamsWithTimeout ¶
func NewAddPostgreSQLParamsWithTimeout(timeout time.Duration) *AddPostgreSQLParams
NewAddPostgreSQLParamsWithTimeout creates a new AddPostgreSQLParams object with the default values initialized, and the ability to set a timeout on a request
func (*AddPostgreSQLParams) SetBody ¶
func (o *AddPostgreSQLParams) SetBody(body AddPostgreSQLBody)
SetBody adds the body to the add postgre SQL params
func (*AddPostgreSQLParams) SetContext ¶
func (o *AddPostgreSQLParams) SetContext(ctx context.Context)
SetContext adds the context to the add postgre SQL params
func (*AddPostgreSQLParams) SetHTTPClient ¶
func (o *AddPostgreSQLParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the add postgre SQL params
func (*AddPostgreSQLParams) SetTimeout ¶
func (o *AddPostgreSQLParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the add postgre SQL params
func (*AddPostgreSQLParams) WithBody ¶
func (o *AddPostgreSQLParams) WithBody(body AddPostgreSQLBody) *AddPostgreSQLParams
WithBody adds the body to the add postgre SQL params
func (*AddPostgreSQLParams) WithContext ¶
func (o *AddPostgreSQLParams) WithContext(ctx context.Context) *AddPostgreSQLParams
WithContext adds the context to the add postgre SQL params
func (*AddPostgreSQLParams) WithHTTPClient ¶
func (o *AddPostgreSQLParams) WithHTTPClient(client *http.Client) *AddPostgreSQLParams
WithHTTPClient adds the HTTPClient to the add postgre SQL params
func (*AddPostgreSQLParams) WithTimeout ¶
func (o *AddPostgreSQLParams) WithTimeout(timeout time.Duration) *AddPostgreSQLParams
WithTimeout adds the timeout to the add postgre SQL params
func (*AddPostgreSQLParams) WriteToRequest ¶
func (o *AddPostgreSQLParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type AddPostgreSQLParamsBodyAddNode ¶
type AddPostgreSQLParamsBodyAddNode struct {
// NodeType describes supported Node types.
// Enum: [NODE_TYPE_INVALID GENERIC_NODE CONTAINER_NODE REMOTE_NODE REMOTE_RDS_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"`
}
AddPostgreSQLParamsBodyAddNode AddNodeParams is a params to add new node to inventory while adding new service. swagger:model AddPostgreSQLParamsBodyAddNode
func (*AddPostgreSQLParamsBodyAddNode) MarshalBinary ¶
func (o *AddPostgreSQLParamsBodyAddNode) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddPostgreSQLParamsBodyAddNode) UnmarshalBinary ¶
func (o *AddPostgreSQLParamsBodyAddNode) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddPostgreSQLReader ¶
type AddPostgreSQLReader struct {
// contains filtered or unexported fields
}
AddPostgreSQLReader is a Reader for the AddPostgreSQL structure.
func (*AddPostgreSQLReader) ReadResponse ¶
func (o *AddPostgreSQLReader) 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 postgre sql API
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client
New creates a new postgre sql API client.
func (*Client) AddPostgreSQL ¶
func (a *Client) AddPostgreSQL(params *AddPostgreSQLParams) (*AddPostgreSQLOK, error)
AddPostgreSQL adds postgre SQL adds postgre SQL service and starts postgres exporter it automatically adds a service to inventory which is running on provided node id then adds postgres 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