Documentation
¶
Index ¶
- Variables
- func RegisterConfigServer(s grpc.ServiceRegistrar, srv ConfigServer)
- func RegisterListenerServer(s grpc.ServiceRegistrar, srv ListenerServer)
- func UnaryLog(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, ...) (resp interface{}, err error)
- type ConfigClient
- type ConfigData
- type ConfigServer
- type Connection
- func (*Connection) Descriptor() ([]byte, []int)deprecated
- func (x *Connection) GetCaCert() []byte
- func (x *Connection) GetDisableTlsVerification() bool
- func (x *Connection) GetListenAddr() string
- func (x *Connection) GetName() string
- func (x *Connection) GetPomeriumUrl() string
- func (x *Connection) GetRemoteAddr() string
- func (m *Connection) GetTlsOptions() isConnection_TlsOptions
- func (*Connection) ProtoMessage()
- func (x *Connection) ProtoReflect() protoreflect.Message
- func (x *Connection) Reset()
- func (x *Connection) String() string
- type ConnectionStatusUpdate
- func (*ConnectionStatusUpdate) Descriptor() ([]byte, []int)deprecated
- func (x *ConnectionStatusUpdate) GetAuthUrl() string
- func (x *ConnectionStatusUpdate) GetId() string
- func (x *ConnectionStatusUpdate) GetLastError() string
- func (x *ConnectionStatusUpdate) GetPeerAddr() string
- func (x *ConnectionStatusUpdate) GetStatus() ConnectionStatusUpdate_ConnectionStatus
- func (x *ConnectionStatusUpdate) GetTs() *timestamppb.Timestamp
- func (*ConnectionStatusUpdate) ProtoMessage()
- func (x *ConnectionStatusUpdate) ProtoReflect() protoreflect.Message
- func (x *ConnectionStatusUpdate) Reset()
- func (x *ConnectionStatusUpdate) String() string
- type ConnectionStatusUpdate_ConnectionStatus
- func (ConnectionStatusUpdate_ConnectionStatus) Descriptor() protoreflect.EnumDescriptor
- func (x ConnectionStatusUpdate_ConnectionStatus) Enum() *ConnectionStatusUpdate_ConnectionStatus
- func (ConnectionStatusUpdate_ConnectionStatus) EnumDescriptor() ([]byte, []int)deprecated
- func (x ConnectionStatusUpdate_ConnectionStatus) Number() protoreflect.EnumNumber
- func (x ConnectionStatusUpdate_ConnectionStatus) String() string
- func (ConnectionStatusUpdate_ConnectionStatus) Type() protoreflect.EnumType
- type Connection_CaCert
- type Connection_DisableTlsVerification
- type DeleteRecordsResponse
- type ExportRequest
- func (*ExportRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ExportRequest) GetFormat() ExportRequest_Format
- func (x *ExportRequest) GetRemoveTags() bool
- func (x *ExportRequest) GetSelector() *Selector
- func (*ExportRequest) ProtoMessage()
- func (x *ExportRequest) ProtoReflect() protoreflect.Message
- func (x *ExportRequest) Reset()
- func (x *ExportRequest) String() string
- type ExportRequest_Format
- func (ExportRequest_Format) Descriptor() protoreflect.EnumDescriptor
- func (x ExportRequest_Format) Enum() *ExportRequest_Format
- func (ExportRequest_Format) EnumDescriptor() ([]byte, []int)deprecated
- func (x ExportRequest_Format) Number() protoreflect.EnumNumber
- func (x ExportRequest_Format) String() string
- func (ExportRequest_Format) Type() protoreflect.EnumType
- type GetTagsRequest
- type GetTagsResponse
- type ImportRequest
- func (*ImportRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ImportRequest) GetData() []byte
- func (x *ImportRequest) GetOverrideTag() string
- func (*ImportRequest) ProtoMessage()
- func (x *ImportRequest) ProtoReflect() protoreflect.Message
- func (x *ImportRequest) Reset()
- func (x *ImportRequest) String() string
- type ImportResponse
- type ListenerClient
- type ListenerServer
- type ListenerStatus
- func (*ListenerStatus) Descriptor() ([]byte, []int)deprecated
- func (x *ListenerStatus) GetLastError() string
- func (x *ListenerStatus) GetListenAddr() string
- func (x *ListenerStatus) GetListening() bool
- func (*ListenerStatus) ProtoMessage()
- func (x *ListenerStatus) ProtoReflect() protoreflect.Message
- func (x *ListenerStatus) Reset()
- func (x *ListenerStatus) String() string
- type ListenerStatusResponse
- func (*ListenerStatusResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListenerStatusResponse) GetListeners() map[string]*ListenerStatus
- func (*ListenerStatusResponse) ProtoMessage()
- func (x *ListenerStatusResponse) ProtoReflect() protoreflect.Message
- func (x *ListenerStatusResponse) Reset()
- func (x *ListenerStatusResponse) String() string
- type ListenerUpdateRequest
- func (*ListenerUpdateRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListenerUpdateRequest) GetConnected() bool
- func (x *ListenerUpdateRequest) GetConnectionIds() []string
- func (*ListenerUpdateRequest) ProtoMessage()
- func (x *ListenerUpdateRequest) ProtoReflect() protoreflect.Message
- func (x *ListenerUpdateRequest) Reset()
- func (x *ListenerUpdateRequest) String() string
- type Listener_StatusUpdatesClient
- type Listener_StatusUpdatesServer
- type Record
- func (*Record) Descriptor() ([]byte, []int)deprecated
- func (x *Record) GetConn() *Connection
- func (x *Record) GetId() string
- func (x *Record) GetTags() []string
- func (*Record) ProtoMessage()
- func (x *Record) ProtoReflect() protoreflect.Message
- func (x *Record) Reset()
- func (x *Record) String() string
- type Records
- type Selector
- func (*Selector) Descriptor() ([]byte, []int)deprecated
- func (x *Selector) GetAll() bool
- func (x *Selector) GetIds() []string
- func (x *Selector) GetTags() []string
- func (*Selector) ProtoMessage()
- func (x *Selector) ProtoReflect() protoreflect.Message
- func (x *Selector) Reset()
- func (x *Selector) String() string
- type StatusUpdatesRequest
- func (*StatusUpdatesRequest) Descriptor() ([]byte, []int)deprecated
- func (x *StatusUpdatesRequest) GetConnectionId() string
- func (*StatusUpdatesRequest) ProtoMessage()
- func (x *StatusUpdatesRequest) ProtoReflect() protoreflect.Message
- func (x *StatusUpdatesRequest) Reset()
- func (x *StatusUpdatesRequest) String() string
- type UnimplementedConfigServer
- func (UnimplementedConfigServer) Delete(context.Context, *Selector) (*DeleteRecordsResponse, error)
- func (UnimplementedConfigServer) Export(context.Context, *ExportRequest) (*ConfigData, error)
- func (UnimplementedConfigServer) GetTags(context.Context, *GetTagsRequest) (*GetTagsResponse, error)
- func (UnimplementedConfigServer) Import(context.Context, *ImportRequest) (*ImportResponse, error)
- func (UnimplementedConfigServer) List(context.Context, *Selector) (*Records, error)
- func (UnimplementedConfigServer) Upsert(context.Context, *Record) (*Record, error)
- type UnimplementedListenerServer
- func (UnimplementedListenerServer) GetStatus(context.Context, *Selector) (*ListenerStatusResponse, error)
- func (UnimplementedListenerServer) StatusUpdates(*StatusUpdatesRequest, Listener_StatusUpdatesServer) error
- func (UnimplementedListenerServer) Update(context.Context, *ListenerUpdateRequest) (*ListenerStatusResponse, error)
- type UnsafeConfigServer
- type UnsafeListenerServer
Constants ¶
This section is empty.
Variables ¶
var ( ExportRequest_Format_name = map[int32]string{ 0: "EXPORT_FORMAT_UNDEFINED", 1: "EXPORT_FORMAT_JSON_COMPACT", 2: "EXPORT_FORMAT_JSON_PRETTY", } ExportRequest_Format_value = map[string]int32{ "EXPORT_FORMAT_UNDEFINED": 0, "EXPORT_FORMAT_JSON_COMPACT": 1, "EXPORT_FORMAT_JSON_PRETTY": 2, } )
Enum value maps for ExportRequest_Format.
var ( ConnectionStatusUpdate_ConnectionStatus_name = map[int32]string{ 0: "CONNECTION_STATUS_UNDEFINED", 1: "CONNECTION_STATUS_CONNECTING", 2: "CONNECTION_STATUS_AUTH_REQUIRED", 3: "CONNECTION_STATUS_CONNECTED", 4: "CONNECTION_STATUS_DISCONNECTED", 5: "CONNECTION_STATUS_LISTENING", 6: "CONNECTION_STATUS_CLOSED", } ConnectionStatusUpdate_ConnectionStatus_value = map[string]int32{ "CONNECTION_STATUS_UNDEFINED": 0, "CONNECTION_STATUS_CONNECTING": 1, "CONNECTION_STATUS_AUTH_REQUIRED": 2, "CONNECTION_STATUS_CONNECTED": 3, "CONNECTION_STATUS_DISCONNECTED": 4, "CONNECTION_STATUS_LISTENING": 5, "CONNECTION_STATUS_CLOSED": 6, } )
Enum value maps for ConnectionStatusUpdate_ConnectionStatus.
var Config_ServiceDesc = grpc.ServiceDesc{ ServiceName: "pomerium.cli.Config", HandlerType: (*ConfigServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "List", Handler: _Config_List_Handler, }, { MethodName: "Delete", Handler: _Config_Delete_Handler, }, { MethodName: "Upsert", Handler: _Config_Upsert_Handler, }, { MethodName: "GetTags", Handler: _Config_GetTags_Handler, }, { MethodName: "Export", Handler: _Config_Export_Handler, }, { MethodName: "Import", Handler: _Config_Import_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "proto/api.proto", }
Config_ServiceDesc is the grpc.ServiceDesc for Config service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_proto_api_proto protoreflect.FileDescriptor
var Listener_ServiceDesc = grpc.ServiceDesc{ ServiceName: "pomerium.cli.Listener", HandlerType: (*ListenerServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Update", Handler: _Listener_Update_Handler, }, { MethodName: "GetStatus", Handler: _Listener_GetStatus_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "StatusUpdates", Handler: _Listener_StatusUpdates_Handler, ServerStreams: true, }, }, Metadata: "proto/api.proto", }
Listener_ServiceDesc is the grpc.ServiceDesc for Listener service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterConfigServer ¶
func RegisterConfigServer(s grpc.ServiceRegistrar, srv ConfigServer)
func RegisterListenerServer ¶
func RegisterListenerServer(s grpc.ServiceRegistrar, srv ListenerServer)
func UnaryLog ¶
func UnaryLog(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp interface{}, err error)
Types ¶
type ConfigClient ¶
type ConfigClient interface { // List returns records that match Selector List(ctx context.Context, in *Selector, opts ...grpc.CallOption) (*Records, error) // Delete deletes records that match Selector Delete(ctx context.Context, in *Selector, opts ...grpc.CallOption) (*DeleteRecordsResponse, error) // Upsert inserts (if no ID is provided) or updates records // you may omit the Connection data to just manipulate tags Upsert(ctx context.Context, in *Record, opts ...grpc.CallOption) (*Record, error) // GetTags returns all tags. Note that tags are case sensitive GetTags(ctx context.Context, in *GetTagsRequest, opts ...grpc.CallOption) (*GetTagsResponse, error) // Export dumps config into serialized format Export(ctx context.Context, in *ExportRequest, opts ...grpc.CallOption) (*ConfigData, error) // Import imports previously serialized records Import(ctx context.Context, in *ImportRequest, opts ...grpc.CallOption) (*ImportResponse, error) }
ConfigClient is the client API for Config service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewConfigClient ¶
func NewConfigClient(cc grpc.ClientConnInterface) ConfigClient
type ConfigData ¶
type ConfigData struct { Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"` // contains filtered or unexported fields }
func (*ConfigData) Descriptor
deprecated
func (*ConfigData) Descriptor() ([]byte, []int)
Deprecated: Use ConfigData.ProtoReflect.Descriptor instead.
func (*ConfigData) GetData ¶
func (x *ConfigData) GetData() []byte
func (*ConfigData) ProtoMessage ¶
func (*ConfigData) ProtoMessage()
func (*ConfigData) ProtoReflect ¶
func (x *ConfigData) ProtoReflect() protoreflect.Message
func (*ConfigData) Reset ¶
func (x *ConfigData) Reset()
func (*ConfigData) String ¶
func (x *ConfigData) String() string
type ConfigServer ¶
type ConfigServer interface { // List returns records that match Selector List(context.Context, *Selector) (*Records, error) // Delete deletes records that match Selector Delete(context.Context, *Selector) (*DeleteRecordsResponse, error) // Upsert inserts (if no ID is provided) or updates records // you may omit the Connection data to just manipulate tags Upsert(context.Context, *Record) (*Record, error) // GetTags returns all tags. Note that tags are case sensitive GetTags(context.Context, *GetTagsRequest) (*GetTagsResponse, error) // Export dumps config into serialized format Export(context.Context, *ExportRequest) (*ConfigData, error) // Import imports previously serialized records Import(context.Context, *ImportRequest) (*ImportResponse, error) }
ConfigServer is the server API for Config service. All implementations should embed UnimplementedConfigServer for forward compatibility
type Connection ¶
type Connection struct { // name is a user friendly connection name that a user may define Name *string `protobuf:"bytes,1,opt,name=name,proto3,oneof" json:"name,omitempty"` // remote_addr is a remote pomerium host:port RemoteAddr string `protobuf:"bytes,2,opt,name=remote_addr,json=remoteAddr,proto3" json:"remote_addr,omitempty"` // listen_address, if not provided, will assign a random port each time ListenAddr *string `protobuf:"bytes,3,opt,name=listen_addr,json=listenAddr,proto3,oneof" json:"listen_addr,omitempty"` // the URL of the pomerium server to connect to PomeriumUrl *string `protobuf:"bytes,4,opt,name=pomerium_url,json=pomeriumUrl,proto3,oneof" json:"pomerium_url,omitempty"` // Types that are assignable to TlsOptions: // *Connection_DisableTlsVerification // *Connection_CaCert TlsOptions isConnection_TlsOptions `protobuf_oneof:"tls_options"` // contains filtered or unexported fields }
Connection
func (*Connection) Descriptor
deprecated
func (*Connection) Descriptor() ([]byte, []int)
Deprecated: Use Connection.ProtoReflect.Descriptor instead.
func (*Connection) GetCaCert ¶
func (x *Connection) GetCaCert() []byte
func (*Connection) GetDisableTlsVerification ¶
func (x *Connection) GetDisableTlsVerification() bool
func (*Connection) GetListenAddr ¶
func (x *Connection) GetListenAddr() string
func (*Connection) GetName ¶
func (x *Connection) GetName() string
func (*Connection) GetPomeriumUrl ¶
func (x *Connection) GetPomeriumUrl() string
func (*Connection) GetRemoteAddr ¶
func (x *Connection) GetRemoteAddr() string
func (*Connection) GetTlsOptions ¶
func (m *Connection) GetTlsOptions() isConnection_TlsOptions
func (*Connection) ProtoMessage ¶
func (*Connection) ProtoMessage()
func (*Connection) ProtoReflect ¶
func (x *Connection) ProtoReflect() protoreflect.Message
func (*Connection) Reset ¶
func (x *Connection) Reset()
func (*Connection) String ¶
func (x *Connection) String() string
type ConnectionStatusUpdate ¶
type ConnectionStatusUpdate struct { // record this event relates to Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // peer_addr represents connecting party remote address and may be used to // distinguish between individual TCP connections PeerAddr *string `protobuf:"bytes,2,opt,name=peer_addr,json=peerAddr,proto3,oneof" json:"peer_addr,omitempty"` Status ConnectionStatusUpdate_ConnectionStatus `protobuf:"varint,3,opt,name=status,proto3,enum=pomerium.cli.ConnectionStatusUpdate_ConnectionStatus" json:"status,omitempty"` // in case the connection failed or terminated, last error may be available LastError *string `protobuf:"bytes,4,opt,name=last_error,json=lastError,proto3,oneof" json:"last_error,omitempty"` // provides an authentication URL when AUTH_REQUIRED status is set AuthUrl *string `protobuf:"bytes,5,opt,name=auth_url,json=authUrl,proto3,oneof" json:"auth_url,omitempty"` // event timestamp Ts *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=ts,proto3" json:"ts,omitempty"` // contains filtered or unexported fields }
ConnectionStatusUpdates represent connection state changes
func (*ConnectionStatusUpdate) Descriptor
deprecated
func (*ConnectionStatusUpdate) Descriptor() ([]byte, []int)
Deprecated: Use ConnectionStatusUpdate.ProtoReflect.Descriptor instead.
func (*ConnectionStatusUpdate) GetAuthUrl ¶
func (x *ConnectionStatusUpdate) GetAuthUrl() string
func (*ConnectionStatusUpdate) GetId ¶
func (x *ConnectionStatusUpdate) GetId() string
func (*ConnectionStatusUpdate) GetLastError ¶
func (x *ConnectionStatusUpdate) GetLastError() string
func (*ConnectionStatusUpdate) GetPeerAddr ¶
func (x *ConnectionStatusUpdate) GetPeerAddr() string
func (*ConnectionStatusUpdate) GetStatus ¶
func (x *ConnectionStatusUpdate) GetStatus() ConnectionStatusUpdate_ConnectionStatus
func (*ConnectionStatusUpdate) GetTs ¶
func (x *ConnectionStatusUpdate) GetTs() *timestamppb.Timestamp
func (*ConnectionStatusUpdate) ProtoMessage ¶
func (*ConnectionStatusUpdate) ProtoMessage()
func (*ConnectionStatusUpdate) ProtoReflect ¶
func (x *ConnectionStatusUpdate) ProtoReflect() protoreflect.Message
func (*ConnectionStatusUpdate) Reset ¶
func (x *ConnectionStatusUpdate) Reset()
func (*ConnectionStatusUpdate) String ¶
func (x *ConnectionStatusUpdate) String() string
type ConnectionStatusUpdate_ConnectionStatus ¶
type ConnectionStatusUpdate_ConnectionStatus int32
const ( ConnectionStatusUpdate_CONNECTION_STATUS_UNDEFINED ConnectionStatusUpdate_ConnectionStatus = 0 ConnectionStatusUpdate_CONNECTION_STATUS_CONNECTING ConnectionStatusUpdate_ConnectionStatus = 1 ConnectionStatusUpdate_CONNECTION_STATUS_AUTH_REQUIRED ConnectionStatusUpdate_ConnectionStatus = 2 ConnectionStatusUpdate_CONNECTION_STATUS_CONNECTED ConnectionStatusUpdate_ConnectionStatus = 3 ConnectionStatusUpdate_CONNECTION_STATUS_DISCONNECTED ConnectionStatusUpdate_ConnectionStatus = 4 // listener is up; peer_addr would not be set ConnectionStatusUpdate_CONNECTION_STATUS_LISTENING ConnectionStatusUpdate_ConnectionStatus = 5 // listener is closed; peer_addr would be set ConnectionStatusUpdate_CONNECTION_STATUS_CLOSED ConnectionStatusUpdate_ConnectionStatus = 6 )
func (ConnectionStatusUpdate_ConnectionStatus) Descriptor ¶
func (ConnectionStatusUpdate_ConnectionStatus) Descriptor() protoreflect.EnumDescriptor
func (ConnectionStatusUpdate_ConnectionStatus) EnumDescriptor
deprecated
func (ConnectionStatusUpdate_ConnectionStatus) EnumDescriptor() ([]byte, []int)
Deprecated: Use ConnectionStatusUpdate_ConnectionStatus.Descriptor instead.
func (ConnectionStatusUpdate_ConnectionStatus) Number ¶
func (x ConnectionStatusUpdate_ConnectionStatus) Number() protoreflect.EnumNumber
func (ConnectionStatusUpdate_ConnectionStatus) String ¶
func (x ConnectionStatusUpdate_ConnectionStatus) String() string
func (ConnectionStatusUpdate_ConnectionStatus) Type ¶
func (ConnectionStatusUpdate_ConnectionStatus) Type() protoreflect.EnumType
type Connection_CaCert ¶
type Connection_CaCert struct {
CaCert []byte `protobuf:"bytes,6,opt,name=ca_cert,json=caCert,proto3,oneof"`
}
type Connection_DisableTlsVerification ¶
type Connection_DisableTlsVerification struct {
DisableTlsVerification bool `protobuf:"varint,5,opt,name=disable_tls_verification,json=disableTlsVerification,proto3,oneof"`
}
type DeleteRecordsResponse ¶
type DeleteRecordsResponse struct {
// contains filtered or unexported fields
}
func (*DeleteRecordsResponse) Descriptor
deprecated
func (*DeleteRecordsResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeleteRecordsResponse.ProtoReflect.Descriptor instead.
func (*DeleteRecordsResponse) ProtoMessage ¶
func (*DeleteRecordsResponse) ProtoMessage()
func (*DeleteRecordsResponse) ProtoReflect ¶
func (x *DeleteRecordsResponse) ProtoReflect() protoreflect.Message
func (*DeleteRecordsResponse) Reset ¶
func (x *DeleteRecordsResponse) Reset()
func (*DeleteRecordsResponse) String ¶
func (x *DeleteRecordsResponse) String() string
type ExportRequest ¶
type ExportRequest struct { Selector *Selector `protobuf:"bytes,1,opt,name=selector,proto3" json:"selector,omitempty"` // remove_tags to strip tags from output RemoveTags bool `protobuf:"varint,2,opt,name=remove_tags,json=removeTags,proto3" json:"remove_tags,omitempty"` Format ExportRequest_Format `protobuf:"varint,3,opt,name=format,proto3,enum=pomerium.cli.ExportRequest_Format" json:"format,omitempty"` // contains filtered or unexported fields }
Export dumps configuration (or subset of, based on provided tag filter) in the JSON format
func (*ExportRequest) Descriptor
deprecated
func (*ExportRequest) Descriptor() ([]byte, []int)
Deprecated: Use ExportRequest.ProtoReflect.Descriptor instead.
func (*ExportRequest) GetFormat ¶
func (x *ExportRequest) GetFormat() ExportRequest_Format
func (*ExportRequest) GetRemoveTags ¶
func (x *ExportRequest) GetRemoveTags() bool
func (*ExportRequest) GetSelector ¶
func (x *ExportRequest) GetSelector() *Selector
func (*ExportRequest) ProtoMessage ¶
func (*ExportRequest) ProtoMessage()
func (*ExportRequest) ProtoReflect ¶
func (x *ExportRequest) ProtoReflect() protoreflect.Message
func (*ExportRequest) Reset ¶
func (x *ExportRequest) Reset()
func (*ExportRequest) String ¶
func (x *ExportRequest) String() string
type ExportRequest_Format ¶
type ExportRequest_Format int32
const ( ExportRequest_EXPORT_FORMAT_UNDEFINED ExportRequest_Format = 0 ExportRequest_EXPORT_FORMAT_JSON_COMPACT ExportRequest_Format = 1 ExportRequest_EXPORT_FORMAT_JSON_PRETTY ExportRequest_Format = 2 )
func (ExportRequest_Format) Descriptor ¶
func (ExportRequest_Format) Descriptor() protoreflect.EnumDescriptor
func (ExportRequest_Format) Enum ¶
func (x ExportRequest_Format) Enum() *ExportRequest_Format
func (ExportRequest_Format) EnumDescriptor
deprecated
func (ExportRequest_Format) EnumDescriptor() ([]byte, []int)
Deprecated: Use ExportRequest_Format.Descriptor instead.
func (ExportRequest_Format) Number ¶
func (x ExportRequest_Format) Number() protoreflect.EnumNumber
func (ExportRequest_Format) String ¶
func (x ExportRequest_Format) String() string
func (ExportRequest_Format) Type ¶
func (ExportRequest_Format) Type() protoreflect.EnumType
type GetTagsRequest ¶
type GetTagsRequest struct {
// contains filtered or unexported fields
}
func (*GetTagsRequest) Descriptor
deprecated
func (*GetTagsRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetTagsRequest.ProtoReflect.Descriptor instead.
func (*GetTagsRequest) ProtoMessage ¶
func (*GetTagsRequest) ProtoMessage()
func (*GetTagsRequest) ProtoReflect ¶
func (x *GetTagsRequest) ProtoReflect() protoreflect.Message
func (*GetTagsRequest) Reset ¶
func (x *GetTagsRequest) Reset()
func (*GetTagsRequest) String ¶
func (x *GetTagsRequest) String() string
type GetTagsResponse ¶
type GetTagsResponse struct { Tags []string `protobuf:"bytes,1,rep,name=tags,proto3" json:"tags,omitempty"` // contains filtered or unexported fields }
func (*GetTagsResponse) Descriptor
deprecated
func (*GetTagsResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetTagsResponse.ProtoReflect.Descriptor instead.
func (*GetTagsResponse) GetTags ¶
func (x *GetTagsResponse) GetTags() []string
func (*GetTagsResponse) ProtoMessage ¶
func (*GetTagsResponse) ProtoMessage()
func (*GetTagsResponse) ProtoReflect ¶
func (x *GetTagsResponse) ProtoReflect() protoreflect.Message
func (*GetTagsResponse) Reset ¶
func (x *GetTagsResponse) Reset()
func (*GetTagsResponse) String ¶
func (x *GetTagsResponse) String() string
type ImportRequest ¶
type ImportRequest struct { // if set, all connections would receive that tag instead OverrideTag *string `protobuf:"bytes,1,opt,name=override_tag,json=overrideTag,proto3,oneof" json:"override_tag,omitempty"` Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"` // contains filtered or unexported fields }
ImportRequest would consume the previously exported data back, merging it with existing configuration, and performing de-duplication of the records so that multiple imports would yield the same result
func (*ImportRequest) Descriptor
deprecated
func (*ImportRequest) Descriptor() ([]byte, []int)
Deprecated: Use ImportRequest.ProtoReflect.Descriptor instead.
func (*ImportRequest) GetData ¶
func (x *ImportRequest) GetData() []byte
func (*ImportRequest) GetOverrideTag ¶
func (x *ImportRequest) GetOverrideTag() string
func (*ImportRequest) ProtoMessage ¶
func (*ImportRequest) ProtoMessage()
func (*ImportRequest) ProtoReflect ¶
func (x *ImportRequest) ProtoReflect() protoreflect.Message
func (*ImportRequest) Reset ¶
func (x *ImportRequest) Reset()
func (*ImportRequest) String ¶
func (x *ImportRequest) String() string
type ImportResponse ¶
type ImportResponse struct {
// contains filtered or unexported fields
}
func (*ImportResponse) Descriptor
deprecated
func (*ImportResponse) Descriptor() ([]byte, []int)
Deprecated: Use ImportResponse.ProtoReflect.Descriptor instead.
func (*ImportResponse) ProtoMessage ¶
func (*ImportResponse) ProtoMessage()
func (*ImportResponse) ProtoReflect ¶
func (x *ImportResponse) ProtoReflect() protoreflect.Message
func (*ImportResponse) Reset ¶
func (x *ImportResponse) Reset()
func (*ImportResponse) String ¶
func (x *ImportResponse) String() string
type ListenerClient ¶
type ListenerClient interface { // Update alters connection status. Update(ctx context.Context, in *ListenerUpdateRequest, opts ...grpc.CallOption) (*ListenerStatusResponse, error) // GetStatus returns current listener status for active tunnels GetStatus(ctx context.Context, in *Selector, opts ...grpc.CallOption) (*ListenerStatusResponse, error) // StatusUpdates opens a stream to listen to connection status updates // a client has to subscribe and continuously // listen to the broadcasted updates StatusUpdates(ctx context.Context, in *StatusUpdatesRequest, opts ...grpc.CallOption) (Listener_StatusUpdatesClient, error) }
ListenerClient is the client API for Listener service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewListenerClient ¶
func NewListenerClient(cc grpc.ClientConnInterface) ListenerClient
type ListenerServer ¶
type ListenerServer interface { // Update alters connection status. Update(context.Context, *ListenerUpdateRequest) (*ListenerStatusResponse, error) // GetStatus returns current listener status for active tunnels GetStatus(context.Context, *Selector) (*ListenerStatusResponse, error) // StatusUpdates opens a stream to listen to connection status updates // a client has to subscribe and continuously // listen to the broadcasted updates StatusUpdates(*StatusUpdatesRequest, Listener_StatusUpdatesServer) error }
ListenerServer is the server API for Listener service. All implementations should embed UnimplementedListenerServer for forward compatibility
type ListenerStatus ¶
type ListenerStatus struct { Listening bool `protobuf:"varint,1,opt,name=listening,proto3" json:"listening,omitempty"` ListenAddr *string `protobuf:"bytes,2,opt,name=listen_addr,json=listenAddr,proto3,oneof" json:"listen_addr,omitempty"` LastError *string `protobuf:"bytes,3,opt,name=last_error,json=lastError,proto3,oneof" json:"last_error,omitempty"` // contains filtered or unexported fields }
func (*ListenerStatus) Descriptor
deprecated
func (*ListenerStatus) Descriptor() ([]byte, []int)
Deprecated: Use ListenerStatus.ProtoReflect.Descriptor instead.
func (*ListenerStatus) GetLastError ¶
func (x *ListenerStatus) GetLastError() string
func (*ListenerStatus) GetListenAddr ¶
func (x *ListenerStatus) GetListenAddr() string
func (*ListenerStatus) GetListening ¶
func (x *ListenerStatus) GetListening() bool
func (*ListenerStatus) ProtoMessage ¶
func (*ListenerStatus) ProtoMessage()
func (*ListenerStatus) ProtoReflect ¶
func (x *ListenerStatus) ProtoReflect() protoreflect.Message
func (*ListenerStatus) Reset ¶
func (x *ListenerStatus) Reset()
func (*ListenerStatus) String ¶
func (x *ListenerStatus) String() string
type ListenerStatusResponse ¶
type ListenerStatusResponse struct { Listeners map[string]*ListenerStatus `` /* 159-byte string literal not displayed */ // contains filtered or unexported fields }
func (*ListenerStatusResponse) Descriptor
deprecated
func (*ListenerStatusResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListenerStatusResponse.ProtoReflect.Descriptor instead.
func (*ListenerStatusResponse) GetListeners ¶
func (x *ListenerStatusResponse) GetListeners() map[string]*ListenerStatus
func (*ListenerStatusResponse) ProtoMessage ¶
func (*ListenerStatusResponse) ProtoMessage()
func (*ListenerStatusResponse) ProtoReflect ¶
func (x *ListenerStatusResponse) ProtoReflect() protoreflect.Message
func (*ListenerStatusResponse) Reset ¶
func (x *ListenerStatusResponse) Reset()
func (*ListenerStatusResponse) String ¶
func (x *ListenerStatusResponse) String() string
type ListenerUpdateRequest ¶
type ListenerUpdateRequest struct { // omit connection ids to connect all connections ConnectionIds []string `protobuf:"bytes,1,rep,name=connection_ids,json=connectionIds,proto3" json:"connection_ids,omitempty"` Connected bool `protobuf:"varint,2,opt,name=connected,proto3" json:"connected,omitempty"` // contains filtered or unexported fields }
func (*ListenerUpdateRequest) Descriptor
deprecated
func (*ListenerUpdateRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListenerUpdateRequest.ProtoReflect.Descriptor instead.
func (*ListenerUpdateRequest) GetConnected ¶
func (x *ListenerUpdateRequest) GetConnected() bool
func (*ListenerUpdateRequest) GetConnectionIds ¶
func (x *ListenerUpdateRequest) GetConnectionIds() []string
func (*ListenerUpdateRequest) ProtoMessage ¶
func (*ListenerUpdateRequest) ProtoMessage()
func (*ListenerUpdateRequest) ProtoReflect ¶
func (x *ListenerUpdateRequest) ProtoReflect() protoreflect.Message
func (*ListenerUpdateRequest) Reset ¶
func (x *ListenerUpdateRequest) Reset()
func (*ListenerUpdateRequest) String ¶
func (x *ListenerUpdateRequest) String() string
type Listener_StatusUpdatesClient ¶
type Listener_StatusUpdatesClient interface { Recv() (*ConnectionStatusUpdate, error) grpc.ClientStream }
type Listener_StatusUpdatesServer ¶
type Listener_StatusUpdatesServer interface { Send(*ConnectionStatusUpdate) error grpc.ServerStream }
type Record ¶
type Record struct { // if omitted, a new record would be created Id *string `protobuf:"bytes,1,opt,name=id,proto3,oneof" json:"id,omitempty"` Tags []string `protobuf:"bytes,2,rep,name=tags,proto3" json:"tags,omitempty"` // connection data may be omitted if i.e. just manipulating the tags data Conn *Connection `protobuf:"bytes,3,opt,name=conn,proto3,oneof" json:"conn,omitempty"` // contains filtered or unexported fields }
Record represents a single tunnel record in the configuration
func (*Record) Descriptor
deprecated
func (*Record) GetConn ¶
func (x *Record) GetConn() *Connection
func (*Record) ProtoMessage ¶
func (*Record) ProtoMessage()
func (*Record) ProtoReflect ¶
func (x *Record) ProtoReflect() protoreflect.Message
type Records ¶
type Records struct { Records []*Record `protobuf:"bytes,1,rep,name=records,proto3" json:"records,omitempty"` // contains filtered or unexported fields }
func (*Records) Descriptor
deprecated
func (*Records) GetRecords ¶
func (*Records) ProtoMessage ¶
func (*Records) ProtoMessage()
func (*Records) ProtoReflect ¶
func (x *Records) ProtoReflect() protoreflect.Message
type Selector ¶
type Selector struct { // all records All bool `protobuf:"varint,1,opt,name=all,proto3" json:"all,omitempty"` // only return connections matching tag(s) Ids []string `protobuf:"bytes,2,rep,name=ids,proto3" json:"ids,omitempty"` // only return specific connection(s) Tags []string `protobuf:"bytes,3,rep,name=tags,proto3" json:"tags,omitempty"` // contains filtered or unexported fields }
Selector defines record filter one of the options must be set we do not use oneof as it results in inconveniences on the JS client side
func (*Selector) Descriptor
deprecated
func (*Selector) ProtoMessage ¶
func (*Selector) ProtoMessage()
func (*Selector) ProtoReflect ¶
func (x *Selector) ProtoReflect() protoreflect.Message
type StatusUpdatesRequest ¶
type StatusUpdatesRequest struct { ConnectionId string `protobuf:"bytes,1,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"` // contains filtered or unexported fields }
func (*StatusUpdatesRequest) Descriptor
deprecated
func (*StatusUpdatesRequest) Descriptor() ([]byte, []int)
Deprecated: Use StatusUpdatesRequest.ProtoReflect.Descriptor instead.
func (*StatusUpdatesRequest) GetConnectionId ¶
func (x *StatusUpdatesRequest) GetConnectionId() string
func (*StatusUpdatesRequest) ProtoMessage ¶
func (*StatusUpdatesRequest) ProtoMessage()
func (*StatusUpdatesRequest) ProtoReflect ¶
func (x *StatusUpdatesRequest) ProtoReflect() protoreflect.Message
func (*StatusUpdatesRequest) Reset ¶
func (x *StatusUpdatesRequest) Reset()
func (*StatusUpdatesRequest) String ¶
func (x *StatusUpdatesRequest) String() string
type UnimplementedConfigServer ¶
type UnimplementedConfigServer struct { }
UnimplementedConfigServer should be embedded to have forward compatible implementations.
func (UnimplementedConfigServer) Delete ¶
func (UnimplementedConfigServer) Delete(context.Context, *Selector) (*DeleteRecordsResponse, error)
func (UnimplementedConfigServer) Export ¶
func (UnimplementedConfigServer) Export(context.Context, *ExportRequest) (*ConfigData, error)
func (UnimplementedConfigServer) GetTags ¶
func (UnimplementedConfigServer) GetTags(context.Context, *GetTagsRequest) (*GetTagsResponse, error)
func (UnimplementedConfigServer) Import ¶
func (UnimplementedConfigServer) Import(context.Context, *ImportRequest) (*ImportResponse, error)
type UnimplementedListenerServer ¶
type UnimplementedListenerServer struct { }
UnimplementedListenerServer should be embedded to have forward compatible implementations.
func (UnimplementedListenerServer) GetStatus ¶
func (UnimplementedListenerServer) GetStatus(context.Context, *Selector) (*ListenerStatusResponse, error)
func (UnimplementedListenerServer) StatusUpdates ¶
func (UnimplementedListenerServer) StatusUpdates(*StatusUpdatesRequest, Listener_StatusUpdatesServer) error
func (UnimplementedListenerServer) Update ¶
func (UnimplementedListenerServer) Update(context.Context, *ListenerUpdateRequest) (*ListenerStatusResponse, error)
type UnsafeConfigServer ¶
type UnsafeConfigServer interface {
// contains filtered or unexported methods
}
UnsafeConfigServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ConfigServer will result in compilation errors.
type UnsafeListenerServer ¶
type UnsafeListenerServer interface {
// contains filtered or unexported methods
}
UnsafeListenerServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ListenerServer will result in compilation errors.