Documentation
¶
Index ¶
- Variables
- func RegisterNitroServer(s *grpc.Server, srv NitroServer)
- type AddDatabaseRequest
- func (*AddDatabaseRequest) Descriptor() ([]byte, []int)deprecated
- func (x *AddDatabaseRequest) GetDatabase() *DatabaseInfo
- func (*AddDatabaseRequest) ProtoMessage()
- func (x *AddDatabaseRequest) ProtoReflect() protoreflect.Message
- func (x *AddDatabaseRequest) Reset()
- func (x *AddDatabaseRequest) String() string
- type AddDatabaseResponse
- func (*AddDatabaseResponse) Descriptor() ([]byte, []int)deprecated
- func (x *AddDatabaseResponse) GetMessage() string
- func (*AddDatabaseResponse) ProtoMessage()
- func (x *AddDatabaseResponse) ProtoReflect() protoreflect.Message
- func (x *AddDatabaseResponse) Reset()
- func (x *AddDatabaseResponse) String() string
- type ApplyRequest
- type ApplyResponse
- func (*ApplyResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ApplyResponse) GetError() bool
- func (x *ApplyResponse) GetMessage() string
- func (*ApplyResponse) ProtoMessage()
- func (x *ApplyResponse) ProtoReflect() protoreflect.Message
- func (x *ApplyResponse) Reset()
- func (x *ApplyResponse) String() string
- type DatabaseInfo
- func (*DatabaseInfo) Descriptor() ([]byte, []int)deprecated
- func (x *DatabaseInfo) GetCompressed() bool
- func (x *DatabaseInfo) GetCompressionType() string
- func (x *DatabaseInfo) GetDatabase() string
- func (x *DatabaseInfo) GetEngine() string
- func (x *DatabaseInfo) GetHostname() string
- func (x *DatabaseInfo) GetPort() string
- func (x *DatabaseInfo) GetVersion() string
- func (*DatabaseInfo) ProtoMessage()
- func (x *DatabaseInfo) ProtoReflect() protoreflect.Message
- func (x *DatabaseInfo) Reset()
- func (x *DatabaseInfo) String() string
- type ImportDatabaseRequest
- func (*ImportDatabaseRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ImportDatabaseRequest) GetData() []byte
- func (x *ImportDatabaseRequest) GetDatabase() *DatabaseInfo
- func (m *ImportDatabaseRequest) GetPayload() isImportDatabaseRequest_Payload
- func (*ImportDatabaseRequest) ProtoMessage()
- func (x *ImportDatabaseRequest) ProtoReflect() protoreflect.Message
- func (x *ImportDatabaseRequest) Reset()
- func (x *ImportDatabaseRequest) String() string
- type ImportDatabaseRequest_Data
- type ImportDatabaseRequest_Database
- type ImportDatabaseResponse
- func (*ImportDatabaseResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ImportDatabaseResponse) GetMessage() string
- func (*ImportDatabaseResponse) ProtoMessage()
- func (x *ImportDatabaseResponse) ProtoReflect() protoreflect.Message
- func (x *ImportDatabaseResponse) Reset()
- func (x *ImportDatabaseResponse) String() string
- type NitroClient
- type NitroServer
- type Nitro_ImportDatabaseClient
- type Nitro_ImportDatabaseServer
- type PingRequest
- type PingResponse
- type RemoveDatabaseRequest
- func (*RemoveDatabaseRequest) Descriptor() ([]byte, []int)deprecated
- func (x *RemoveDatabaseRequest) GetDatabase() *DatabaseInfo
- func (*RemoveDatabaseRequest) ProtoMessage()
- func (x *RemoveDatabaseRequest) ProtoReflect() protoreflect.Message
- func (x *RemoveDatabaseRequest) Reset()
- func (x *RemoveDatabaseRequest) String() string
- type RemoveDatabaseResponse
- func (*RemoveDatabaseResponse) Descriptor() ([]byte, []int)deprecated
- func (x *RemoveDatabaseResponse) GetMessage() string
- func (*RemoveDatabaseResponse) ProtoMessage()
- func (x *RemoveDatabaseResponse) ProtoReflect() protoreflect.Message
- func (x *RemoveDatabaseResponse) Reset()
- func (x *RemoveDatabaseResponse) String() string
- type Site
- type UnimplementedNitroServer
- func (*UnimplementedNitroServer) AddDatabase(context.Context, *AddDatabaseRequest) (*AddDatabaseResponse, error)
- func (*UnimplementedNitroServer) Apply(context.Context, *ApplyRequest) (*ApplyResponse, error)
- func (*UnimplementedNitroServer) ImportDatabase(Nitro_ImportDatabaseServer) error
- func (*UnimplementedNitroServer) Ping(context.Context, *PingRequest) (*PingResponse, error)
- func (*UnimplementedNitroServer) RemoveDatabase(context.Context, *RemoveDatabaseRequest) (*RemoveDatabaseResponse, error)
- func (*UnimplementedNitroServer) Version(context.Context, *VersionRequest) (*VersionResponse, error)
- type VersionRequest
- type VersionResponse
Constants ¶
This section is empty.
Variables ¶
var File_protob_nitrod_proto protoreflect.FileDescriptor
Functions ¶
func RegisterNitroServer ¶
func RegisterNitroServer(s *grpc.Server, srv NitroServer)
Types ¶
type AddDatabaseRequest ¶
type AddDatabaseRequest struct {
Database *DatabaseInfo `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
// contains filtered or unexported fields
}
func (*AddDatabaseRequest) Descriptor
deprecated
func (*AddDatabaseRequest) Descriptor() ([]byte, []int)
Deprecated: Use AddDatabaseRequest.ProtoReflect.Descriptor instead.
func (*AddDatabaseRequest) GetDatabase ¶
func (x *AddDatabaseRequest) GetDatabase() *DatabaseInfo
func (*AddDatabaseRequest) ProtoMessage ¶
func (*AddDatabaseRequest) ProtoMessage()
func (*AddDatabaseRequest) ProtoReflect ¶
func (x *AddDatabaseRequest) ProtoReflect() protoreflect.Message
func (*AddDatabaseRequest) Reset ¶
func (x *AddDatabaseRequest) Reset()
func (*AddDatabaseRequest) String ¶
func (x *AddDatabaseRequest) String() string
type AddDatabaseResponse ¶
type AddDatabaseResponse struct {
Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
// contains filtered or unexported fields
}
func (*AddDatabaseResponse) Descriptor
deprecated
func (*AddDatabaseResponse) Descriptor() ([]byte, []int)
Deprecated: Use AddDatabaseResponse.ProtoReflect.Descriptor instead.
func (*AddDatabaseResponse) GetMessage ¶
func (x *AddDatabaseResponse) GetMessage() string
func (*AddDatabaseResponse) ProtoMessage ¶
func (*AddDatabaseResponse) ProtoMessage()
func (*AddDatabaseResponse) ProtoReflect ¶
func (x *AddDatabaseResponse) ProtoReflect() protoreflect.Message
func (*AddDatabaseResponse) Reset ¶
func (x *AddDatabaseResponse) Reset()
func (*AddDatabaseResponse) String ¶
func (x *AddDatabaseResponse) String() string
type ApplyRequest ¶
type ApplyRequest struct {
Sites map[string]*Site `` /* 151-byte string literal not displayed */
// contains filtered or unexported fields
}
func (*ApplyRequest) Descriptor
deprecated
func (*ApplyRequest) Descriptor() ([]byte, []int)
Deprecated: Use ApplyRequest.ProtoReflect.Descriptor instead.
func (*ApplyRequest) GetSites ¶
func (x *ApplyRequest) GetSites() map[string]*Site
func (*ApplyRequest) ProtoMessage ¶
func (*ApplyRequest) ProtoMessage()
func (*ApplyRequest) ProtoReflect ¶
func (x *ApplyRequest) ProtoReflect() protoreflect.Message
func (*ApplyRequest) Reset ¶
func (x *ApplyRequest) Reset()
func (*ApplyRequest) String ¶
func (x *ApplyRequest) String() string
type ApplyResponse ¶
type ApplyResponse struct {
Error bool `protobuf:"varint,1,opt,name=error,proto3" json:"error,omitempty"`
Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
// contains filtered or unexported fields
}
func (*ApplyResponse) Descriptor
deprecated
func (*ApplyResponse) Descriptor() ([]byte, []int)
Deprecated: Use ApplyResponse.ProtoReflect.Descriptor instead.
func (*ApplyResponse) GetError ¶
func (x *ApplyResponse) GetError() bool
func (*ApplyResponse) GetMessage ¶
func (x *ApplyResponse) GetMessage() string
func (*ApplyResponse) ProtoMessage ¶
func (*ApplyResponse) ProtoMessage()
func (*ApplyResponse) ProtoReflect ¶
func (x *ApplyResponse) ProtoReflect() protoreflect.Message
func (*ApplyResponse) Reset ¶
func (x *ApplyResponse) Reset()
func (*ApplyResponse) String ¶
func (x *ApplyResponse) String() string
type DatabaseInfo ¶
type DatabaseInfo struct {
// engine is the type of database (e.g. mysql or postgres)
Engine string `protobuf:"bytes,1,opt,name=engine,proto3" json:"engine,omitempty"`
// version is the database version (e.g. 5.7 or 13)
Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
// port is the port used to connect to the datbase (e.g. 3306)
Port string `protobuf:"bytes,3,opt,name=port,proto3" json:"port,omitempty"`
// hostname is the container name used to connect (e.g. mysql-5.7-3306.database.nitro)
Hostname string `protobuf:"bytes,4,opt,name=hostname,proto3" json:"hostname,omitempty"`
// datbase is the name of the database
Database string `protobuf:"bytes,5,opt,name=database,proto3" json:"database,omitempty"`
// if the client was able to detect the database is compressed (only used during importing)
Compressed bool `protobuf:"varint,6,opt,name=compressed,proto3" json:"compressed,omitempty"`
// the kind of compression type, e.g. zip or tar
CompressionType string `protobuf:"bytes,7,opt,name=compressionType,proto3" json:"compressionType,omitempty"`
// contains filtered or unexported fields
}
func (*DatabaseInfo) Descriptor
deprecated
func (*DatabaseInfo) Descriptor() ([]byte, []int)
Deprecated: Use DatabaseInfo.ProtoReflect.Descriptor instead.
func (*DatabaseInfo) GetCompressed ¶
func (x *DatabaseInfo) GetCompressed() bool
func (*DatabaseInfo) GetCompressionType ¶
func (x *DatabaseInfo) GetCompressionType() string
func (*DatabaseInfo) GetDatabase ¶
func (x *DatabaseInfo) GetDatabase() string
func (*DatabaseInfo) GetEngine ¶
func (x *DatabaseInfo) GetEngine() string
func (*DatabaseInfo) GetHostname ¶
func (x *DatabaseInfo) GetHostname() string
func (*DatabaseInfo) GetPort ¶
func (x *DatabaseInfo) GetPort() string
func (*DatabaseInfo) GetVersion ¶
func (x *DatabaseInfo) GetVersion() string
func (*DatabaseInfo) ProtoMessage ¶
func (*DatabaseInfo) ProtoMessage()
func (*DatabaseInfo) ProtoReflect ¶
func (x *DatabaseInfo) ProtoReflect() protoreflect.Message
func (*DatabaseInfo) Reset ¶
func (x *DatabaseInfo) Reset()
func (*DatabaseInfo) String ¶
func (x *DatabaseInfo) String() string
type ImportDatabaseRequest ¶
type ImportDatabaseRequest struct {
// Types that are assignable to Payload:
// *ImportDatabaseRequest_Database
// *ImportDatabaseRequest_Data
Payload isImportDatabaseRequest_Payload `protobuf_oneof:"payload"`
// contains filtered or unexported fields
}
func (*ImportDatabaseRequest) Descriptor
deprecated
func (*ImportDatabaseRequest) Descriptor() ([]byte, []int)
Deprecated: Use ImportDatabaseRequest.ProtoReflect.Descriptor instead.
func (*ImportDatabaseRequest) GetData ¶
func (x *ImportDatabaseRequest) GetData() []byte
func (*ImportDatabaseRequest) GetDatabase ¶
func (x *ImportDatabaseRequest) GetDatabase() *DatabaseInfo
func (*ImportDatabaseRequest) GetPayload ¶
func (m *ImportDatabaseRequest) GetPayload() isImportDatabaseRequest_Payload
func (*ImportDatabaseRequest) ProtoMessage ¶
func (*ImportDatabaseRequest) ProtoMessage()
func (*ImportDatabaseRequest) ProtoReflect ¶
func (x *ImportDatabaseRequest) ProtoReflect() protoreflect.Message
func (*ImportDatabaseRequest) Reset ¶
func (x *ImportDatabaseRequest) Reset()
func (*ImportDatabaseRequest) String ¶
func (x *ImportDatabaseRequest) String() string
type ImportDatabaseRequest_Data ¶
type ImportDatabaseRequest_Data struct {
// data is the data of the file, used in stream to reduce memory usage.
Data []byte `protobuf:"bytes,2,opt,name=data,proto3,oneof"`
}
type ImportDatabaseRequest_Database ¶
type ImportDatabaseRequest_Database struct {
Database *DatabaseInfo `protobuf:"bytes,1,opt,name=database,proto3,oneof"`
}
type ImportDatabaseResponse ¶
type ImportDatabaseResponse struct {
Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
// contains filtered or unexported fields
}
func (*ImportDatabaseResponse) Descriptor
deprecated
func (*ImportDatabaseResponse) Descriptor() ([]byte, []int)
Deprecated: Use ImportDatabaseResponse.ProtoReflect.Descriptor instead.
func (*ImportDatabaseResponse) GetMessage ¶
func (x *ImportDatabaseResponse) GetMessage() string
func (*ImportDatabaseResponse) ProtoMessage ¶
func (*ImportDatabaseResponse) ProtoMessage()
func (*ImportDatabaseResponse) ProtoReflect ¶
func (x *ImportDatabaseResponse) ProtoReflect() protoreflect.Message
func (*ImportDatabaseResponse) Reset ¶
func (x *ImportDatabaseResponse) Reset()
func (*ImportDatabaseResponse) String ¶
func (x *ImportDatabaseResponse) String() string
type NitroClient ¶
type NitroClient interface {
// Ping returns pong when the API is online
Ping(ctx context.Context, in *PingRequest, opts ...grpc.CallOption) (*PingResponse, error)
// Apply takes a list of sites and services to configure caddy as a reverse proxy
Apply(ctx context.Context, in *ApplyRequest, opts ...grpc.CallOption) (*ApplyResponse, error)
// Version returns the version of the API
Version(ctx context.Context, in *VersionRequest, opts ...grpc.CallOption) (*VersionResponse, error)
// AddDatabase is used to create a new database for a project
AddDatabase(ctx context.Context, in *AddDatabaseRequest, opts ...grpc.CallOption) (*AddDatabaseResponse, error)
// ImportDatabase is used to stream a database backup from the client to the proxy.
ImportDatabase(ctx context.Context, opts ...grpc.CallOption) (Nitro_ImportDatabaseClient, error)
// RemoveDatabase handles connecting to a database and removing the database from the engine
RemoveDatabase(ctx context.Context, in *RemoveDatabaseRequest, opts ...grpc.CallOption) (*RemoveDatabaseResponse, error)
}
NitroClient is the client API for Nitro service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewNitroClient ¶
func NewNitroClient(cc grpc.ClientConnInterface) NitroClient
type NitroServer ¶
type NitroServer interface {
// Ping returns pong when the API is online
Ping(context.Context, *PingRequest) (*PingResponse, error)
// Apply takes a list of sites and services to configure caddy as a reverse proxy
Apply(context.Context, *ApplyRequest) (*ApplyResponse, error)
// Version returns the version of the API
Version(context.Context, *VersionRequest) (*VersionResponse, error)
// AddDatabase is used to create a new database for a project
AddDatabase(context.Context, *AddDatabaseRequest) (*AddDatabaseResponse, error)
// ImportDatabase is used to stream a database backup from the client to the proxy.
ImportDatabase(Nitro_ImportDatabaseServer) error
// RemoveDatabase handles connecting to a database and removing the database from the engine
RemoveDatabase(context.Context, *RemoveDatabaseRequest) (*RemoveDatabaseResponse, error)
}
NitroServer is the server API for Nitro service.
type Nitro_ImportDatabaseClient ¶
type Nitro_ImportDatabaseClient interface {
Send(*ImportDatabaseRequest) error
CloseAndRecv() (*ImportDatabaseResponse, error)
grpc.ClientStream
}
type Nitro_ImportDatabaseServer ¶
type Nitro_ImportDatabaseServer interface {
SendAndClose(*ImportDatabaseResponse) error
Recv() (*ImportDatabaseRequest, error)
grpc.ServerStream
}
type PingRequest ¶
type PingRequest struct {
// contains filtered or unexported fields
}
func (*PingRequest) Descriptor
deprecated
func (*PingRequest) Descriptor() ([]byte, []int)
Deprecated: Use PingRequest.ProtoReflect.Descriptor instead.
func (*PingRequest) ProtoMessage ¶
func (*PingRequest) ProtoMessage()
func (*PingRequest) ProtoReflect ¶
func (x *PingRequest) ProtoReflect() protoreflect.Message
func (*PingRequest) Reset ¶
func (x *PingRequest) Reset()
func (*PingRequest) String ¶
func (x *PingRequest) String() string
type PingResponse ¶
type PingResponse struct {
Pong string `protobuf:"bytes,1,opt,name=pong,proto3" json:"pong,omitempty"`
// contains filtered or unexported fields
}
func (*PingResponse) Descriptor
deprecated
func (*PingResponse) Descriptor() ([]byte, []int)
Deprecated: Use PingResponse.ProtoReflect.Descriptor instead.
func (*PingResponse) GetPong ¶
func (x *PingResponse) GetPong() string
func (*PingResponse) ProtoMessage ¶
func (*PingResponse) ProtoMessage()
func (*PingResponse) ProtoReflect ¶
func (x *PingResponse) ProtoReflect() protoreflect.Message
func (*PingResponse) Reset ¶
func (x *PingResponse) Reset()
func (*PingResponse) String ¶
func (x *PingResponse) String() string
type RemoveDatabaseRequest ¶
type RemoveDatabaseRequest struct {
Database *DatabaseInfo `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
// contains filtered or unexported fields
}
func (*RemoveDatabaseRequest) Descriptor
deprecated
func (*RemoveDatabaseRequest) Descriptor() ([]byte, []int)
Deprecated: Use RemoveDatabaseRequest.ProtoReflect.Descriptor instead.
func (*RemoveDatabaseRequest) GetDatabase ¶
func (x *RemoveDatabaseRequest) GetDatabase() *DatabaseInfo
func (*RemoveDatabaseRequest) ProtoMessage ¶
func (*RemoveDatabaseRequest) ProtoMessage()
func (*RemoveDatabaseRequest) ProtoReflect ¶
func (x *RemoveDatabaseRequest) ProtoReflect() protoreflect.Message
func (*RemoveDatabaseRequest) Reset ¶
func (x *RemoveDatabaseRequest) Reset()
func (*RemoveDatabaseRequest) String ¶
func (x *RemoveDatabaseRequest) String() string
type RemoveDatabaseResponse ¶
type RemoveDatabaseResponse struct {
Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
// contains filtered or unexported fields
}
func (*RemoveDatabaseResponse) Descriptor
deprecated
func (*RemoveDatabaseResponse) Descriptor() ([]byte, []int)
Deprecated: Use RemoveDatabaseResponse.ProtoReflect.Descriptor instead.
func (*RemoveDatabaseResponse) GetMessage ¶
func (x *RemoveDatabaseResponse) GetMessage() string
func (*RemoveDatabaseResponse) ProtoMessage ¶
func (*RemoveDatabaseResponse) ProtoMessage()
func (*RemoveDatabaseResponse) ProtoReflect ¶
func (x *RemoveDatabaseResponse) ProtoReflect() protoreflect.Message
func (*RemoveDatabaseResponse) Reset ¶
func (x *RemoveDatabaseResponse) Reset()
func (*RemoveDatabaseResponse) String ¶
func (x *RemoveDatabaseResponse) String() string
type Site ¶
type Site struct {
Hostname string `protobuf:"bytes,1,opt,name=hostname,proto3" json:"hostname,omitempty"`
Aliases string `protobuf:"bytes,2,opt,name=aliases,proto3" json:"aliases,omitempty"`
Port int32 `protobuf:"varint,3,opt,name=port,proto3" json:"port,omitempty"`
// contains filtered or unexported fields
}
func (*Site) Descriptor
deprecated
func (*Site) GetAliases ¶
func (*Site) GetHostname ¶
func (*Site) ProtoMessage ¶
func (*Site) ProtoMessage()
func (*Site) ProtoReflect ¶
func (x *Site) ProtoReflect() protoreflect.Message
type UnimplementedNitroServer ¶
type UnimplementedNitroServer struct {
}
UnimplementedNitroServer can be embedded to have forward compatible implementations.
func (*UnimplementedNitroServer) AddDatabase ¶
func (*UnimplementedNitroServer) AddDatabase(context.Context, *AddDatabaseRequest) (*AddDatabaseResponse, error)
func (*UnimplementedNitroServer) Apply ¶
func (*UnimplementedNitroServer) Apply(context.Context, *ApplyRequest) (*ApplyResponse, error)
func (*UnimplementedNitroServer) ImportDatabase ¶
func (*UnimplementedNitroServer) ImportDatabase(Nitro_ImportDatabaseServer) error
func (*UnimplementedNitroServer) Ping ¶
func (*UnimplementedNitroServer) Ping(context.Context, *PingRequest) (*PingResponse, error)
func (*UnimplementedNitroServer) RemoveDatabase ¶
func (*UnimplementedNitroServer) RemoveDatabase(context.Context, *RemoveDatabaseRequest) (*RemoveDatabaseResponse, error)
func (*UnimplementedNitroServer) Version ¶
func (*UnimplementedNitroServer) Version(context.Context, *VersionRequest) (*VersionResponse, error)
type VersionRequest ¶
type VersionRequest struct {
// contains filtered or unexported fields
}
func (*VersionRequest) Descriptor
deprecated
func (*VersionRequest) Descriptor() ([]byte, []int)
Deprecated: Use VersionRequest.ProtoReflect.Descriptor instead.
func (*VersionRequest) ProtoMessage ¶
func (*VersionRequest) ProtoMessage()
func (*VersionRequest) ProtoReflect ¶
func (x *VersionRequest) ProtoReflect() protoreflect.Message
func (*VersionRequest) Reset ¶
func (x *VersionRequest) Reset()
func (*VersionRequest) String ¶
func (x *VersionRequest) String() string
type VersionResponse ¶
type VersionResponse struct {
Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
// contains filtered or unexported fields
}
func (*VersionResponse) Descriptor
deprecated
func (*VersionResponse) Descriptor() ([]byte, []int)
Deprecated: Use VersionResponse.ProtoReflect.Descriptor instead.
func (*VersionResponse) GetVersion ¶
func (x *VersionResponse) GetVersion() string
func (*VersionResponse) ProtoMessage ¶
func (*VersionResponse) ProtoMessage()
func (*VersionResponse) ProtoReflect ¶
func (x *VersionResponse) ProtoReflect() protoreflect.Message
func (*VersionResponse) Reset ¶
func (x *VersionResponse) Reset()
func (*VersionResponse) String ¶
func (x *VersionResponse) String() string