mongo_db

package
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: 0

Documentation

Index

Constants

View Source 
const (

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

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

	// AddMongoDBBodyMetricsModePUSH captures enum value "PUSH"
	AddMongoDBBodyMetricsModePUSH string = "PUSH"
)
View Source 
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"
)
View Source 
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"
)
View Source 
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"

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

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

Variables

This section is empty.

Functions

This section is empty.

Types

type AddMongoDBBody 

type AddMongoDBBody 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"`

	// MongoDB username for exporter and QAN agent access.
	Username string `json:"username,omitempty"`

	// MongoDB password for exporter and QAN agent access.
	Password string `json:"password,omitempty"`

	// If true, adds qan-mongodb-profiler-agent for provided service.
	QANMongodbProfiler bool `json:"qan_mongodb_profiler,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"`

	// Client certificate and key.
	TLSCertificateKey string `json:"tls_certificate_key,omitempty"`

	// Password for decrypting tls_certificate_key.
	TLSCertificateKeyFilePassword string `json:"tls_certificate_key_file_password,omitempty"`

	// Certificate Authority certificate chain.
	TLSCa string `json:"tls_ca,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 *AddMongoDBParamsBodyAddNode `json:"add_node,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

func (*AddMongoDBBody) Validate 

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

Validate validates this add mongo DB body

type AddMongoDBDefault 

type AddMongoDBDefault struct {
	Payload *AddMongoDBDefaultBody
	// contains filtered or unexported fields
}

AddMongoDBDefault handles this case with default header values.

An unexpected 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 {

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

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

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

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

AddMongoDBDefaultBody add mongo DB default body 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

func (*AddMongoDBDefaultBody) Validate 

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

Validate validates this add mongo DB default body

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

func (*AddMongoDBOKBody) Validate 

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

Validate validates this add mongo DB OK body

type AddMongoDBOKBodyMongodbExporter 

type AddMongoDBOKBodyMongodbExporter 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"`

	// MongoDB 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"`
}

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

func (*AddMongoDBOKBodyMongodbExporter) Validate 

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

Validate validates this add mongo DB OK body mongodb exporter

type AddMongoDBOKBodyQANMongodbProfiler 

type AddMongoDBOKBodyQANMongodbProfiler 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"`

	// MongoDB username for getting profiler 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"`
}

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

func (*AddMongoDBOKBodyQANMongodbProfiler) Validate 

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

Validate validates this add mongo DB OK body QAN mongodb profiler

type AddMongoDBOKBodyService 

type AddMongoDBOKBodyService 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"`
}

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

func (*AddMongoDBOKBodyService) Validate 

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

Validate validates this add mongo DB OK body service

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 {

	// 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"`
}

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

func (*AddMongoDBParamsBodyAddNode) Validate 

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

Validate validates this add mongo DB params body add node

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 (*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

type ClientService 

type ClientService interface {
	AddMongoDB(params *AddMongoDBParams) (*AddMongoDBOK, 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 mongo db 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

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.