Documentation ¶
Index ¶
- Constants
- type AddMongoDBBody
- type AddMongoDBDefault
- type AddMongoDBDefaultBody
- type AddMongoDBOK
- type AddMongoDBOKBody
- type AddMongoDBOKBodyMongodbExporter
- type AddMongoDBOKBodyQANMongodbProfiler
- type AddMongoDBOKBodyService
- type AddMongoDBParams
- func (o *AddMongoDBParams) SetBody(body AddMongoDBBody)
- func (o *AddMongoDBParams) SetContext(ctx context.Context)
- func (o *AddMongoDBParams) SetHTTPClient(client *http.Client)
- func (o *AddMongoDBParams) SetTimeout(timeout time.Duration)
- func (o *AddMongoDBParams) WithBody(body AddMongoDBBody) *AddMongoDBParams
- func (o *AddMongoDBParams) WithContext(ctx context.Context) *AddMongoDBParams
- func (o *AddMongoDBParams) WithHTTPClient(client *http.Client) *AddMongoDBParams
- func (o *AddMongoDBParams) WithTimeout(timeout time.Duration) *AddMongoDBParams
- func (o *AddMongoDBParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type AddMongoDBParamsBodyAddNode
- type AddMongoDBReader
- type Client
Constants ¶
const ( // AddMongoDBOKBodyMongodbExporterStatusAGENTSTATUSINVALID captures enum value "AGENT_STATUS_INVALID" AddMongoDBOKBodyMongodbExporterStatusAGENTSTATUSINVALID string = "AGENT_STATUS_INVALID" // AddMongoDBOKBodyMongodbExporterStatusSTARTING captures enum value "STARTING" AddMongoDBOKBodyMongodbExporterStatusSTARTING string = "STARTING" // AddMongoDBOKBodyMongodbExporterStatusRUNNING captures enum value "RUNNING" AddMongoDBOKBodyMongodbExporterStatusRUNNING string = "RUNNING" // AddMongoDBOKBodyMongodbExporterStatusWAITING captures enum value "WAITING" AddMongoDBOKBodyMongodbExporterStatusWAITING string = "WAITING" // AddMongoDBOKBodyMongodbExporterStatusSTOPPING captures enum value "STOPPING" AddMongoDBOKBodyMongodbExporterStatusSTOPPING string = "STOPPING" // AddMongoDBOKBodyMongodbExporterStatusDONE captures enum value "DONE" AddMongoDBOKBodyMongodbExporterStatusDONE string = "DONE" )
const ( // AddMongoDBOKBodyQANMongodbProfilerStatusAGENTSTATUSINVALID captures enum value "AGENT_STATUS_INVALID" AddMongoDBOKBodyQANMongodbProfilerStatusAGENTSTATUSINVALID string = "AGENT_STATUS_INVALID" // AddMongoDBOKBodyQANMongodbProfilerStatusSTARTING captures enum value "STARTING" AddMongoDBOKBodyQANMongodbProfilerStatusSTARTING string = "STARTING" // AddMongoDBOKBodyQANMongodbProfilerStatusRUNNING captures enum value "RUNNING" AddMongoDBOKBodyQANMongodbProfilerStatusRUNNING string = "RUNNING" // AddMongoDBOKBodyQANMongodbProfilerStatusWAITING captures enum value "WAITING" AddMongoDBOKBodyQANMongodbProfilerStatusWAITING string = "WAITING" // AddMongoDBOKBodyQANMongodbProfilerStatusSTOPPING captures enum value "STOPPING" AddMongoDBOKBodyQANMongodbProfilerStatusSTOPPING string = "STOPPING" // AddMongoDBOKBodyQANMongodbProfilerStatusDONE captures enum value "DONE" AddMongoDBOKBodyQANMongodbProfilerStatusDONE string = "DONE" )
const ( // AddMongoDBParamsBodyAddNodeNodeTypeNODETYPEINVALID captures enum value "NODE_TYPE_INVALID" AddMongoDBParamsBodyAddNodeNodeTypeNODETYPEINVALID string = "NODE_TYPE_INVALID" // AddMongoDBParamsBodyAddNodeNodeTypeGENERICNODE captures enum value "GENERIC_NODE" AddMongoDBParamsBodyAddNodeNodeTypeGENERICNODE string = "GENERIC_NODE" // AddMongoDBParamsBodyAddNodeNodeTypeCONTAINERNODE captures enum value "CONTAINER_NODE" AddMongoDBParamsBodyAddNodeNodeTypeCONTAINERNODE string = "CONTAINER_NODE" // AddMongoDBParamsBodyAddNodeNodeTypeREMOTENODE captures enum value "REMOTE_NODE" AddMongoDBParamsBodyAddNodeNodeTypeREMOTENODE string = "REMOTE_NODE" // AddMongoDBParamsBodyAddNodeNodeTypeREMOTEAMAZONRDSNODE captures enum value "REMOTE_AMAZON_RDS_NODE" AddMongoDBParamsBodyAddNodeNodeTypeREMOTEAMAZONRDSNODE string = "REMOTE_AMAZON_RDS_NODE" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddMongoDBBody ¶
type AddMongoDBBody struct { // add node AddNode *AddMongoDBParamsBodyAddNode `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 user-assigned 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"` // MongoDB password for exporter and QAN agent access. 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"` // If true, adds qan-mongodb-profiler-agent for provided service. QANMongodbProfiler bool `json:"qan_mongodb_profiler,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"` // MongoDB username for exporter and QAN agent access. Username string `json:"username,omitempty"` }
AddMongoDBBody add mongo DB body swagger:model AddMongoDBBody
func (*AddMongoDBBody) MarshalBinary ¶
func (o *AddMongoDBBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddMongoDBBody) UnmarshalBinary ¶
func (o *AddMongoDBBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddMongoDBDefault ¶
type AddMongoDBDefault struct { Payload *AddMongoDBDefaultBody // contains filtered or unexported fields }
AddMongoDBDefault handles this case with default header values.
An error response.
func NewAddMongoDBDefault ¶
func NewAddMongoDBDefault(code int) *AddMongoDBDefault
NewAddMongoDBDefault creates a AddMongoDBDefault with default headers values
func (*AddMongoDBDefault) Code ¶
func (o *AddMongoDBDefault) Code() int
Code gets the status code for the add mongo DB default response
func (*AddMongoDBDefault) Error ¶
func (o *AddMongoDBDefault) Error() string
func (*AddMongoDBDefault) GetPayload ¶
func (o *AddMongoDBDefault) GetPayload() *AddMongoDBDefaultBody
type AddMongoDBDefaultBody ¶
type AddMongoDBDefaultBody struct { // code Code int32 `json:"code,omitempty"` // error Error string `json:"error,omitempty"` // message Message string `json:"message,omitempty"` }
AddMongoDBDefaultBody ErrorResponse is a message returned on HTTP error. swagger:model AddMongoDBDefaultBody
func (*AddMongoDBDefaultBody) MarshalBinary ¶
func (o *AddMongoDBDefaultBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddMongoDBDefaultBody) UnmarshalBinary ¶
func (o *AddMongoDBDefaultBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddMongoDBOK ¶
type AddMongoDBOK struct {
Payload *AddMongoDBOKBody
}
AddMongoDBOK handles this case with default header values.
A successful response.
func NewAddMongoDBOK ¶
func NewAddMongoDBOK() *AddMongoDBOK
NewAddMongoDBOK creates a AddMongoDBOK with default headers values
func (*AddMongoDBOK) Error ¶
func (o *AddMongoDBOK) Error() string
func (*AddMongoDBOK) GetPayload ¶
func (o *AddMongoDBOK) GetPayload() *AddMongoDBOKBody
type AddMongoDBOKBody ¶
type AddMongoDBOKBody struct { // mongodb exporter MongodbExporter *AddMongoDBOKBodyMongodbExporter `json:"mongodb_exporter,omitempty"` // qan mongodb profiler QANMongodbProfiler *AddMongoDBOKBodyQANMongodbProfiler `json:"qan_mongodb_profiler,omitempty"` // service Service *AddMongoDBOKBodyService `json:"service,omitempty"` }
AddMongoDBOKBody add mongo DB OK body swagger:model AddMongoDBOKBody
func (*AddMongoDBOKBody) MarshalBinary ¶
func (o *AddMongoDBOKBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddMongoDBOKBody) UnmarshalBinary ¶
func (o *AddMongoDBOKBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddMongoDBOKBodyMongodbExporter ¶
type AddMongoDBOKBodyMongodbExporter 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"` // MongoDB password for scraping metrics. Password string `json:"password,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. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` // MongoDB username for scraping metrics. Username string `json:"username,omitempty"` }
AddMongoDBOKBodyMongodbExporter MongoDBExporter runs on Generic or Container Node and exposes MongoDB Service metrics. swagger:model AddMongoDBOKBodyMongodbExporter
func (*AddMongoDBOKBodyMongodbExporter) MarshalBinary ¶
func (o *AddMongoDBOKBodyMongodbExporter) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddMongoDBOKBodyMongodbExporter) UnmarshalBinary ¶
func (o *AddMongoDBOKBodyMongodbExporter) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddMongoDBOKBodyQANMongodbProfiler ¶
type AddMongoDBOKBodyQANMongodbProfiler 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"` // MongoDB password for getting profiler data. Password string `json:"password,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. // Enum: [AGENT_STATUS_INVALID STARTING RUNNING WAITING STOPPING DONE] Status *string `json:"status,omitempty"` // MongoDB username for getting profiler data. Username string `json:"username,omitempty"` }
AddMongoDBOKBodyQANMongodbProfiler QANMongoDBProfilerAgent runs within pmm-agent and sends MongoDB Query Analytics data to the PMM Server. swagger:model AddMongoDBOKBodyQANMongodbProfiler
func (*AddMongoDBOKBodyQANMongodbProfiler) MarshalBinary ¶
func (o *AddMongoDBOKBodyQANMongodbProfiler) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddMongoDBOKBodyQANMongodbProfiler) UnmarshalBinary ¶
func (o *AddMongoDBOKBodyQANMongodbProfiler) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddMongoDBOKBodyService ¶
type AddMongoDBOKBodyService 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"` }
AddMongoDBOKBodyService MongoDBService represents a generic MongoDB instance. swagger:model AddMongoDBOKBodyService
func (*AddMongoDBOKBodyService) MarshalBinary ¶
func (o *AddMongoDBOKBodyService) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddMongoDBOKBodyService) UnmarshalBinary ¶
func (o *AddMongoDBOKBodyService) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddMongoDBParams ¶
type AddMongoDBParams struct { /*Body*/ Body AddMongoDBBody Context context.Context HTTPClient *http.Client // contains filtered or unexported fields }
AddMongoDBParams contains all the parameters to send to the API endpoint for the add mongo DB operation typically these are written to a http.Request
func NewAddMongoDBParams ¶
func NewAddMongoDBParams() *AddMongoDBParams
NewAddMongoDBParams creates a new AddMongoDBParams object with the default values initialized.
func NewAddMongoDBParamsWithContext ¶
func NewAddMongoDBParamsWithContext(ctx context.Context) *AddMongoDBParams
NewAddMongoDBParamsWithContext creates a new AddMongoDBParams object with the default values initialized, and the ability to set a context for a request
func NewAddMongoDBParamsWithHTTPClient ¶
func NewAddMongoDBParamsWithHTTPClient(client *http.Client) *AddMongoDBParams
NewAddMongoDBParamsWithHTTPClient creates a new AddMongoDBParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewAddMongoDBParamsWithTimeout ¶
func NewAddMongoDBParamsWithTimeout(timeout time.Duration) *AddMongoDBParams
NewAddMongoDBParamsWithTimeout creates a new AddMongoDBParams object with the default values initialized, and the ability to set a timeout on a request
func (*AddMongoDBParams) SetBody ¶
func (o *AddMongoDBParams) SetBody(body AddMongoDBBody)
SetBody adds the body to the add mongo DB params
func (*AddMongoDBParams) SetContext ¶
func (o *AddMongoDBParams) SetContext(ctx context.Context)
SetContext adds the context to the add mongo DB params
func (*AddMongoDBParams) SetHTTPClient ¶
func (o *AddMongoDBParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the add mongo DB params
func (*AddMongoDBParams) SetTimeout ¶
func (o *AddMongoDBParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the add mongo DB params
func (*AddMongoDBParams) WithBody ¶
func (o *AddMongoDBParams) WithBody(body AddMongoDBBody) *AddMongoDBParams
WithBody adds the body to the add mongo DB params
func (*AddMongoDBParams) WithContext ¶
func (o *AddMongoDBParams) WithContext(ctx context.Context) *AddMongoDBParams
WithContext adds the context to the add mongo DB params
func (*AddMongoDBParams) WithHTTPClient ¶
func (o *AddMongoDBParams) WithHTTPClient(client *http.Client) *AddMongoDBParams
WithHTTPClient adds the HTTPClient to the add mongo DB params
func (*AddMongoDBParams) WithTimeout ¶
func (o *AddMongoDBParams) WithTimeout(timeout time.Duration) *AddMongoDBParams
WithTimeout adds the timeout to the add mongo DB params
func (*AddMongoDBParams) WriteToRequest ¶
func (o *AddMongoDBParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type AddMongoDBParamsBodyAddNode ¶
type AddMongoDBParamsBodyAddNode 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. // Must be unique across all Generic Nodes if specified. MachineID string `json:"machine_id,omitempty"` // Node model. NodeModel string `json:"node_model,omitempty"` // Unique across all Nodes user-defined name. Can't be changed. NodeName string `json:"node_name,omitempty"` // NodeType describes supported Node types. // Enum: [NODE_TYPE_INVALID GENERIC_NODE CONTAINER_NODE REMOTE_NODE REMOTE_AMAZON_RDS_NODE] NodeType *string `json:"node_type,omitempty"` // Node region. Region string `json:"region,omitempty"` }
AddMongoDBParamsBodyAddNode AddNodeParams is a params to add new node to inventory while adding new service. swagger:model AddMongoDBParamsBodyAddNode
func (*AddMongoDBParamsBodyAddNode) MarshalBinary ¶
func (o *AddMongoDBParamsBodyAddNode) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AddMongoDBParamsBodyAddNode) UnmarshalBinary ¶
func (o *AddMongoDBParamsBodyAddNode) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AddMongoDBReader ¶
type AddMongoDBReader struct {
// contains filtered or unexported fields
}
AddMongoDBReader is a Reader for the AddMongoDB structure.
func (*AddMongoDBReader) ReadResponse ¶
func (o *AddMongoDBReader) 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 mongo db API
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) *Client
New creates a new mongo db API client.
func (*Client) AddMongoDB ¶
func (a *Client) AddMongoDB(params *AddMongoDBParams) (*AddMongoDBOK, error)
AddMongoDB adds mongo DB adds mongo DB service and starts several agents it automatically adds a service to inventory which is running on provided node id then adds mongodb exporter and qan mongodb profiler agents 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