Documentation ¶
Index ¶
- Variables
- type API
- func (*API) Descriptor() ([]byte, []int)deprecated
- func (x *API) GetGrpc() *GrpcAPI
- func (x *API) GetHttp() *HttpAPI
- func (x *API) GetRest() *RestAPI
- func (x *API) GetTcp() *TcpAPI
- func (m *API) GetValue() isAPI_Value
- func (*API) ProtoMessage()
- func (x *API) ProtoReflect() protoreflect.Message
- func (x *API) Reset()
- func (x *API) String() string
- type API_Grpc
- type API_Http
- type API_Rest
- type API_Tcp
- type Agent
- func (*Agent) Descriptor() ([]byte, []int)deprecated
- func (x *Agent) GetKind() Agent_Kind
- func (x *Agent) GetName() string
- func (x *Agent) GetPublisher() string
- func (x *Agent) GetVersion() string
- func (*Agent) ProtoMessage()
- func (x *Agent) ProtoReflect() protoreflect.Message
- func (x *Agent) Reset()
- func (x *Agent) String() string
- type Agent_Kind
- type Application
- func (*Application) Descriptor() ([]byte, []int)deprecated
- func (x *Application) GetDescription() string
- func (x *Application) GetName() string
- func (x *Application) GetProject() string
- func (x *Application) GetServices() []*Service
- func (*Application) ProtoMessage()
- func (x *Application) ProtoReflect() protoreflect.Message
- func (x *Application) Reset()
- func (x *Application) String() string
- type Endpoint
- func (*Endpoint) Descriptor() ([]byte, []int)deprecated
- func (x *Endpoint) GetApi() *API
- func (x *Endpoint) GetApplication() string
- func (x *Endpoint) GetDescription() string
- func (x *Endpoint) GetName() string
- func (x *Endpoint) GetNamespace() string
- func (x *Endpoint) GetService() string
- func (x *Endpoint) GetVisibility() string
- func (*Endpoint) ProtoMessage()
- func (x *Endpoint) ProtoReflect() protoreflect.Message
- func (x *Endpoint) Reset()
- func (x *Endpoint) String() string
- type Environment
- func (*Environment) Descriptor() ([]byte, []int)deprecated
- func (x *Environment) GetDescription() string
- func (x *Environment) GetName() string
- func (*Environment) ProtoMessage()
- func (x *Environment) ProtoReflect() protoreflect.Message
- func (x *Environment) Reset()
- func (x *Environment) String() string
- type GrpcAPI
- type HTTPMethod
- type HttpAPI
- type Organization
- func (*Organization) Descriptor() ([]byte, []int)deprecated
- func (x *Organization) GetDomain() string
- func (x *Organization) GetName() string
- func (*Organization) ProtoMessage()
- func (x *Organization) ProtoReflect() protoreflect.Message
- func (x *Organization) Reset()
- func (x *Organization) String() string
- type Project
- func (*Project) Descriptor() ([]byte, []int)deprecated
- func (x *Project) GetApplications() []*Application
- func (x *Project) GetDescription() string
- func (x *Project) GetName() string
- func (x *Project) GetOrganization() *Organization
- func (*Project) ProtoMessage()
- func (x *Project) ProtoReflect() protoreflect.Message
- func (x *Project) Reset()
- func (x *Project) String() string
- type RPC
- type RestAPI
- type RestRoute
- type Service
- func (*Service) Descriptor() ([]byte, []int)deprecated
- func (x *Service) GetAgent() *Agent
- func (x *Service) GetApplication() string
- func (x *Service) GetDescription() string
- func (x *Service) GetEndpoints() []*Endpoint
- func (x *Service) GetName() string
- func (*Service) ProtoMessage()
- func (x *Service) ProtoReflect() protoreflect.Message
- func (x *Service) Reset()
- func (x *Service) String() string
- type ServiceIdentity
- func (*ServiceIdentity) Descriptor() ([]byte, []int)deprecated
- func (x *ServiceIdentity) GetApplication() string
- func (x *ServiceIdentity) GetDomain() string
- func (x *ServiceIdentity) GetLocation() string
- func (x *ServiceIdentity) GetName() string
- func (x *ServiceIdentity) GetNamespace() string
- func (*ServiceIdentity) ProtoMessage()
- func (x *ServiceIdentity) ProtoReflect() protoreflect.Message
- func (x *ServiceIdentity) Reset()
- func (x *ServiceIdentity) String() string
- type TcpAPI
- type Version
Constants ¶
This section is empty.
Variables ¶
var ( Agent_Kind_name = map[int32]string{ 0: "UNKNOWN", 1: "SERVICE", } Agent_Kind_value = map[string]int32{ "UNKNOWN": 0, "SERVICE": 1, } )
Enum value maps for Agent_Kind.
var ( HTTPMethod_name = map[int32]string{ 0: "GET", 1: "POST", 2: "PUT", 3: "DELETE", 4: "PATCH", 5: "OPTIONS", 6: "HEAD", 7: "CONNECT", 8: "TRACE", } HTTPMethod_value = map[string]int32{ "GET": 0, "POST": 1, "PUT": 2, "DELETE": 3, "PATCH": 4, "OPTIONS": 5, "HEAD": 6, "CONNECT": 7, "TRACE": 8, } )
Enum value maps for HTTPMethod.
var File_base_v1_agent_proto protoreflect.FileDescriptor
var File_base_v1_application_proto protoreflect.FileDescriptor
var File_base_v1_endpoint_proto protoreflect.FileDescriptor
var File_base_v1_environment_proto protoreflect.FileDescriptor
var File_base_v1_organization_proto protoreflect.FileDescriptor
var File_base_v1_project_proto protoreflect.FileDescriptor
var File_base_v1_service_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct { // Types that are assignable to Value: // // *API_Tcp // *API_Http // *API_Rest // *API_Grpc Value isAPI_Value `protobuf_oneof:"value"` // contains filtered or unexported fields }
func (*API) Descriptor
deprecated
func (*API) ProtoMessage ¶
func (*API) ProtoMessage()
func (*API) ProtoReflect ¶
func (x *API) ProtoReflect() protoreflect.Message
type API_Grpc ¶
type API_Grpc struct {
Grpc *GrpcAPI `protobuf:"bytes,4,opt,name=grpc,proto3,oneof"`
}
type API_Http ¶ added in v0.0.81
type API_Http struct {
Http *HttpAPI `protobuf:"bytes,2,opt,name=http,proto3,oneof"`
}
type API_Rest ¶
type API_Rest struct {
Rest *RestAPI `protobuf:"bytes,3,opt,name=rest,proto3,oneof"`
}
type Agent ¶
type Agent struct { Kind Agent_Kind `protobuf:"varint,1,opt,name=kind,proto3,enum=base.v1.Agent_Kind" json:"kind,omitempty"` Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` Publisher string `protobuf:"bytes,3,opt,name=publisher,proto3" json:"publisher,omitempty"` Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"` // contains filtered or unexported fields }
func (*Agent) Descriptor
deprecated
func (*Agent) GetKind ¶
func (x *Agent) GetKind() Agent_Kind
func (*Agent) GetPublisher ¶
func (*Agent) GetVersion ¶
func (*Agent) ProtoMessage ¶
func (*Agent) ProtoMessage()
func (*Agent) ProtoReflect ¶
func (x *Agent) ProtoReflect() protoreflect.Message
type Agent_Kind ¶
type Agent_Kind int32
const ( Agent_UNKNOWN Agent_Kind = 0 Agent_SERVICE Agent_Kind = 1 )
func (Agent_Kind) Descriptor ¶
func (Agent_Kind) Descriptor() protoreflect.EnumDescriptor
func (Agent_Kind) Enum ¶
func (x Agent_Kind) Enum() *Agent_Kind
func (Agent_Kind) EnumDescriptor
deprecated
func (Agent_Kind) EnumDescriptor() ([]byte, []int)
Deprecated: Use Agent_Kind.Descriptor instead.
func (Agent_Kind) Number ¶
func (x Agent_Kind) Number() protoreflect.EnumNumber
func (Agent_Kind) String ¶
func (x Agent_Kind) String() string
func (Agent_Kind) Type ¶
func (Agent_Kind) Type() protoreflect.EnumType
type Application ¶
type Application struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` Project string `protobuf:"bytes,3,opt,name=project,proto3" json:"project,omitempty"` Services []*Service `protobuf:"bytes,4,rep,name=services,proto3" json:"services,omitempty"` // contains filtered or unexported fields }
func (*Application) Descriptor
deprecated
func (*Application) Descriptor() ([]byte, []int)
Deprecated: Use Application.ProtoReflect.Descriptor instead.
func (*Application) GetDescription ¶
func (x *Application) GetDescription() string
func (*Application) GetName ¶
func (x *Application) GetName() string
func (*Application) GetProject ¶
func (x *Application) GetProject() string
func (*Application) GetServices ¶
func (x *Application) GetServices() []*Service
func (*Application) ProtoMessage ¶
func (*Application) ProtoMessage()
func (*Application) ProtoReflect ¶
func (x *Application) ProtoReflect() protoreflect.Message
func (*Application) Reset ¶
func (x *Application) Reset()
func (*Application) String ¶
func (x *Application) String() string
type Endpoint ¶
type Endpoint struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` Visibility string `protobuf:"bytes,3,opt,name=visibility,proto3" json:"visibility,omitempty"` Api *API `protobuf:"bytes,4,opt,name=api,proto3" json:"api,omitempty"` Application string `protobuf:"bytes,5,opt,name=application,proto3" json:"application,omitempty"` Service string `protobuf:"bytes,6,opt,name=service,proto3" json:"service,omitempty"` Namespace string `protobuf:"bytes,7,opt,name=namespace,proto3" json:"namespace,omitempty"` // contains filtered or unexported fields }
func (*Endpoint) Descriptor
deprecated
func (*Endpoint) GetApplication ¶
func (*Endpoint) GetDescription ¶
func (*Endpoint) GetNamespace ¶
func (*Endpoint) GetService ¶
func (*Endpoint) GetVisibility ¶
func (*Endpoint) ProtoMessage ¶
func (*Endpoint) ProtoMessage()
func (*Endpoint) ProtoReflect ¶
func (x *Endpoint) ProtoReflect() protoreflect.Message
type Environment ¶
type Environment struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` // contains filtered or unexported fields }
func (*Environment) Descriptor
deprecated
func (*Environment) Descriptor() ([]byte, []int)
Deprecated: Use Environment.ProtoReflect.Descriptor instead.
func (*Environment) GetDescription ¶
func (x *Environment) GetDescription() string
func (*Environment) GetName ¶
func (x *Environment) GetName() string
func (*Environment) ProtoMessage ¶
func (*Environment) ProtoMessage()
func (*Environment) ProtoReflect ¶
func (x *Environment) ProtoReflect() protoreflect.Message
func (*Environment) Reset ¶
func (x *Environment) Reset()
func (*Environment) String ¶
func (x *Environment) String() string
type GrpcAPI ¶
type GrpcAPI struct { Proto []byte `protobuf:"bytes,1,opt,name=proto,proto3" json:"proto,omitempty"` Rpcs []*RPC `protobuf:"bytes,2,rep,name=rpcs,proto3" json:"rpcs,omitempty"` // contains filtered or unexported fields }
func (*GrpcAPI) Descriptor
deprecated
func (*GrpcAPI) ProtoMessage ¶
func (*GrpcAPI) ProtoMessage()
func (*GrpcAPI) ProtoReflect ¶
func (x *GrpcAPI) ProtoReflect() protoreflect.Message
type HTTPMethod ¶
type HTTPMethod int32
const ( HTTPMethod_GET HTTPMethod = 0 HTTPMethod_POST HTTPMethod = 1 HTTPMethod_PUT HTTPMethod = 2 HTTPMethod_DELETE HTTPMethod = 3 HTTPMethod_PATCH HTTPMethod = 4 HTTPMethod_OPTIONS HTTPMethod = 5 HTTPMethod_HEAD HTTPMethod = 6 HTTPMethod_CONNECT HTTPMethod = 7 HTTPMethod_TRACE HTTPMethod = 8 )
func (HTTPMethod) Descriptor ¶
func (HTTPMethod) Descriptor() protoreflect.EnumDescriptor
func (HTTPMethod) Enum ¶
func (x HTTPMethod) Enum() *HTTPMethod
func (HTTPMethod) EnumDescriptor
deprecated
func (HTTPMethod) EnumDescriptor() ([]byte, []int)
Deprecated: Use HTTPMethod.Descriptor instead.
func (HTTPMethod) Number ¶
func (x HTTPMethod) Number() protoreflect.EnumNumber
func (HTTPMethod) String ¶
func (x HTTPMethod) String() string
func (HTTPMethod) Type ¶
func (HTTPMethod) Type() protoreflect.EnumType
type HttpAPI ¶
type HttpAPI struct {
// contains filtered or unexported fields
}
func (*HttpAPI) Descriptor
deprecated
func (*HttpAPI) ProtoMessage ¶
func (*HttpAPI) ProtoMessage()
func (*HttpAPI) ProtoReflect ¶
func (x *HttpAPI) ProtoReflect() protoreflect.Message
type Organization ¶
type Organization struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Domain string `protobuf:"bytes,2,opt,name=domain,proto3" json:"domain,omitempty"` // contains filtered or unexported fields }
Organization represents the owner of a software system The Domain corresponds to a URI for that organization A Github organization URL is a good example of this
func (*Organization) Descriptor
deprecated
func (*Organization) Descriptor() ([]byte, []int)
Deprecated: Use Organization.ProtoReflect.Descriptor instead.
func (*Organization) GetDomain ¶
func (x *Organization) GetDomain() string
func (*Organization) GetName ¶
func (x *Organization) GetName() string
func (*Organization) ProtoMessage ¶
func (*Organization) ProtoMessage()
func (*Organization) ProtoReflect ¶
func (x *Organization) ProtoReflect() protoreflect.Message
func (*Organization) Reset ¶
func (x *Organization) Reset()
func (*Organization) String ¶
func (x *Organization) String() string
type Project ¶
type Project struct { Organization *Organization `protobuf:"bytes,1,opt,name=organization,proto3" json:"organization,omitempty"` Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"` Applications []*Application `protobuf:"bytes,4,rep,name=applications,proto3" json:"applications,omitempty"` // contains filtered or unexported fields }
func (*Project) Descriptor
deprecated
func (*Project) GetApplications ¶
func (x *Project) GetApplications() []*Application
func (*Project) GetDescription ¶
func (*Project) GetOrganization ¶
func (x *Project) GetOrganization() *Organization
func (*Project) ProtoMessage ¶
func (*Project) ProtoMessage()
func (*Project) ProtoReflect ¶
func (x *Project) ProtoReflect() protoreflect.Message
type RPC ¶
type RPC struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
func (*RPC) Descriptor
deprecated
func (*RPC) ProtoMessage ¶
func (*RPC) ProtoMessage()
func (*RPC) ProtoReflect ¶
func (x *RPC) ProtoReflect() protoreflect.Message
type RestAPI ¶
type RestAPI struct { Openapi []byte `protobuf:"bytes,1,opt,name=openapi,proto3" json:"openapi,omitempty"` Routes []*RestRoute `protobuf:"bytes,2,rep,name=routes,proto3" json:"routes,omitempty"` // contains filtered or unexported fields }
func (*RestAPI) Descriptor
deprecated
func (*RestAPI) GetOpenapi ¶
func (*RestAPI) ProtoMessage ¶
func (*RestAPI) ProtoMessage()
func (*RestAPI) ProtoReflect ¶
func (x *RestAPI) ProtoReflect() protoreflect.Message
type RestRoute ¶
type RestRoute struct { Methods []HTTPMethod `protobuf:"varint,1,rep,packed,name=methods,proto3,enum=base.v1.HTTPMethod" json:"methods,omitempty"` Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"` // contains filtered or unexported fields }
func (*RestRoute) Descriptor
deprecated
func (*RestRoute) GetMethods ¶
func (x *RestRoute) GetMethods() []HTTPMethod
func (*RestRoute) ProtoMessage ¶
func (*RestRoute) ProtoMessage()
func (*RestRoute) ProtoReflect ¶
func (x *RestRoute) ProtoReflect() protoreflect.Message
type Service ¶
type Service struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` Application string `protobuf:"bytes,3,opt,name=application,proto3" json:"application,omitempty"` Agent *Agent `protobuf:"bytes,4,opt,name=agent,proto3" json:"agent,omitempty"` Endpoints []*Endpoint `protobuf:"bytes,5,rep,name=endpoints,proto3" json:"endpoints,omitempty"` // contains filtered or unexported fields }
Service is the fundamental "live" computing unit of a system It belongs to an application It is "hosted" by an agent It has a set of endpoints
func (*Service) Descriptor
deprecated
func (*Service) GetApplication ¶
func (*Service) GetDescription ¶
func (*Service) GetEndpoints ¶
func (*Service) ProtoMessage ¶
func (*Service) ProtoMessage()
func (*Service) ProtoReflect ¶
func (x *Service) ProtoReflect() protoreflect.Message
type ServiceIdentity ¶
type ServiceIdentity struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Domain string `protobuf:"bytes,2,opt,name=domain,proto3" json:"domain,omitempty"` Application string `protobuf:"bytes,3,opt,name=application,proto3" json:"application,omitempty"` Namespace string `protobuf:"bytes,4,opt,name=namespace,proto3" json:"namespace,omitempty"` Location string `protobuf:"bytes,5,opt,name=location,proto3" json:"location,omitempty"` // contains filtered or unexported fields }
ServiceIdentity is the identity of a service It has several component depending on how we look at a software system: - Logical: corresponds to the Bounded Context of DDD - Resource: corresponds to a logical or computational group - Physical: corresponds to a physical group, where the code lives!
func (*ServiceIdentity) Descriptor
deprecated
func (*ServiceIdentity) Descriptor() ([]byte, []int)
Deprecated: Use ServiceIdentity.ProtoReflect.Descriptor instead.
func (*ServiceIdentity) GetApplication ¶
func (x *ServiceIdentity) GetApplication() string
func (*ServiceIdentity) GetDomain ¶
func (x *ServiceIdentity) GetDomain() string
func (*ServiceIdentity) GetLocation ¶
func (x *ServiceIdentity) GetLocation() string
func (*ServiceIdentity) GetName ¶
func (x *ServiceIdentity) GetName() string
func (*ServiceIdentity) GetNamespace ¶
func (x *ServiceIdentity) GetNamespace() string
func (*ServiceIdentity) ProtoMessage ¶
func (*ServiceIdentity) ProtoMessage()
func (*ServiceIdentity) ProtoReflect ¶
func (x *ServiceIdentity) ProtoReflect() protoreflect.Message
func (*ServiceIdentity) Reset ¶
func (x *ServiceIdentity) Reset()
func (*ServiceIdentity) String ¶
func (x *ServiceIdentity) String() string
type TcpAPI ¶
type TcpAPI struct {
// contains filtered or unexported fields
}
func (*TcpAPI) Descriptor
deprecated
func (*TcpAPI) ProtoMessage ¶
func (*TcpAPI) ProtoMessage()
func (*TcpAPI) ProtoReflect ¶
func (x *TcpAPI) ProtoReflect() protoreflect.Message
type Version ¶
type Version struct { Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"` // contains filtered or unexported fields }
func (*Version) Descriptor
deprecated
func (*Version) GetVersion ¶
func (*Version) ProtoMessage ¶
func (*Version) ProtoMessage()
func (*Version) ProtoReflect ¶
func (x *Version) ProtoReflect() protoreflect.Message