telemetry

Documentation

Overview

Package telemetry is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

• Variables
• func RegisterTelemetryHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
• func RegisterTelemetryHandlerClient(ctx context.Context, mux *runtime.ServeMux, client TelemetryClient) error
• func RegisterTelemetryHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
• func RegisterTelemetryHandlerServer(ctx context.Context, mux *runtime.ServeMux, server TelemetryServer) error
• func RegisterTelemetryServer(s *grpc.Server, srv TelemetryServer)
• type TelemetryClient
  • func NewTelemetryClient(cc grpc.ClientConnInterface) TelemetryClient
• type TelemetryRequest
  • func (*TelemetryRequest) Descriptor() ([]byte, []int)
  • func (*TelemetryRequest) ProtoMessage()
  • func (x *TelemetryRequest) ProtoReflect() protoreflect.Message
  • func (x *TelemetryRequest) Reset()
  • func (x *TelemetryRequest) String() string
• type TelemetryResponse
  • func (*TelemetryResponse) Descriptor() ([]byte, []int)
  • func (x *TelemetryResponse) GetCustomerId() string
  • func (x *TelemetryResponse) GetCustomerName() string
  • func (x *TelemetryResponse) GetDeploymentId() string
  • func (x *TelemetryResponse) GetDeploymentType() string
  • func (x *TelemetryResponse) GetLicenseId() string
  • func (x *TelemetryResponse) GetLicenseType() string
  • func (x *TelemetryResponse) GetMaxNodes() int64
  • func (x *TelemetryResponse) GetTelemetryEnabled() bool
  • func (x *TelemetryResponse) GetTelemetryUrl() string
  • func (*TelemetryResponse) ProtoMessage()
  • func (x *TelemetryResponse) ProtoReflect() protoreflect.Message
  • func (x *TelemetryResponse) Reset()
  • func (x *TelemetryResponse) String() string
• type TelemetryServer
• type TelemetryServerMock
  • func NewTelemetryServerMock() *TelemetryServerMock
  • func NewTelemetryServerMockWithoutValidation() *TelemetryServerMock
  • func (m *TelemetryServerMock) GetTelemetryConfiguration(ctx context.Context, req *TelemetryRequest) (*TelemetryResponse, error)
  • func (m *TelemetryServerMock) Reset()
• type UnimplementedTelemetryServer
  • func (*UnimplementedTelemetryServer) GetTelemetryConfiguration(context.Context, *TelemetryRequest) (*TelemetryResponse, error)

Variables

var File_automate_gateway_api_telemetry_telemetry_proto protoreflect.FileDescriptor

Functions

func RegisterTelemetryHandler

func RegisterTelemetryHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterTelemetryHandler registers the http handlers for service Telemetry to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterTelemetryHandlerClient

func RegisterTelemetryHandlerClient(ctx context.Context, mux *runtime.ServeMux, client TelemetryClient) error

RegisterTelemetryHandlerClient registers the http handlers for service Telemetry to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "TelemetryClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "TelemetryClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "TelemetryClient" to call the correct interceptors.

func RegisterTelemetryHandlerFromEndpoint

func RegisterTelemetryHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterTelemetryHandlerFromEndpoint is same as RegisterTelemetryHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterTelemetryHandlerServer

func RegisterTelemetryHandlerServer(ctx context.Context, mux *runtime.ServeMux, server TelemetryServer) error

RegisterTelemetryHandlerServer registers the http handlers for service Telemetry to "mux". UnaryRPC :call TelemetryServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.

func RegisterTelemetryServer

func RegisterTelemetryServer(s *grpc.Server, srv TelemetryServer)

Types

type TelemetryClient

type TelemetryClient interface {
	GetTelemetryConfiguration(ctx context.Context, in *TelemetryRequest, opts ...grpc.CallOption) (*TelemetryResponse, error)
}

TelemetryClient is the client API for Telemetry service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewTelemetryClient

func NewTelemetryClient(cc grpc.ClientConnInterface) TelemetryClient

type TelemetryRequest

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

func (*TelemetryRequest) Descriptor

func (*TelemetryRequest) Descriptor() ([]byte, []int)

Deprecated: Use TelemetryRequest.ProtoReflect.Descriptor instead.

func (*TelemetryRequest) ProtoMessage

func (*TelemetryRequest) ProtoMessage()

func (*TelemetryRequest) ProtoReflect

func (x *TelemetryRequest) ProtoReflect() protoreflect.Message

func (*TelemetryRequest) Reset

func (x *TelemetryRequest) Reset()

func (*TelemetryRequest) String

func (x *TelemetryRequest) String() string

type TelemetryResponse

type TelemetryResponse struct {
	LicenseId        string `protobuf:"bytes,1,opt,name=license_id,json=licenseId,proto3" json:"license_id,omitempty"`
	CustomerName     string `protobuf:"bytes,4,opt,name=customer_name,json=customerName,proto3" json:"customer_name,omitempty"`
	CustomerId       string `protobuf:"bytes,5,opt,name=customer_id,json=customerId,proto3" json:"customer_id,omitempty"`
	LicenseType      string `protobuf:"bytes,6,opt,name=license_type,json=licenseType,proto3" json:"license_type,omitempty"`
	TelemetryEnabled bool   `protobuf:"varint,7,opt,name=telemetry_enabled,json=telemetryEnabled,proto3" json:"telemetry_enabled,omitempty"`
	TelemetryUrl     string `protobuf:"bytes,8,opt,name=telemetry_url,json=telemetryUrl,proto3" json:"telemetry_url,omitempty"`
	MaxNodes         int64  `protobuf:"varint,9,opt,name=max_nodes,json=maxNodes,proto3" json:"max_nodes,omitempty"`
	DeploymentId     string `protobuf:"bytes,10,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	DeploymentType   string `protobuf:"bytes,11,opt,name=deployment_type,json=deploymentType,proto3" json:"deployment_type,omitempty"`
	// contains filtered or unexported fields
}

func (*TelemetryResponse) Descriptor

func (*TelemetryResponse) Descriptor() ([]byte, []int)

Deprecated: Use TelemetryResponse.ProtoReflect.Descriptor instead.

func (*TelemetryResponse) GetCustomerId

func (x *TelemetryResponse) GetCustomerId() string

func (*TelemetryResponse) GetCustomerName

func (x *TelemetryResponse) GetCustomerName() string

func (*TelemetryResponse) GetDeploymentId

func (x *TelemetryResponse) GetDeploymentId() string

func (*TelemetryResponse) GetDeploymentType

func (x *TelemetryResponse) GetDeploymentType() string

func (*TelemetryResponse) GetLicenseId

func (x *TelemetryResponse) GetLicenseId() string

func (*TelemetryResponse) GetLicenseType

func (x *TelemetryResponse) GetLicenseType() string

func (*TelemetryResponse) GetMaxNodes

func (x *TelemetryResponse) GetMaxNodes() int64

func (*TelemetryResponse) GetTelemetryEnabled

func (x *TelemetryResponse) GetTelemetryEnabled() bool

func (*TelemetryResponse) GetTelemetryUrl

func (x *TelemetryResponse) GetTelemetryUrl() string

func (*TelemetryResponse) ProtoMessage

func (*TelemetryResponse) ProtoMessage()

func (*TelemetryResponse) ProtoReflect

func (x *TelemetryResponse) ProtoReflect() protoreflect.Message

func (*TelemetryResponse) Reset

func (x *TelemetryResponse) Reset()

func (*TelemetryResponse) String

func (x *TelemetryResponse) String() string

type TelemetryServer

type TelemetryServer interface {
	GetTelemetryConfiguration(context.Context, *TelemetryRequest) (*TelemetryResponse, error)
}

TelemetryServer is the server API for Telemetry service.

type TelemetryServerMock

type TelemetryServerMock struct {
	GetTelemetryConfigurationFunc func(context.Context, *TelemetryRequest) (*TelemetryResponse, error)
	// contains filtered or unexported fields
}

TelemetryServerMock is the mock-what-you-want struct that stubs all not-overridden methods with "not implemented" returns

func NewTelemetryServerMock

func NewTelemetryServerMock() *TelemetryServerMock

NewTelemetryServerMock gives you a fresh instance of TelemetryServerMock.

func NewTelemetryServerMockWithoutValidation

func NewTelemetryServerMockWithoutValidation() *TelemetryServerMock

NewTelemetryServerMockWithoutValidation gives you a fresh instance of TelemetryServerMock which does not attempt to validate requests before passing them to their respective '*Func'.

func (*TelemetryServerMock) GetTelemetryConfiguration

func (m *TelemetryServerMock) GetTelemetryConfiguration(ctx context.Context, req *TelemetryRequest) (*TelemetryResponse, error)

func (*TelemetryServerMock) Reset

func (m *TelemetryServerMock) Reset()

Reset resets all overridden functions

type UnimplementedTelemetryServer

type UnimplementedTelemetryServer struct {
}

UnimplementedTelemetryServer can be embedded to have forward compatible implementations.

func (*UnimplementedTelemetryServer) GetTelemetryConfiguration

func (*UnimplementedTelemetryServer) GetTelemetryConfiguration(context.Context, *TelemetryRequest) (*TelemetryResponse, error)