v0

package
v0.1.158 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 2, 2026 License: MIT Imports: 7 Imported by: 7

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Agent_Kind_name = map[int32]string{
		0: "UNKNOWN",
		1: "SERVICE",
		2: "JOB",
		3: "APPLICATION",
		4: "MODULE",
		5: "TOOLBOX",
	}
	Agent_Kind_value = map[string]int32{
		"UNKNOWN":     0,
		"SERVICE":     1,
		"JOB":         2,
		"APPLICATION": 3,
		"MODULE":      4,
		"TOOLBOX":     5,
	}
)

Enum value maps for Agent_Kind.

View Source
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.

View Source
var File_codefly_base_v0_agent_proto protoreflect.FileDescriptor
View Source
var File_codefly_base_v0_application_proto protoreflect.FileDescriptor
View Source
var File_codefly_base_v0_configuration_proto protoreflect.FileDescriptor
View Source
var File_codefly_base_v0_endpoint_proto protoreflect.FileDescriptor
View Source
var File_codefly_base_v0_environment_proto protoreflect.FileDescriptor
View Source
var File_codefly_base_v0_library_proto protoreflect.FileDescriptor
View Source
var File_codefly_base_v0_module_proto protoreflect.FileDescriptor
View Source
var File_codefly_base_v0_network_proto protoreflect.FileDescriptor
View Source
var File_codefly_base_v0_organization_proto protoreflect.FileDescriptor
View Source
var File_codefly_base_v0_scope_proto protoreflect.FileDescriptor
View Source
var File_codefly_base_v0_service_proto protoreflect.FileDescriptor
View Source
var File_codefly_base_v0_spec_proto protoreflect.FileDescriptor
View Source
var File_codefly_base_v0_workspace_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type API

type API struct {

	// value selects exactly one supported value variant.
	//
	// Types that are valid to be assigned to Value:
	//
	//	*API_Tcp
	//	*API_Http
	//	*API_Rest
	//	*API_Grpc
	Value isAPI_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

API selects protocol-specific endpoint details.

func (*API) Descriptor deprecated

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

Deprecated: Use API.ProtoReflect.Descriptor instead.

func (*API) GetGrpc

func (x *API) GetGrpc() *GrpcAPI

func (*API) GetHttp

func (x *API) GetHttp() *HttpAPI

func (*API) GetRest

func (x *API) GetRest() *RestAPI

func (*API) GetTcp

func (x *API) GetTcp() *TcpAPI

func (*API) GetValue

func (x *API) GetValue() isAPI_Value

func (*API) ProtoMessage

func (*API) ProtoMessage()

func (*API) ProtoReflect

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

func (*API) Reset

func (x *API) Reset()

func (*API) String

func (x *API) String() string

type API_Grpc

type API_Grpc struct {
	// grpc carries protocol details for a gRPC endpoint with protobuf descriptors.
	Grpc *GrpcAPI `protobuf:"bytes,4,opt,name=grpc,proto3,oneof"`
}

type API_Http

type API_Http struct {
	// http carries protocol details for a generic HTTP endpoint.
	Http *HttpAPI `protobuf:"bytes,2,opt,name=http,proto3,oneof"`
}

type API_Rest

type API_Rest struct {
	// rest carries protocol details for a REST endpoint with routes and OpenAPI metadata.
	Rest *RestAPI `protobuf:"bytes,3,opt,name=rest,proto3,oneof"`
}

type API_Tcp

type API_Tcp struct {
	// tcp carries protocol details for a raw TCP endpoint.
	Tcp *TcpAPI `protobuf:"bytes,1,opt,name=tcp,proto3,oneof"`
}

type Agent

type Agent struct {

	// kind identifies which resource family this agent can manage.
	Kind Agent_Kind `protobuf:"varint,1,opt,name=kind,proto3,enum=codefly.base.v0.Agent_Kind" json:"kind,omitempty"`
	// name is the agent plugin name.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// publisher is the namespace that published the agent or resource.
	Publisher string `protobuf:"bytes,3,opt,name=publisher,proto3" json:"publisher,omitempty"`
	// version is the semantic or service-specific version for this resource.
	Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

Agent identifies the plugin binary that owns a service, job, application, module, or toolbox lifecycle.

func (*Agent) Descriptor deprecated

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

Deprecated: Use Agent.ProtoReflect.Descriptor instead.

func (*Agent) GetKind

func (x *Agent) GetKind() Agent_Kind

func (*Agent) GetName

func (x *Agent) GetName() string

func (*Agent) GetPublisher

func (x *Agent) GetPublisher() string

func (*Agent) GetVersion

func (x *Agent) GetVersion() string

func (*Agent) ProtoMessage

func (*Agent) ProtoMessage()

func (*Agent) ProtoReflect

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

func (*Agent) Reset

func (x *Agent) Reset()

func (*Agent) String

func (x *Agent) String() string

type Agent_Kind

type Agent_Kind int32

Kind enumerates supported kinds.

const (
	// UNKNOWN is the default value when kind is not specified.
	Agent_UNKNOWN Agent_Kind = 0
	// SERVICE agents own runtime and builder lifecycle for deployable services.
	Agent_SERVICE Agent_Kind = 1
	// JOB agents own scheduled or one-shot job lifecycles.
	Agent_JOB Agent_Kind = 2
	// APPLICATION agents own end-user application generation and artifacts.
	Agent_APPLICATION Agent_Kind = 3
	// MODULE agents own module-level scaffolding or orchestration.
	Agent_MODULE Agent_Kind = 4
	// TOOLBOX is a narrow, capability-focused plugin (Code, Git, Docker,
	// Nix, Bash, Web, gRPC). Distinct from SERVICE: services are
	// user-deployable processes; toolboxes are codefly-platform utilities
	// that agents call via MCP-shape Tool/Resource/Prompt RPCs. Each
	// toolbox carries its own permission boundary (sandbox + canonical_for
	// declarations in the manifest).
	Agent_TOOLBOX Agent_Kind = 5
)

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

type Application added in v0.1.155

type Application struct {

	// Name of the application
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Short description of the application
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Agent that represents the application
	Agent *Agent `protobuf:"bytes,3,opt,name=agent,proto3" json:"agent,omitempty"`
	// Service dependencies
	ServiceDependencies []*ServiceReference `protobuf:"bytes,4,rep,name=service_dependencies,json=serviceDependencies,proto3" json:"service_dependencies,omitempty"`
	// Application dependencies
	ApplicationDependencies []*ApplicationReference `` /* 130-byte string literal not displayed */
	// Build artifacts
	Artifacts []*Artifact `protobuf:"bytes,6,rep,name=artifacts,proto3" json:"artifacts,omitempty"`
	// contains filtered or unexported fields
}

Application is an end-user facing program (CLI, desktop app, etc.) Unlike services, applications don't expose network endpoints They produce artifacts (binaries, bundles) and can depend on services and other applications

func (*Application) Descriptor deprecated added in v0.1.155

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

Deprecated: Use Application.ProtoReflect.Descriptor instead.

func (*Application) GetAgent added in v0.1.155

func (x *Application) GetAgent() *Agent

func (*Application) GetApplicationDependencies added in v0.1.155

func (x *Application) GetApplicationDependencies() []*ApplicationReference

func (*Application) GetArtifacts added in v0.1.155

func (x *Application) GetArtifacts() []*Artifact

func (*Application) GetDescription added in v0.1.155

func (x *Application) GetDescription() string

func (*Application) GetName added in v0.1.155

func (x *Application) GetName() string

func (*Application) GetServiceDependencies added in v0.1.155

func (x *Application) GetServiceDependencies() []*ServiceReference

func (*Application) ProtoMessage added in v0.1.155

func (*Application) ProtoMessage()

func (*Application) ProtoReflect added in v0.1.155

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

func (*Application) Reset added in v0.1.155

func (x *Application) Reset()

func (*Application) String added in v0.1.155

func (x *Application) String() string

type ApplicationIdentity added in v0.1.155

type ApplicationIdentity struct {

	// name is the application name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// module is the Codefly module name that groups services.
	Module string `protobuf:"bytes,2,opt,name=module,proto3" json:"module,omitempty"`
	// workspace is the Codefly workspace name that scopes modules and services.
	Workspace string `protobuf:"bytes,3,opt,name=workspace,proto3" json:"workspace,omitempty"`
	// version is the semantic or service-specific version for this resource.
	Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

ApplicationIdentity is the identity of an application in a workspace

func (*ApplicationIdentity) Descriptor deprecated added in v0.1.155

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

Deprecated: Use ApplicationIdentity.ProtoReflect.Descriptor instead.

func (*ApplicationIdentity) GetModule added in v0.1.155

func (x *ApplicationIdentity) GetModule() string

func (*ApplicationIdentity) GetName added in v0.1.155

func (x *ApplicationIdentity) GetName() string

func (*ApplicationIdentity) GetVersion added in v0.1.155

func (x *ApplicationIdentity) GetVersion() string

func (*ApplicationIdentity) GetWorkspace added in v0.1.155

func (x *ApplicationIdentity) GetWorkspace() string

func (*ApplicationIdentity) ProtoMessage added in v0.1.155

func (*ApplicationIdentity) ProtoMessage()

func (*ApplicationIdentity) ProtoReflect added in v0.1.155

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

func (*ApplicationIdentity) Reset added in v0.1.155

func (x *ApplicationIdentity) Reset()

func (*ApplicationIdentity) String added in v0.1.155

func (x *ApplicationIdentity) String() string

type ApplicationReference added in v0.1.155

type ApplicationReference struct {

	// name is the application name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// module is the Codefly module name that groups services.
	Module string `protobuf:"bytes,2,opt,name=module,proto3" json:"module,omitempty"`
	// contains filtered or unexported fields
}

ApplicationReference names another application inside a module.

func (*ApplicationReference) Descriptor deprecated added in v0.1.155

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

Deprecated: Use ApplicationReference.ProtoReflect.Descriptor instead.

func (*ApplicationReference) GetModule added in v0.1.155

func (x *ApplicationReference) GetModule() string

func (*ApplicationReference) GetName added in v0.1.155

func (x *ApplicationReference) GetName() string

func (*ApplicationReference) ProtoMessage added in v0.1.155

func (*ApplicationReference) ProtoMessage()

func (*ApplicationReference) ProtoReflect added in v0.1.155

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

func (*ApplicationReference) Reset added in v0.1.155

func (x *ApplicationReference) Reset()

func (*ApplicationReference) String added in v0.1.155

func (x *ApplicationReference) String() string

type Artifact added in v0.1.155

type Artifact struct {

	// Name of the artifact
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Type of artifact: "binary", "bundle", "package"
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Target platform: "darwin-arm64", "linux-amd64", etc.
	Platform string `protobuf:"bytes,3,opt,name=platform,proto3" json:"platform,omitempty"`
	// Path to the artifact
	Path string `protobuf:"bytes,4,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

Artifact represents a build output from an application

func (*Artifact) Descriptor deprecated added in v0.1.155

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

Deprecated: Use Artifact.ProtoReflect.Descriptor instead.

func (*Artifact) GetName added in v0.1.155

func (x *Artifact) GetName() string

func (*Artifact) GetPath added in v0.1.155

func (x *Artifact) GetPath() string

func (*Artifact) GetPlatform added in v0.1.155

func (x *Artifact) GetPlatform() string

func (*Artifact) GetType added in v0.1.155

func (x *Artifact) GetType() string

func (*Artifact) ProtoMessage added in v0.1.155

func (*Artifact) ProtoMessage()

func (*Artifact) ProtoReflect added in v0.1.155

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

func (*Artifact) Reset added in v0.1.155

func (x *Artifact) Reset()

func (*Artifact) String added in v0.1.155

func (x *Artifact) String() string

type Configuration

type Configuration struct {

	// origin identifies the service or workspace that produced the configuration.
	Origin string `protobuf:"bytes,1,opt,name=origin,proto3" json:"origin,omitempty"`
	// runtime_context describes where the service runs, such as native, nix, container, or free.
	RuntimeContext *RuntimeContext `protobuf:"bytes,2,opt,name=runtime_context,json=runtimeContext,proto3" json:"runtime_context,omitempty"`
	// infos are named configuration groups exposed by a producer.
	Infos []*ConfigurationInformation `protobuf:"bytes,3,rep,name=infos,proto3" json:"infos,omitempty"`
	// contains filtered or unexported fields
}

Configuration can come from - workspace: origin is _workspace - service: origin is the service unique Information is a grouping of configuration values

func (*Configuration) Descriptor deprecated

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

Deprecated: Use Configuration.ProtoReflect.Descriptor instead.

func (*Configuration) GetInfos added in v0.1.123

func (x *Configuration) GetInfos() []*ConfigurationInformation

func (*Configuration) GetOrigin

func (x *Configuration) GetOrigin() string

func (*Configuration) GetRuntimeContext

func (x *Configuration) GetRuntimeContext() *RuntimeContext

func (*Configuration) ProtoMessage

func (*Configuration) ProtoMessage()

func (*Configuration) ProtoReflect

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

func (*Configuration) Reset

func (x *Configuration) Reset()

func (*Configuration) String

func (x *Configuration) String() string

type ConfigurationData added in v0.1.127

type ConfigurationData struct {

	// kind identifies the format or producer-specific type of this configuration blob.
	Kind string `protobuf:"bytes,1,opt,name=kind,proto3" json:"kind,omitempty"`
	// content is the full file, resource, prompt, or response body.
	Content []byte `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// secret marks configuration values that must not be logged or displayed.
	Secret bool `protobuf:"varint,3,opt,name=secret,proto3" json:"secret,omitempty"`
	// contains filtered or unexported fields
}

ConfigurationData carries a structured configuration blob alongside key/value configuration.

func (*ConfigurationData) Descriptor deprecated added in v0.1.127

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

Deprecated: Use ConfigurationData.ProtoReflect.Descriptor instead.

func (*ConfigurationData) GetContent added in v0.1.127

func (x *ConfigurationData) GetContent() []byte

func (*ConfigurationData) GetKind added in v0.1.127

func (x *ConfigurationData) GetKind() string

func (*ConfigurationData) GetSecret added in v0.1.127

func (x *ConfigurationData) GetSecret() bool

func (*ConfigurationData) ProtoMessage added in v0.1.127

func (*ConfigurationData) ProtoMessage()

func (*ConfigurationData) ProtoReflect added in v0.1.127

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

func (*ConfigurationData) Reset added in v0.1.127

func (x *ConfigurationData) Reset()

func (*ConfigurationData) String added in v0.1.127

func (x *ConfigurationData) String() string

type ConfigurationInformation

type ConfigurationInformation struct {

	// name is the configuration group name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// configuration_values are key/value pairs exposed by a configuration entry.
	ConfigurationValues []*ConfigurationValue `protobuf:"bytes,2,rep,name=configuration_values,json=configurationValues,proto3" json:"configuration_values,omitempty"`
	// data is an optional structured configuration payload for values that do not fit key/value pairs.
	Data *ConfigurationData `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

ConfigurationInformation groups named configuration values produced by a service or workspace.

func (*ConfigurationInformation) Descriptor deprecated

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

Deprecated: Use ConfigurationInformation.ProtoReflect.Descriptor instead.

func (*ConfigurationInformation) GetConfigurationValues

func (x *ConfigurationInformation) GetConfigurationValues() []*ConfigurationValue

func (*ConfigurationInformation) GetData added in v0.1.127

func (*ConfigurationInformation) GetName

func (x *ConfigurationInformation) GetName() string

func (*ConfigurationInformation) ProtoMessage

func (*ConfigurationInformation) ProtoMessage()

func (*ConfigurationInformation) ProtoReflect

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

func (*ConfigurationInformation) Reset

func (x *ConfigurationInformation) Reset()

func (*ConfigurationInformation) String

func (x *ConfigurationInformation) String() string

type ConfigurationValue

type ConfigurationValue struct {

	// key is the configuration or schema property name.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// value is the configuration or schema value.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// secret marks configuration values that must not be logged or displayed.
	Secret bool `protobuf:"varint,3,opt,name=secret,proto3" json:"secret,omitempty"`
	// contains filtered or unexported fields
}

ConfigurationValue is one key/value pair produced by a service or workspace configuration source.

func (*ConfigurationValue) Descriptor deprecated

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

Deprecated: Use ConfigurationValue.ProtoReflect.Descriptor instead.

func (*ConfigurationValue) GetKey

func (x *ConfigurationValue) GetKey() string

func (*ConfigurationValue) GetSecret

func (x *ConfigurationValue) GetSecret() bool

func (*ConfigurationValue) GetValue

func (x *ConfigurationValue) GetValue() string

func (*ConfigurationValue) ProtoMessage

func (*ConfigurationValue) ProtoMessage()

func (*ConfigurationValue) ProtoReflect

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

func (*ConfigurationValue) Reset

func (x *ConfigurationValue) Reset()

func (*ConfigurationValue) String

func (x *ConfigurationValue) String() string

type DNS

type DNS struct {

	// The name of the DNS record
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The module name
	Module string `protobuf:"bytes,2,opt,name=module,proto3" json:"module,omitempty"`
	// The service name
	Service string `protobuf:"bytes,3,opt,name=service,proto3" json:"service,omitempty"`
	// The endpoint name
	Endpoint string `protobuf:"bytes,4,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// The network instance name
	Host string `protobuf:"bytes,5,opt,name=host,proto3" json:"host,omitempty"`
	// The network instance port
	Port uint32 `protobuf:"varint,6,opt,name=port,proto3" json:"port,omitempty"`
	// secured is true when the endpoint should be reached with TLS.
	Secured bool `protobuf:"varint,7,opt,name=secured,proto3" json:"secured,omitempty"`
	// contains filtered or unexported fields
}

DNS describes a resolved address for an endpoint in a target environment.

func (*DNS) Descriptor deprecated

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

Deprecated: Use DNS.ProtoReflect.Descriptor instead.

func (*DNS) GetEndpoint

func (x *DNS) GetEndpoint() string

func (*DNS) GetHost

func (x *DNS) GetHost() string

func (*DNS) GetModule

func (x *DNS) GetModule() string

func (*DNS) GetName

func (x *DNS) GetName() string

func (*DNS) GetPort

func (x *DNS) GetPort() uint32

func (*DNS) GetSecured

func (x *DNS) GetSecured() bool

func (*DNS) GetService

func (x *DNS) GetService() string

func (*DNS) ProtoMessage

func (*DNS) ProtoMessage()

func (*DNS) ProtoReflect

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

func (*DNS) Reset

func (x *DNS) Reset()

func (*DNS) String

func (x *DNS) String() string

type Endpoint

type Endpoint struct {

	// name is the endpoint identifier, often matching the API type such as http, grpc, or tcp.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// service is the service that owns this endpoint.
	Service string `protobuf:"bytes,2,opt,name=service,proto3" json:"service,omitempty"`
	// module is the module that contains the owning service.
	Module string `protobuf:"bytes,3,opt,name=module,proto3" json:"module,omitempty"`
	// description explains what this endpoint is used for.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// visibility controls whether this endpoint is private, module-visible, public, or external.
	Visibility string `protobuf:"bytes,5,opt,name=visibility,proto3" json:"visibility,omitempty"`
	// api describes the protocol exposed by the endpoint.
	Api string `protobuf:"bytes,6,opt,name=api,proto3" json:"api,omitempty"`
	// api_details contains protocol-specific endpoint metadata.
	ApiDetails *API `protobuf:"bytes,7,opt,name=api_details,json=apiDetails,proto3" json:"api_details,omitempty"`
	// contains filtered or unexported fields
}

Endpoint is a logical API exposed by a service and later resolved into network mappings.

func (*Endpoint) Descriptor deprecated

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

Deprecated: Use Endpoint.ProtoReflect.Descriptor instead.

func (*Endpoint) GetApi

func (x *Endpoint) GetApi() string

func (*Endpoint) GetApiDetails

func (x *Endpoint) GetApiDetails() *API

func (*Endpoint) GetDescription

func (x *Endpoint) GetDescription() string

func (*Endpoint) GetModule

func (x *Endpoint) GetModule() string

func (*Endpoint) GetName

func (x *Endpoint) GetName() string

func (*Endpoint) GetService

func (x *Endpoint) GetService() string

func (*Endpoint) GetVisibility

func (x *Endpoint) GetVisibility() string

func (*Endpoint) ProtoMessage

func (*Endpoint) ProtoMessage()

func (*Endpoint) ProtoReflect

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

func (*Endpoint) Reset

func (x *Endpoint) Reset()

func (*Endpoint) String

func (x *Endpoint) String() string

type Environment

type Environment struct {

	// The name of the environment
	// Must be unique within a workspace
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A brief description of the environment.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// naming_scope distinguishes otherwise similar test or ephemeral environments.
	NamingScope string `protobuf:"bytes,3,opt,name=naming_scope,json=namingScope,proto3" json:"naming_scope,omitempty"`
	// contains filtered or unexported fields
}

Environment names a deployment target such as local, staging, or production.

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) GetNamingScope added in v0.1.123

func (x *Environment) GetNamingScope() 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 GenericValue

type GenericValue struct {

	// value is the configuration or specification value.
	Value []byte `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"` // Could also be a string if you prefer JSON
	// contains filtered or unexported fields
}

GenericValue carries opaque bytes for legacy or dynamically typed agent settings.

func (*GenericValue) Descriptor deprecated

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

Deprecated: Use GenericValue.ProtoReflect.Descriptor instead.

func (*GenericValue) GetValue

func (x *GenericValue) GetValue() []byte

func (*GenericValue) ProtoMessage

func (*GenericValue) ProtoMessage()

func (*GenericValue) ProtoReflect

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

func (*GenericValue) Reset

func (x *GenericValue) Reset()

func (*GenericValue) String

func (x *GenericValue) String() string

type GitConfig added in v0.1.155

type GitConfig struct {

	// remote is the git remote URL for this library.
	Remote string `protobuf:"bytes,1,opt,name=remote,proto3" json:"remote,omitempty"` // Git remote URL (optional for local libs)
	// branch is the git branch used for this library.
	Branch string `protobuf:"bytes,2,opt,name=branch,proto3" json:"branch,omitempty"` // Default branch
	// commit is the pinned git commit for this library.
	Commit string `protobuf:"bytes,3,opt,name=commit,proto3" json:"commit,omitempty"` // Pinned commit hash (optional)
	// tag is the pinned git tag for this library.
	Tag string `protobuf:"bytes,4,opt,name=tag,proto3" json:"tag,omitempty"` // Version tag (optional)
	// contains filtered or unexported fields
}

GitConfig for libraries that are git repositories (or submodules)

func (*GitConfig) Descriptor deprecated added in v0.1.155

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

Deprecated: Use GitConfig.ProtoReflect.Descriptor instead.

func (*GitConfig) GetBranch added in v0.1.155

func (x *GitConfig) GetBranch() string

func (*GitConfig) GetCommit added in v0.1.155

func (x *GitConfig) GetCommit() string

func (*GitConfig) GetRemote added in v0.1.155

func (x *GitConfig) GetRemote() string

func (*GitConfig) GetTag added in v0.1.155

func (x *GitConfig) GetTag() string

func (*GitConfig) ProtoMessage added in v0.1.155

func (*GitConfig) ProtoMessage()

func (*GitConfig) ProtoReflect added in v0.1.155

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

func (*GitConfig) Reset added in v0.1.155

func (x *GitConfig) Reset()

func (*GitConfig) String added in v0.1.155

func (x *GitConfig) String() string

type GrpcAPI

type GrpcAPI struct {

	// service is the Codefly service name, optionally scoped by module in callers.
	Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
	// module is the Codefly module name that groups services.
	Module string `protobuf:"bytes,2,opt,name=module,proto3" json:"module,omitempty"`
	// package is the package, dependency, or artifact name.
	Package string `protobuf:"bytes,3,opt,name=package,proto3" json:"package,omitempty"`
	// rpcs are the callable methods exposed by this gRPC endpoint.
	Rpcs []*RPC `protobuf:"bytes,4,rep,name=rpcs,proto3" json:"rpcs,omitempty"`
	// proto is the serialized protobuf descriptor data for gRPC endpoints.
	Proto []byte `protobuf:"bytes,5,opt,name=proto,proto3" json:"proto,omitempty"`
	// secured is true when the endpoint expects TLS or equivalent transport security.
	Secured bool `protobuf:"varint,6,opt,name=secured,proto3" json:"secured,omitempty"`
	// contains filtered or unexported fields
}

GrpcAPI describes a gRPC API endpoint and its service descriptors.

func (*GrpcAPI) Descriptor deprecated

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

Deprecated: Use GrpcAPI.ProtoReflect.Descriptor instead.

func (*GrpcAPI) GetModule

func (x *GrpcAPI) GetModule() string

func (*GrpcAPI) GetPackage

func (x *GrpcAPI) GetPackage() string

func (*GrpcAPI) GetProto

func (x *GrpcAPI) GetProto() []byte

func (*GrpcAPI) GetRpcs

func (x *GrpcAPI) GetRpcs() []*RPC

func (*GrpcAPI) GetSecured

func (x *GrpcAPI) GetSecured() bool

func (*GrpcAPI) GetService

func (x *GrpcAPI) GetService() string

func (*GrpcAPI) ProtoMessage

func (*GrpcAPI) ProtoMessage()

func (*GrpcAPI) ProtoReflect

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

func (*GrpcAPI) Reset

func (x *GrpcAPI) Reset()

func (*GrpcAPI) String

func (x *GrpcAPI) String() string

type HTTPMethod

type HTTPMethod int32

HTTPMethod enumerates HTTP methods.

const (
	// GET is the HTTP GET method.
	HTTPMethod_GET HTTPMethod = 0
	// POST is the HTTP POST method.
	HTTPMethod_POST HTTPMethod = 1
	// PUT is the HTTP PUT method.
	HTTPMethod_PUT HTTPMethod = 2
	// DELETE is the HTTP DELETE method.
	HTTPMethod_DELETE HTTPMethod = 3
	// PATCH is the HTTP PATCH method.
	HTTPMethod_PATCH HTTPMethod = 4
	// OPTIONS is the HTTP OPTIONS method.
	HTTPMethod_OPTIONS HTTPMethod = 5
	// HEAD is the HTTP HEAD method.
	HTTPMethod_HEAD HTTPMethod = 6
	// CONNECT is the HTTP CONNECT method.
	HTTPMethod_CONNECT HTTPMethod = 7
	// TRACE is the HTTP TRACE method.
	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

type HttpAPI

type HttpAPI struct {

	// secured is true when the endpoint expects TLS or equivalent transport security.
	Secured bool `protobuf:"varint,1,opt,name=secured,proto3" json:"secured,omitempty"`
	// contains filtered or unexported fields
}

HttpAPI describes an HTTP endpoint.

func (*HttpAPI) Descriptor deprecated

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

Deprecated: Use HttpAPI.ProtoReflect.Descriptor instead.

func (*HttpAPI) GetSecured

func (x *HttpAPI) GetSecured() bool

func (*HttpAPI) ProtoMessage

func (*HttpAPI) ProtoMessage()

func (*HttpAPI) ProtoReflect

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

func (*HttpAPI) Reset

func (x *HttpAPI) Reset()

func (*HttpAPI) String

func (x *HttpAPI) String() string

type InterfaceEndpoint added in v0.1.155

type InterfaceEndpoint struct {

	// The service that owns this endpoint
	Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
	// The endpoint name within the service
	Endpoint string `protobuf:"bytes,2,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Visibility level: "module" or "public"
	Visibility string `protobuf:"bytes,3,opt,name=visibility,proto3" json:"visibility,omitempty"`
	// contains filtered or unexported fields
}

InterfaceEndpoint declares a single endpoint exposed by the module.

func (*InterfaceEndpoint) Descriptor deprecated added in v0.1.155

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

Deprecated: Use InterfaceEndpoint.ProtoReflect.Descriptor instead.

func (*InterfaceEndpoint) GetEndpoint added in v0.1.155

func (x *InterfaceEndpoint) GetEndpoint() string

func (*InterfaceEndpoint) GetService added in v0.1.155

func (x *InterfaceEndpoint) GetService() string

func (*InterfaceEndpoint) GetVisibility added in v0.1.155

func (x *InterfaceEndpoint) GetVisibility() string

func (*InterfaceEndpoint) ProtoMessage added in v0.1.155

func (*InterfaceEndpoint) ProtoMessage()

func (*InterfaceEndpoint) ProtoReflect added in v0.1.155

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

func (*InterfaceEndpoint) Reset added in v0.1.155

func (x *InterfaceEndpoint) Reset()

func (*InterfaceEndpoint) String added in v0.1.155

func (x *InterfaceEndpoint) String() string

type LanguageExport added in v0.1.155

type LanguageExport struct {

	// name is the language name for this export.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Language name: "go", "python", "typescript"
	// agent is the library agent or generator responsible for this language export.
	Agent string `protobuf:"bytes,2,opt,name=agent,proto3" json:"agent,omitempty"` // Library agent identifier
	// path is a workspace- or service-relative filesystem path.
	Path string `protobuf:"bytes,3,opt,name=path,proto3" json:"path,omitempty"` // Relative path to language-specific code
	// exports describes language-specific packages exposed by the library.
	Exports []string `protobuf:"bytes,4,rep,name=exports,proto3" json:"exports,omitempty"` // Package/module names exported
	// contains filtered or unexported fields
}

LanguageExport defines how a library is exported for a specific language

func (*LanguageExport) Descriptor deprecated added in v0.1.155

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

Deprecated: Use LanguageExport.ProtoReflect.Descriptor instead.

func (*LanguageExport) GetAgent added in v0.1.155

func (x *LanguageExport) GetAgent() string

func (*LanguageExport) GetExports added in v0.1.155

func (x *LanguageExport) GetExports() []string

func (*LanguageExport) GetName added in v0.1.155

func (x *LanguageExport) GetName() string

func (*LanguageExport) GetPath added in v0.1.155

func (x *LanguageExport) GetPath() string

func (*LanguageExport) ProtoMessage added in v0.1.155

func (*LanguageExport) ProtoMessage()

func (*LanguageExport) ProtoReflect added in v0.1.155

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

func (*LanguageExport) Reset added in v0.1.155

func (x *LanguageExport) Reset()

func (*LanguageExport) String added in v0.1.155

func (x *LanguageExport) String() string

type Library added in v0.1.155

type Library struct {

	// name is the library name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// description is the human-readable library description.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// version is the semantic or service-specific version for this resource.
	Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	// languages describes how this library is exported to each supported language.
	Languages []*LanguageExport `protobuf:"bytes,4,rep,name=languages,proto3" json:"languages,omitempty"`
	// git is repository or submodule metadata for this library.
	Git *GitConfig `protobuf:"bytes,5,opt,name=git,proto3" json:"git,omitempty"`
	// library_dependencies are other internal libraries required by this library.
	LibraryDependencies []*LibraryReference `protobuf:"bytes,6,rep,name=library_dependencies,json=libraryDependencies,proto3" json:"library_dependencies,omitempty"`
	// contains filtered or unexported fields
}

Library represents internal shared code that can be used by services

func (*Library) Descriptor deprecated added in v0.1.155

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

Deprecated: Use Library.ProtoReflect.Descriptor instead.

func (*Library) GetDescription added in v0.1.155

func (x *Library) GetDescription() string

func (*Library) GetGit added in v0.1.155

func (x *Library) GetGit() *GitConfig

func (*Library) GetLanguages added in v0.1.155

func (x *Library) GetLanguages() []*LanguageExport

func (*Library) GetLibraryDependencies added in v0.1.155

func (x *Library) GetLibraryDependencies() []*LibraryReference

func (*Library) GetName added in v0.1.155

func (x *Library) GetName() string

func (*Library) GetVersion added in v0.1.155

func (x *Library) GetVersion() string

func (*Library) ProtoMessage added in v0.1.155

func (*Library) ProtoMessage()

func (*Library) ProtoReflect added in v0.1.155

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

func (*Library) Reset added in v0.1.155

func (x *Library) Reset()

func (*Library) String added in v0.1.155

func (x *Library) String() string

type LibraryDependency added in v0.1.155

type LibraryDependency struct {

	// name is the library dependency name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// version is the semantic or service-specific version for this resource.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"` // Semver constraint
	// languages identifies which language exports or generators apply.
	Languages []string `protobuf:"bytes,3,rep,name=languages,proto3" json:"languages,omitempty"` // Which language exports are needed
	// contains filtered or unexported fields
}

LibraryDependency is used when a service depends on a library

func (*LibraryDependency) Descriptor deprecated added in v0.1.155

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

Deprecated: Use LibraryDependency.ProtoReflect.Descriptor instead.

func (*LibraryDependency) GetLanguages added in v0.1.155

func (x *LibraryDependency) GetLanguages() []string

func (*LibraryDependency) GetName added in v0.1.155

func (x *LibraryDependency) GetName() string

func (*LibraryDependency) GetVersion added in v0.1.155

func (x *LibraryDependency) GetVersion() string

func (*LibraryDependency) ProtoMessage added in v0.1.155

func (*LibraryDependency) ProtoMessage()

func (*LibraryDependency) ProtoReflect added in v0.1.155

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

func (*LibraryDependency) Reset added in v0.1.155

func (x *LibraryDependency) Reset()

func (*LibraryDependency) String added in v0.1.155

func (x *LibraryDependency) String() string

type LibraryIdentity added in v0.1.155

type LibraryIdentity struct {

	// name is the library name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// workspace is the Codefly workspace name that scopes modules and services.
	Workspace string `protobuf:"bytes,2,opt,name=workspace,proto3" json:"workspace,omitempty"`
	// version is the semantic or service-specific version for this resource.
	Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	// path is a workspace- or service-relative filesystem path.
	Path string `protobuf:"bytes,4,opt,name=path,proto3" json:"path,omitempty"` // Absolute path to library
	// contains filtered or unexported fields
}

LibraryIdentity uniquely identifies a library

func (*LibraryIdentity) Descriptor deprecated added in v0.1.155

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

Deprecated: Use LibraryIdentity.ProtoReflect.Descriptor instead.

func (*LibraryIdentity) GetName added in v0.1.155

func (x *LibraryIdentity) GetName() string

func (*LibraryIdentity) GetPath added in v0.1.155

func (x *LibraryIdentity) GetPath() string

func (*LibraryIdentity) GetVersion added in v0.1.155

func (x *LibraryIdentity) GetVersion() string

func (*LibraryIdentity) GetWorkspace added in v0.1.155

func (x *LibraryIdentity) GetWorkspace() string

func (*LibraryIdentity) ProtoMessage added in v0.1.155

func (*LibraryIdentity) ProtoMessage()

func (*LibraryIdentity) ProtoReflect added in v0.1.155

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

func (*LibraryIdentity) Reset added in v0.1.155

func (x *LibraryIdentity) Reset()

func (*LibraryIdentity) String added in v0.1.155

func (x *LibraryIdentity) String() string

type LibraryReference added in v0.1.155

type LibraryReference struct {

	// name is the referenced library name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// version is the semantic or service-specific version for this resource.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"` // Semver constraint (e.g., ">=1.0.0")
	// contains filtered or unexported fields
}

LibraryReference is used for dependencies between libraries

func (*LibraryReference) Descriptor deprecated added in v0.1.155

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

Deprecated: Use LibraryReference.ProtoReflect.Descriptor instead.

func (*LibraryReference) GetName added in v0.1.155

func (x *LibraryReference) GetName() string

func (*LibraryReference) GetVersion added in v0.1.155

func (x *LibraryReference) GetVersion() string

func (*LibraryReference) ProtoMessage added in v0.1.155

func (*LibraryReference) ProtoMessage()

func (*LibraryReference) ProtoReflect added in v0.1.155

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

func (*LibraryReference) Reset added in v0.1.155

func (x *LibraryReference) Reset()

func (*LibraryReference) String added in v0.1.155

func (x *LibraryReference) String() string

type ManagedEnvironment

type ManagedEnvironment struct {

	// id is the stable identifier for this record.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

ManagedEnvironment is the platform-managed representation of an environment.

func (*ManagedEnvironment) Descriptor deprecated

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

Deprecated: Use ManagedEnvironment.ProtoReflect.Descriptor instead.

func (*ManagedEnvironment) GetId

func (x *ManagedEnvironment) GetId() string

func (*ManagedEnvironment) ProtoMessage

func (*ManagedEnvironment) ProtoMessage()

func (*ManagedEnvironment) ProtoReflect

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

func (*ManagedEnvironment) Reset

func (x *ManagedEnvironment) Reset()

func (*ManagedEnvironment) String

func (x *ManagedEnvironment) String() string

type ManagedModule

type ManagedModule struct {

	// id is the stable identifier for this record.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// module is the full module resource.
	Module *Module `protobuf:"bytes,2,opt,name=module,proto3" json:"module,omitempty"`
	// contains filtered or unexported fields
}

ManagedModule is the platform-managed representation of a module.

func (*ManagedModule) Descriptor deprecated

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

Deprecated: Use ManagedModule.ProtoReflect.Descriptor instead.

func (*ManagedModule) GetId

func (x *ManagedModule) GetId() string

func (*ManagedModule) GetModule

func (x *ManagedModule) GetModule() *Module

func (*ManagedModule) ProtoMessage

func (*ManagedModule) ProtoMessage()

func (*ManagedModule) ProtoReflect

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

func (*ManagedModule) Reset

func (x *ManagedModule) Reset()

func (*ManagedModule) String

func (x *ManagedModule) String() string

type ManagedOrganization

type ManagedOrganization struct {

	// id is the stable identifier for this record.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Organization is the organization that is managed.
	Organization *Organization `protobuf:"bytes,2,opt,name=organization,proto3" json:"organization,omitempty"`
	// contains filtered or unexported fields
}

ManagedOrganization is the platform-managed representation of an organization.

func (*ManagedOrganization) Descriptor deprecated

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

Deprecated: Use ManagedOrganization.ProtoReflect.Descriptor instead.

func (*ManagedOrganization) GetId

func (x *ManagedOrganization) GetId() string

func (*ManagedOrganization) GetOrganization

func (x *ManagedOrganization) GetOrganization() *Organization

func (*ManagedOrganization) ProtoMessage

func (*ManagedOrganization) ProtoMessage()

func (*ManagedOrganization) ProtoReflect

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

func (*ManagedOrganization) Reset

func (x *ManagedOrganization) Reset()

func (*ManagedOrganization) String

func (x *ManagedOrganization) String() string

type ManagedWorkspace

type ManagedWorkspace struct {

	// organization ID is the unique identifier of the organization that owns the workspace.
	// UUID truncated to 10 characters.
	OrganizationId string `protobuf:"bytes,1,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// workspace ID is the unique identifier of the workspace.
	// UUID truncated to 10 characters.
	WorkspaceId string `protobuf:"bytes,2,opt,name=workspace_id,json=workspaceId,proto3" json:"workspace_id,omitempty"`
	// Workspace itself
	Workspace *Workspace `protobuf:"bytes,3,opt,name=workspace,proto3" json:"workspace,omitempty"`
	// contains filtered or unexported fields
}

ManagedWorkspace is the platform-managed representation of a workspace.

func (*ManagedWorkspace) Descriptor deprecated

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

Deprecated: Use ManagedWorkspace.ProtoReflect.Descriptor instead.

func (*ManagedWorkspace) GetOrganizationId

func (x *ManagedWorkspace) GetOrganizationId() string

func (*ManagedWorkspace) GetWorkspace

func (x *ManagedWorkspace) GetWorkspace() *Workspace

func (*ManagedWorkspace) GetWorkspaceId

func (x *ManagedWorkspace) GetWorkspaceId() string

func (*ManagedWorkspace) ProtoMessage

func (*ManagedWorkspace) ProtoMessage()

func (*ManagedWorkspace) ProtoReflect

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

func (*ManagedWorkspace) Reset

func (x *ManagedWorkspace) Reset()

func (*ManagedWorkspace) String

func (x *ManagedWorkspace) String() string

type Module

type Module struct {

	// The name of the module
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A description of the module
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Services that are provided by this module
	Services []*Service `protobuf:"bytes,4,rep,name=services,proto3" json:"services,omitempty"`
	// (Optional) The entry point for the module
	ServiceEntry string `protobuf:"bytes,5,opt,name=service_entry,json=serviceEntry,proto3" json:"service_entry,omitempty"`
	// (Optional) The formal interface contract
	Interface *ModuleInterface `protobuf:"bytes,6,opt,name=interface,proto3" json:"interface,omitempty"`
	// (Optional) The agent that created this module (for templated modules)
	Agent *Agent `protobuf:"bytes,7,opt,name=agent,proto3" json:"agent,omitempty"`
	// contains filtered or unexported fields
}

Module is a core Codefly resource in the workspace hierarchy.

func (*Module) Descriptor deprecated

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

Deprecated: Use Module.ProtoReflect.Descriptor instead.

func (*Module) GetAgent added in v0.1.155

func (x *Module) GetAgent() *Agent

func (*Module) GetDescription

func (x *Module) GetDescription() string

func (*Module) GetInterface added in v0.1.155

func (x *Module) GetInterface() *ModuleInterface

func (*Module) GetName

func (x *Module) GetName() string

func (*Module) GetServiceEntry

func (x *Module) GetServiceEntry() string

func (*Module) GetServices

func (x *Module) GetServices() []*Service

func (*Module) ProtoMessage

func (*Module) ProtoMessage()

func (*Module) ProtoReflect

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

func (*Module) Reset

func (x *Module) Reset()

func (*Module) String

func (x *Module) String() string

type ModuleInterface added in v0.1.155

type ModuleInterface struct {

	// endpoints are service endpoints that form the module's public contract.
	Endpoints []*InterfaceEndpoint `protobuf:"bytes,1,rep,name=endpoints,proto3" json:"endpoints,omitempty"`
	// contains filtered or unexported fields
}

ModuleInterface is the formal contract of what a module exposes.

func (*ModuleInterface) Descriptor deprecated added in v0.1.155

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

Deprecated: Use ModuleInterface.ProtoReflect.Descriptor instead.

func (*ModuleInterface) GetEndpoints added in v0.1.155

func (x *ModuleInterface) GetEndpoints() []*InterfaceEndpoint

func (*ModuleInterface) ProtoMessage added in v0.1.155

func (*ModuleInterface) ProtoMessage()

func (*ModuleInterface) ProtoReflect added in v0.1.155

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

func (*ModuleInterface) Reset added in v0.1.155

func (x *ModuleInterface) Reset()

func (*ModuleInterface) String added in v0.1.155

func (x *ModuleInterface) String() string

type NetworkAccess

type NetworkAccess struct {

	// NetworkContext is used to define
	// - "container" should be used to access system resources inside containers
	// - "native scope should be used to access system resources from the host
	// - "public" scope should be used when this should be accessible outside of the system
	Kind string `protobuf:"bytes,1,opt,name=kind,proto3" json:"kind,omitempty"`
	// contains filtered or unexported fields
}

NetworkAccess selects which network instance a caller should use.

func (*NetworkAccess) Descriptor deprecated

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

Deprecated: Use NetworkAccess.ProtoReflect.Descriptor instead.

func (*NetworkAccess) GetKind

func (x *NetworkAccess) GetKind() string

func (*NetworkAccess) ProtoMessage

func (*NetworkAccess) ProtoMessage()

func (*NetworkAccess) ProtoReflect

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

func (*NetworkAccess) Reset

func (x *NetworkAccess) Reset()

func (*NetworkAccess) String

func (x *NetworkAccess) String() string

type NetworkInstance

type NetworkInstance struct {

	// access is the runtime context from which this address is valid.
	Access *NetworkAccess `protobuf:"bytes,1,opt,name=access,proto3" json:"access,omitempty"`
	// host is the raw host or IP for the instance.
	Host string `protobuf:"bytes,3,opt,name=host,proto3" json:"host,omitempty"`
	// hostname is the DNS-safe hostname for the instance.
	Hostname string `protobuf:"bytes,4,opt,name=hostname,proto3" json:"hostname,omitempty"`
	// port is the TCP port assigned to the endpoint.
	Port uint32 `protobuf:"varint,5,opt,name=port,proto3" json:"port,omitempty"`
	// address is the complete host:port or URL callers should use.
	Address string `protobuf:"bytes,6,opt,name=address,proto3" json:"address,omitempty"`
	// contains filtered or unexported fields
}

NetworkInstance is one reachable address for a logical endpoint in a specific runtime context.

func (*NetworkInstance) Descriptor deprecated

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

Deprecated: Use NetworkInstance.ProtoReflect.Descriptor instead.

func (*NetworkInstance) GetAccess

func (x *NetworkInstance) GetAccess() *NetworkAccess

func (*NetworkInstance) GetAddress

func (x *NetworkInstance) GetAddress() string

func (*NetworkInstance) GetHost

func (x *NetworkInstance) GetHost() string

func (*NetworkInstance) GetHostname

func (x *NetworkInstance) GetHostname() string

func (*NetworkInstance) GetPort

func (x *NetworkInstance) GetPort() uint32

func (*NetworkInstance) ProtoMessage

func (*NetworkInstance) ProtoMessage()

func (*NetworkInstance) ProtoReflect

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

func (*NetworkInstance) Reset

func (x *NetworkInstance) Reset()

func (*NetworkInstance) String

func (x *NetworkInstance) String() string

type NetworkMapping

type NetworkMapping struct {

	// The endpoint to be accessed
	Endpoint *Endpoint `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// The network instances corresponding to the endpoint
	Instances []*NetworkInstance `protobuf:"bytes,2,rep,name=instances,proto3" json:"instances,omitempty"`
	// contains filtered or unexported fields
}

An endpoint to be accessed needs Network Mapping.

Network Mappings come with different scopes

- FromContainer: This is the mapping we want to use inside Container - FromHost: This is the mapping we want to use from the Host - Public: This is the mapping we want to use if something is publicly accessible: match to a DNS record

func (*NetworkMapping) Descriptor deprecated

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

Deprecated: Use NetworkMapping.ProtoReflect.Descriptor instead.

func (*NetworkMapping) GetEndpoint

func (x *NetworkMapping) GetEndpoint() *Endpoint

func (*NetworkMapping) GetInstances

func (x *NetworkMapping) GetInstances() []*NetworkInstance

func (*NetworkMapping) ProtoMessage

func (*NetworkMapping) ProtoMessage()

func (*NetworkMapping) ProtoReflect

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

func (*NetworkMapping) Reset

func (x *NetworkMapping) Reset()

func (*NetworkMapping) String

func (x *NetworkMapping) String() string

type Organization

type Organization struct {

	// Name is the name of the organization.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Organization represents the owner of workspaces

func (*Organization) Descriptor deprecated

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

Deprecated: Use Organization.ProtoReflect.Descriptor instead.

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 RPC

type RPC struct {

	// service_name is the protobuf service that owns this RPC.
	ServiceName string `protobuf:"bytes,1,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
	// name is the RPC method name.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

RPC describes one callable method exposed by a gRPC service.

func (*RPC) Descriptor deprecated

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

Deprecated: Use RPC.ProtoReflect.Descriptor instead.

func (*RPC) GetName

func (x *RPC) GetName() string

func (*RPC) GetServiceName

func (x *RPC) GetServiceName() string

func (*RPC) ProtoMessage

func (*RPC) ProtoMessage()

func (*RPC) ProtoReflect

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

func (*RPC) Reset

func (x *RPC) Reset()

func (*RPC) String

func (x *RPC) String() string

type RestAPI

type RestAPI struct {

	// service is the Codefly service name, optionally scoped by module in callers.
	Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
	// module is the Codefly module name that groups services.
	Module string `protobuf:"bytes,2,opt,name=module,proto3" json:"module,omitempty"`
	// groups are route groups discovered from the service API.
	Groups []*RestRouteGroup `protobuf:"bytes,3,rep,name=groups,proto3" json:"groups,omitempty"`
	// openapi is the serialized OpenAPI description for REST endpoints.
	Openapi []byte `protobuf:"bytes,4,opt,name=openapi,proto3" json:"openapi,omitempty"`
	// secured is true when the endpoint expects TLS or equivalent transport security.
	Secured bool `protobuf:"varint,5,opt,name=secured,proto3" json:"secured,omitempty"`
	// contains filtered or unexported fields
}

RestAPI describes a REST API endpoint and its route groups.

func (*RestAPI) Descriptor deprecated

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

Deprecated: Use RestAPI.ProtoReflect.Descriptor instead.

func (*RestAPI) GetGroups

func (x *RestAPI) GetGroups() []*RestRouteGroup

func (*RestAPI) GetModule

func (x *RestAPI) GetModule() string

func (*RestAPI) GetOpenapi

func (x *RestAPI) GetOpenapi() []byte

func (*RestAPI) GetSecured

func (x *RestAPI) GetSecured() bool

func (*RestAPI) GetService

func (x *RestAPI) GetService() string

func (*RestAPI) ProtoMessage

func (*RestAPI) ProtoMessage()

func (*RestAPI) ProtoReflect

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

func (*RestAPI) Reset

func (x *RestAPI) Reset()

func (*RestAPI) String

func (x *RestAPI) String() string

type RestRoute

type RestRoute struct {

	// path is the route path relative to its route group.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// method is the HTTP method handled by this route.
	Method HTTPMethod `protobuf:"varint,2,opt,name=method,proto3,enum=codefly.base.v0.HTTPMethod" json:"method,omitempty"`
	// contains filtered or unexported fields
}

RestRoute represents the data of the route itself It is usually found through a Route group

func (*RestRoute) Descriptor deprecated

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

Deprecated: Use RestRoute.ProtoReflect.Descriptor instead.

func (*RestRoute) GetMethod

func (x *RestRoute) GetMethod() HTTPMethod

func (*RestRoute) GetPath

func (x *RestRoute) GetPath() string

func (*RestRoute) ProtoMessage

func (*RestRoute) ProtoMessage()

func (*RestRoute) ProtoReflect

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

func (*RestRoute) Reset

func (x *RestRoute) Reset()

func (*RestRoute) String

func (x *RestRoute) String() string

type RestRouteGroup

type RestRouteGroup struct {

	// path is the shared route prefix for this group.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// routes are the REST routes mounted under path.
	Routes []*RestRoute `protobuf:"bytes,2,rep,name=routes,proto3" json:"routes,omitempty"`
	// contains filtered or unexported fields
}

A RestRouteGroup is a collection of routes that share the same path

func (*RestRouteGroup) Descriptor deprecated

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

Deprecated: Use RestRouteGroup.ProtoReflect.Descriptor instead.

func (*RestRouteGroup) GetPath

func (x *RestRouteGroup) GetPath() string

func (*RestRouteGroup) GetRoutes

func (x *RestRouteGroup) GetRoutes() []*RestRoute

func (*RestRouteGroup) ProtoMessage

func (*RestRouteGroup) ProtoMessage()

func (*RestRouteGroup) ProtoReflect

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

func (*RestRouteGroup) Reset

func (x *RestRouteGroup) Reset()

func (*RestRouteGroup) String

func (x *RestRouteGroup) String() string

type RuntimeContext

type RuntimeContext struct {

	// RuntimeContext is used to define the scope of a runtime resource
	// - "free" lets the runtime decide the scope
	// - "container" scope should be used inside containers
	// - "native" scope should be used when running "natively" on the host
	Kind string `protobuf:"bytes,1,opt,name=kind,proto3" json:"kind,omitempty"`
	// Name enables to "tag" the runtime context: useful for test
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

RuntimeContext identifies the execution environment a service should use.

func (*RuntimeContext) Descriptor deprecated

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

Deprecated: Use RuntimeContext.ProtoReflect.Descriptor instead.

func (*RuntimeContext) GetKind

func (x *RuntimeContext) GetKind() string

func (*RuntimeContext) GetName

func (x *RuntimeContext) GetName() string

func (*RuntimeContext) ProtoMessage

func (*RuntimeContext) ProtoMessage()

func (*RuntimeContext) ProtoReflect

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

func (*RuntimeContext) Reset

func (x *RuntimeContext) Reset()

func (*RuntimeContext) String

func (x *RuntimeContext) String() string

type Service

type Service struct {

	// Name of the service
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Short description of the service
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Agent that represents the service
	Agent *Agent `protobuf:"bytes,3,opt,name=agent,proto3" json:"agent,omitempty"`
	// Endpoints exposed by the service
	Endpoints []*Endpoint `protobuf:"bytes,4,rep,name=endpoints,proto3" json:"endpoints,omitempty"`
	// Dependencies
	ServiceDependencies []*ServiceReference `protobuf:"bytes,5,rep,name=service_dependencies,json=serviceDependencies,proto3" json:"service_dependencies,omitempty"`
	// contains filtered or unexported fields
}

Service is the fundamental "live" computing unit of a system It belongs to a module It is "hosted" by an agent It has a set of endpoints

func (*Service) Descriptor deprecated

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

Deprecated: Use Service.ProtoReflect.Descriptor instead.

func (*Service) GetAgent

func (x *Service) GetAgent() *Agent

func (*Service) GetDescription

func (x *Service) GetDescription() string

func (*Service) GetEndpoints

func (x *Service) GetEndpoints() []*Endpoint

func (*Service) GetName

func (x *Service) GetName() string

func (*Service) GetServiceDependencies

func (x *Service) GetServiceDependencies() []*ServiceReference

func (*Service) ProtoMessage

func (*Service) ProtoMessage()

func (*Service) ProtoReflect

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

func (*Service) Reset

func (x *Service) Reset()

func (*Service) String

func (x *Service) String() string

type ServiceIdentity

type ServiceIdentity struct {

	// name is the service name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// module is the Codefly module name that groups services.
	Module string `protobuf:"bytes,2,opt,name=module,proto3" json:"module,omitempty"`
	// workspace is the Codefly workspace name that scopes modules and services.
	Workspace string `protobuf:"bytes,3,opt,name=workspace,proto3" json:"workspace,omitempty"`
	// version is the semantic or service-specific version for this resource.
	Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
	// workspace_path is the absolute or caller-known path to the workspace root.
	WorkspacePath string `protobuf:"bytes,5,opt,name=workspace_path,json=workspacePath,proto3" json:"workspace_path,omitempty"`
	// relative_to_workspace is the path to the service relative to the workspace root.
	RelativeToWorkspace string `protobuf:"bytes,6,opt,name=relative_to_workspace,json=relativeToWorkspace,proto3" json:"relative_to_workspace,omitempty"`
	// contains filtered or unexported fields
}

ServiceIdentity is the identity of a service in a workspace

func (*ServiceIdentity) Descriptor deprecated

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

Deprecated: Use ServiceIdentity.ProtoReflect.Descriptor instead.

func (*ServiceIdentity) GetModule

func (x *ServiceIdentity) GetModule() string

func (*ServiceIdentity) GetName

func (x *ServiceIdentity) GetName() string

func (*ServiceIdentity) GetRelativeToWorkspace

func (x *ServiceIdentity) GetRelativeToWorkspace() string

func (*ServiceIdentity) GetVersion

func (x *ServiceIdentity) GetVersion() string

func (*ServiceIdentity) GetWorkspace

func (x *ServiceIdentity) GetWorkspace() string

func (*ServiceIdentity) GetWorkspacePath

func (x *ServiceIdentity) GetWorkspacePath() 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 ServiceReference

type ServiceReference struct {

	// name is the referenced service name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// module is the Codefly module name that groups services.
	Module string `protobuf:"bytes,2,opt,name=module,proto3" json:"module,omitempty"`
	// contains filtered or unexported fields
}

ServiceReference points to another service, usually as a dependency.

func (*ServiceReference) Descriptor deprecated

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

Deprecated: Use ServiceReference.ProtoReflect.Descriptor instead.

func (*ServiceReference) GetModule

func (x *ServiceReference) GetModule() string

func (*ServiceReference) GetName

func (x *ServiceReference) GetName() string

func (*ServiceReference) ProtoMessage

func (*ServiceReference) ProtoMessage()

func (*ServiceReference) ProtoReflect

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

func (*ServiceReference) Reset

func (x *ServiceReference) Reset()

func (*ServiceReference) String

func (x *ServiceReference) String() string

type SpecValue

type SpecValue struct {

	// value is the configuration or schema value.
	Value *anypb.Any `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

SpecValue wraps an arbitrary typed value from service YAML settings.

func (*SpecValue) Descriptor deprecated

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

Deprecated: Use SpecValue.ProtoReflect.Descriptor instead.

func (*SpecValue) GetValue

func (x *SpecValue) GetValue() *anypb.Any

func (*SpecValue) ProtoMessage

func (*SpecValue) ProtoMessage()

func (*SpecValue) ProtoReflect

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

func (*SpecValue) Reset

func (x *SpecValue) Reset()

func (*SpecValue) String

func (x *SpecValue) String() string

type Specs

type Specs struct {

	// fields are agent-specific structured settings from service YAML.
	Fields map[string]*SpecValue `` /* 139-byte string literal not displayed */
	// contains filtered or unexported fields
}

Specs carries agent-specific service settings parsed from Codefly YAML.

func (*Specs) Descriptor deprecated

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

Deprecated: Use Specs.ProtoReflect.Descriptor instead.

func (*Specs) GetFields

func (x *Specs) GetFields() map[string]*SpecValue

func (*Specs) ProtoMessage

func (*Specs) ProtoMessage()

func (*Specs) ProtoReflect

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

func (*Specs) Reset

func (x *Specs) Reset()

func (*Specs) String

func (x *Specs) String() string

type TcpAPI

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

TcpAPI describes a raw TCP endpoint.

func (*TcpAPI) Descriptor deprecated

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

Deprecated: Use TcpAPI.ProtoReflect.Descriptor instead.

func (*TcpAPI) ProtoMessage

func (*TcpAPI) ProtoMessage()

func (*TcpAPI) ProtoReflect

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

func (*TcpAPI) Reset

func (x *TcpAPI) Reset()

func (*TcpAPI) String

func (x *TcpAPI) String() string

type Version

type Version struct {

	// version is the semantic or service-specific version for this resource.
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

Version carries the version reported by an agent or resource descriptor.

func (*Version) Descriptor deprecated

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

Deprecated: Use Version.ProtoReflect.Descriptor instead.

func (*Version) GetVersion

func (x *Version) GetVersion() string

func (*Version) ProtoMessage

func (*Version) ProtoMessage()

func (*Version) ProtoReflect

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

func (*Version) Reset

func (x *Version) Reset()

func (*Version) String

func (x *Version) String() string

type Workspace

type Workspace struct {

	// name is the name of the workspace
	// it needs to be a valid hostname, and it should not contain "--" as it will be used for DNS
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// description provides a brief explanation of the workspace.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// modules is the list of modules that are part of the workspace.
	Modules []*Module `protobuf:"bytes,3,rep,name=modules,proto3" json:"modules,omitempty"`
	// layout selects whether services are stored flat, under modules, or both.
	Layout string `protobuf:"bytes,4,opt,name=layout,proto3" json:"layout,omitempty"`
	// contains filtered or unexported fields
}

A Workspace is the top-level entity in the system. Services are organized in modules, and modules are part of a workspace. A workspace can itself be its own module for simple workspaces.

func (*Workspace) Descriptor deprecated

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

Deprecated: Use Workspace.ProtoReflect.Descriptor instead.

func (*Workspace) GetDescription

func (x *Workspace) GetDescription() string

func (*Workspace) GetLayout

func (x *Workspace) GetLayout() string

func (*Workspace) GetModules

func (x *Workspace) GetModules() []*Module

func (*Workspace) GetName

func (x *Workspace) GetName() string

func (*Workspace) ProtoMessage

func (*Workspace) ProtoMessage()

func (*Workspace) ProtoReflect

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

func (*Workspace) Reset

func (x *Workspace) Reset()

func (*Workspace) String

func (x *Workspace) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL