Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterActivityServiceServer(s grpc.ServiceRegistrar, srv ActivityServiceServer)
- type API
- func (*API) Descriptor() ([]byte, []int)deprecated
- func (x *API) GetBundle() *APISchemaBundle
- func (x *API) GetDescriptors() []byte
- func (x *API) GetGraphql() []byte
- func (x *API) GetHost() string
- func (x *API) GetKind() ApiKind
- func (x *API) GetOpenapi() []byte
- func (x *API) GetPort() uint32
- func (x *API) GetPrefix() string
- func (x *API) GetSchema() isAPI_Schema
- func (x *API) GetServices() []string
- func (*API) ProtoMessage()
- func (x *API) ProtoReflect() protoreflect.Message
- func (x *API) Reset()
- func (x *API) String() string
- type APISchemaBundle
- func (*APISchemaBundle) Descriptor() ([]byte, []int)deprecated
- func (x *APISchemaBundle) GetEntry() string
- func (x *APISchemaBundle) GetFormat() SchemaFormat
- func (x *APISchemaBundle) GetHash() string
- func (*APISchemaBundle) ProtoMessage()
- func (x *APISchemaBundle) ProtoReflect() protoreflect.Message
- func (x *APISchemaBundle) Reset()
- func (x *APISchemaBundle) String() string
- type API_Bundle
- type API_Descriptors
- type API_Graphql
- type API_Openapi
- type Activity
- func (*Activity) Descriptor() ([]byte, []int)deprecated
- func (x *Activity) GetDescription() string
- func (x *Activity) GetHeartbeat() *durationpb.Duration
- func (x *Activity) GetInput() *schemapb.Schema
- func (x *Activity) GetKind() ActivityKind
- func (x *Activity) GetName() string
- func (x *Activity) GetOutput() *schemapb.Schema
- func (x *Activity) GetRetry() *ActivityRetry
- func (x *Activity) GetStartToClose() *durationpb.Duration
- func (*Activity) ProtoMessage()
- func (x *Activity) ProtoReflect() protoreflect.Message
- func (x *Activity) Reset()
- func (x *Activity) String() string
- type ActivityCall
- func (*ActivityCall) Descriptor() ([]byte, []int)deprecated
- func (x *ActivityCall) GetActivity() string
- func (x *ActivityCall) GetAttempt() int32
- func (x *ActivityCall) GetBinding() string
- func (x *ActivityCall) GetKey() string
- func (x *ActivityCall) GetMetadata() map[string]string
- func (x *ActivityCall) GetPayload() []byte
- func (x *ActivityCall) GetStep() string
- func (x *ActivityCall) GetTrace() map[string]string
- func (*ActivityCall) ProtoMessage()
- func (x *ActivityCall) ProtoReflect() protoreflect.Message
- func (x *ActivityCall) Reset()
- func (x *ActivityCall) String() string
- type ActivityKind
- func (ActivityKind) Descriptor() protoreflect.EnumDescriptor
- func (x ActivityKind) Enum() *ActivityKind
- func (ActivityKind) EnumDescriptor() ([]byte, []int)deprecated
- func (x ActivityKind) Number() protoreflect.EnumNumber
- func (x ActivityKind) String() string
- func (ActivityKind) Type() protoreflect.EnumType
- type ActivityResult
- type ActivityRetry
- func (*ActivityRetry) Descriptor() ([]byte, []int)deprecated
- func (x *ActivityRetry) GetAttempts() uint32
- func (x *ActivityRetry) GetPerTryTimeout() *durationpb.Duration
- func (*ActivityRetry) ProtoMessage()
- func (x *ActivityRetry) ProtoReflect() protoreflect.Message
- func (x *ActivityRetry) Reset()
- func (x *ActivityRetry) String() string
- type ActivityServiceClient
- type ActivityServiceServer
- type ApiKind
- type CallFailure
- func (*CallFailure) Descriptor() ([]byte, []int)deprecated
- func (x *CallFailure) GetRetryAfter() *durationpb.Duration
- func (x *CallFailure) GetRetryable() bool
- func (x *CallFailure) GetType() string
- func (*CallFailure) ProtoMessage()
- func (x *CallFailure) ProtoReflect() protoreflect.Message
- func (x *CallFailure) Reset()
- func (x *CallFailure) String() string
- type ConfigSection
- func (*ConfigSection) Descriptor() ([]byte, []int)deprecated
- func (x *ConfigSection) GetKeys() []string
- func (x *ConfigSection) GetLive() []string
- func (x *ConfigSection) GetSchema() *schemapb.Schema
- func (*ConfigSection) ProtoMessage()
- func (x *ConfigSection) ProtoReflect() protoreflect.Message
- func (x *ConfigSection) Reset()
- func (x *ConfigSection) String() string
- type ConfigSource
- func (ConfigSource) Descriptor() protoreflect.EnumDescriptor
- func (x ConfigSource) Enum() *ConfigSource
- func (ConfigSource) EnumDescriptor() ([]byte, []int)deprecated
- func (x ConfigSource) Number() protoreflect.EnumNumber
- func (x ConfigSource) String() string
- func (ConfigSource) Type() protoreflect.EnumType
- type Event
- func (*Event) Descriptor() ([]byte, []int)deprecated
- func (x *Event) GetDescription() string
- func (x *Event) GetName() string
- func (x *Event) GetSchema() *schemapb.Schema
- func (*Event) ProtoMessage()
- func (x *Event) ProtoReflect() protoreflect.Message
- func (x *Event) Reset()
- func (x *Event) String() string
- type Hook
- func (*Hook) Descriptor() ([]byte, []int)deprecated
- func (x *Hook) GetDescription() string
- func (x *Hook) GetInput() *schemapb.Schema
- func (x *Hook) GetName() string
- func (x *Hook) GetOutput() *schemapb.Schema
- func (x *Hook) GetRequired() bool
- func (x *Hook) GetTimeout() *durationpb.Duration
- func (*Hook) ProtoMessage()
- func (x *Hook) ProtoReflect() protoreflect.Message
- func (x *Hook) Reset()
- func (x *Hook) String() string
- type HookCall
- func (*HookCall) Descriptor() ([]byte, []int)deprecated
- func (x *HookCall) GetDeadline() *durationpb.Duration
- func (x *HookCall) GetHook() string
- func (x *HookCall) GetInstance() string
- func (x *HookCall) GetKey() string
- func (x *HookCall) GetMetadata() map[string]string
- func (x *HookCall) GetPayload() []byte
- func (x *HookCall) GetTrace() map[string]string
- func (*HookCall) ProtoMessage()
- func (x *HookCall) ProtoReflect() protoreflect.Message
- func (x *HookCall) Reset()
- func (x *HookCall) String() string
- type HookResult
- type InstancePhase
- func (InstancePhase) Descriptor() protoreflect.EnumDescriptor
- func (x InstancePhase) Enum() *InstancePhase
- func (InstancePhase) EnumDescriptor() ([]byte, []int)deprecated
- func (x InstancePhase) Number() protoreflect.EnumNumber
- func (x InstancePhase) String() string
- func (InstancePhase) Type() protoreflect.EnumType
- type InstanceState
- func (*InstanceState) Descriptor() ([]byte, []int)deprecated
- func (x *InstanceState) GetAddress() string
- func (x *InstanceState) GetCommit() string
- func (x *InstanceState) GetConfig() []byte
- func (x *InstanceState) GetConfigError() string
- func (x *InstanceState) GetConfigRejectedRevision() uint64
- func (x *InstanceState) GetConfigRevision() uint64
- func (x *InstanceState) GetId() string
- func (x *InstanceState) GetNodes() []*NodeStatus
- func (x *InstanceState) GetPhase() InstancePhase
- func (x *InstanceState) GetPlatformPort() uint32
- func (x *InstanceState) GetSdkVersion() string
- func (x *InstanceState) GetService() string
- func (x *InstanceState) GetSources() map[string]ConfigSource
- func (x *InstanceState) GetStartedAt() *timestamppb.Timestamp
- func (x *InstanceState) GetTransports() []*TransportStatus
- func (x *InstanceState) GetVersion() string
- func (*InstanceState) ProtoMessage()
- func (x *InstanceState) ProtoReflect() protoreflect.Message
- func (x *InstanceState) Reset()
- func (x *InstanceState) String() string
- type Manifest
- func (*Manifest) Descriptor() ([]byte, []int)deprecated
- func (x *Manifest) GetActivities() []*Activity
- func (x *Manifest) GetApis() []*API
- func (x *Manifest) GetConfig() *ConfigSection
- func (x *Manifest) GetDescriptors() []byte
- func (x *Manifest) GetEvents() []*Event
- func (x *Manifest) GetHooks() []*Hook
- func (x *Manifest) GetInternalServices() []string
- func (x *Manifest) GetNodes() []*Node
- func (x *Manifest) GetSchedules() []*Schedule
- func (x *Manifest) GetSdkVersion() string
- func (x *Manifest) GetService() string
- func (x *Manifest) GetSubscriptions() []*Subscription
- func (x *Manifest) GetTelemetry() *TelemetrySources
- func (x *Manifest) GetUi() *UI
- func (x *Manifest) GetVersion() string
- func (x *Manifest) GetWorkflows() []*Workflow
- func (*Manifest) ProtoMessage()
- func (x *Manifest) ProtoReflect() protoreflect.Message
- func (x *Manifest) Reset()
- func (x *Manifest) String() string
- type Node
- type NodeKind
- type NodeStatus
- func (*NodeStatus) Descriptor() ([]byte, []int)deprecated
- func (x *NodeStatus) GetError() string
- func (x *NodeStatus) GetPath() string
- func (x *NodeStatus) GetReady() bool
- func (*NodeStatus) ProtoMessage()
- func (x *NodeStatus) ProtoReflect() protoreflect.Message
- func (x *NodeStatus) Reset()
- func (x *NodeStatus) String() string
- type RunRequest
- type RunResponse
- type Schedule
- func (*Schedule) Descriptor() ([]byte, []int)deprecated
- func (x *Schedule) GetCron() string
- func (x *Schedule) GetEvery() *durationpb.Duration
- func (x *Schedule) GetJitter() *durationpb.Duration
- func (x *Schedule) GetName() string
- func (x *Schedule) GetOverlap() ScheduleOverlap
- func (x *Schedule) GetPaused() bool
- func (x *Schedule) GetSpec() isSchedule_Spec
- func (x *Schedule) GetTimeZone() string
- func (x *Schedule) GetWorkflow() string
- func (*Schedule) ProtoMessage()
- func (x *Schedule) ProtoReflect() protoreflect.Message
- func (x *Schedule) Reset()
- func (x *Schedule) String() string
- type ScheduleOverlap
- func (ScheduleOverlap) Descriptor() protoreflect.EnumDescriptor
- func (x ScheduleOverlap) Enum() *ScheduleOverlap
- func (ScheduleOverlap) EnumDescriptor() ([]byte, []int)deprecated
- func (x ScheduleOverlap) Number() protoreflect.EnumNumber
- func (x ScheduleOverlap) String() string
- func (ScheduleOverlap) Type() protoreflect.EnumType
- type Schedule_Cron
- type Schedule_Every
- type SchemaFormat
- func (SchemaFormat) Descriptor() protoreflect.EnumDescriptor
- func (x SchemaFormat) Enum() *SchemaFormat
- func (SchemaFormat) EnumDescriptor() ([]byte, []int)deprecated
- func (x SchemaFormat) Number() protoreflect.EnumNumber
- func (x SchemaFormat) String() string
- func (SchemaFormat) Type() protoreflect.EnumType
- type Subscription
- func (*Subscription) Descriptor() ([]byte, []int)deprecated
- func (x *Subscription) GetConsumer() string
- func (x *Subscription) GetEvent() string
- func (*Subscription) ProtoMessage()
- func (x *Subscription) ProtoReflect() protoreflect.Message
- func (x *Subscription) Reset()
- func (x *Subscription) String() string
- type TelemetrySourceSelector
- func (*TelemetrySourceSelector) Descriptor() ([]byte, []int)deprecated
- func (x *TelemetrySourceSelector) GetResource() map[string]string
- func (*TelemetrySourceSelector) ProtoMessage()
- func (x *TelemetrySourceSelector) ProtoReflect() protoreflect.Message
- func (x *TelemetrySourceSelector) Reset()
- func (x *TelemetrySourceSelector) String() string
- type TelemetrySources
- func (*TelemetrySources) Descriptor() ([]byte, []int)deprecated
- func (x *TelemetrySources) GetSelectors() []*TelemetrySourceSelector
- func (*TelemetrySources) ProtoMessage()
- func (x *TelemetrySources) ProtoReflect() protoreflect.Message
- func (x *TelemetrySources) Reset()
- func (x *TelemetrySources) String() string
- type TransportStatus
- func (*TransportStatus) Descriptor() ([]byte, []int)deprecated
- func (x *TransportStatus) GetConnected() bool
- func (x *TransportStatus) GetError() string
- func (x *TransportStatus) GetName() string
- func (*TransportStatus) ProtoMessage()
- func (x *TransportStatus) ProtoReflect() protoreflect.Message
- func (x *TransportStatus) Reset()
- func (x *TransportStatus) String() string
- type UI
- type UnimplementedActivityServiceServer
- type UnsafeActivityServiceServer
- type Workflow
- func (*Workflow) Descriptor() ([]byte, []int)deprecated
- func (x *Workflow) GetDescription() string
- func (x *Workflow) GetInput() *schemapb.Schema
- func (x *Workflow) GetName() string
- func (x *Workflow) GetOutput() *schemapb.Schema
- func (*Workflow) ProtoMessage()
- func (x *Workflow) ProtoReflect() protoreflect.Message
- func (x *Workflow) Reset()
- func (x *Workflow) String() string
Constants ¶
const (
ActivityService_Run_FullMethodName = "/backplane.v1.ActivityService/Run"
)
Variables ¶
var ( InstancePhase_name = map[int32]string{ 0: "INSTANCE_PHASE_UNSPECIFIED", 1: "INSTANCE_PHASE_STARTING", 2: "INSTANCE_PHASE_SERVING", 3: "INSTANCE_PHASE_STOPPING", } InstancePhase_value = map[string]int32{ "INSTANCE_PHASE_UNSPECIFIED": 0, "INSTANCE_PHASE_STARTING": 1, "INSTANCE_PHASE_SERVING": 2, "INSTANCE_PHASE_STOPPING": 3, } )
Enum value maps for InstancePhase.
var ( ConfigSource_name = map[int32]string{ 0: "CONFIG_SOURCE_UNSPECIFIED", 1: "CONFIG_SOURCE_DEFAULT", 2: "CONFIG_SOURCE_FILE", 3: "CONFIG_SOURCE_ENV", 4: "CONFIG_SOURCE_KV", } ConfigSource_value = map[string]int32{ "CONFIG_SOURCE_UNSPECIFIED": 0, "CONFIG_SOURCE_DEFAULT": 1, "CONFIG_SOURCE_FILE": 2, "CONFIG_SOURCE_ENV": 3, "CONFIG_SOURCE_KV": 4, } )
Enum value maps for ConfigSource.
var ( NodeKind_name = map[int32]string{ 0: "NODE_KIND_UNSPECIFIED", 1: "NODE_KIND_COMPONENT", 2: "NODE_KIND_DEPENDENCY", 3: "NODE_KIND_SINGLETON", } NodeKind_value = map[string]int32{ "NODE_KIND_UNSPECIFIED": 0, "NODE_KIND_COMPONENT": 1, "NODE_KIND_DEPENDENCY": 2, "NODE_KIND_SINGLETON": 3, } )
Enum value maps for NodeKind.
var ( SchemaFormat_name = map[int32]string{ 0: "SCHEMA_FORMAT_UNSPECIFIED", 1: "SCHEMA_FORMAT_OPENAPI", 2: "SCHEMA_FORMAT_GRAPHQL", } SchemaFormat_value = map[string]int32{ "SCHEMA_FORMAT_UNSPECIFIED": 0, "SCHEMA_FORMAT_OPENAPI": 1, "SCHEMA_FORMAT_GRAPHQL": 2, } )
Enum value maps for SchemaFormat.
var ( ApiKind_name = map[int32]string{ 0: "API_KIND_UNSPECIFIED", 1: "API_KIND_HTTP", 2: "API_KIND_GRPC", 4: "API_KIND_WS_PROTO", 5: "API_KIND_GRAPHQL", } ApiKind_value = map[string]int32{ "API_KIND_UNSPECIFIED": 0, "API_KIND_HTTP": 1, "API_KIND_GRPC": 2, "API_KIND_WS_PROTO": 4, "API_KIND_GRAPHQL": 5, } )
Enum value maps for ApiKind.
var ( ActivityKind_name = map[int32]string{ 0: "ACTIVITY_KIND_UNSPECIFIED", 1: "ACTIVITY_KIND_ACTIVITY", 2: "ACTIVITY_KIND_WORKFLOW", } ActivityKind_value = map[string]int32{ "ACTIVITY_KIND_UNSPECIFIED": 0, "ACTIVITY_KIND_ACTIVITY": 1, "ACTIVITY_KIND_WORKFLOW": 2, } )
Enum value maps for ActivityKind.
var ( ScheduleOverlap_name = map[int32]string{ 0: "SCHEDULE_OVERLAP_UNSPECIFIED", 1: "SCHEDULE_OVERLAP_SKIP", 2: "SCHEDULE_OVERLAP_BUFFER_ONE", 3: "SCHEDULE_OVERLAP_BUFFER_ALL", 4: "SCHEDULE_OVERLAP_CANCEL_OTHER", 5: "SCHEDULE_OVERLAP_TERMINATE_OTHER", 6: "SCHEDULE_OVERLAP_ALLOW_ALL", } ScheduleOverlap_value = map[string]int32{ "SCHEDULE_OVERLAP_UNSPECIFIED": 0, "SCHEDULE_OVERLAP_SKIP": 1, "SCHEDULE_OVERLAP_BUFFER_ONE": 2, "SCHEDULE_OVERLAP_BUFFER_ALL": 3, "SCHEDULE_OVERLAP_CANCEL_OTHER": 4, "SCHEDULE_OVERLAP_TERMINATE_OTHER": 5, "SCHEDULE_OVERLAP_ALLOW_ALL": 6, } )
Enum value maps for ScheduleOverlap.
var ActivityService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "backplane.v1.ActivityService", HandlerType: (*ActivityServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Run", Handler: _ActivityService_Run_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "backplanepb/v1/call.proto", }
ActivityService_ServiceDesc is the grpc.ServiceDesc for ActivityService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_backplanepb_v1_call_proto protoreflect.FileDescriptor
var File_backplanepb_v1_instance_proto protoreflect.FileDescriptor
var File_backplanepb_v1_manifest_proto protoreflect.FileDescriptor
Functions ¶
func RegisterActivityServiceServer ¶ added in v0.3.0
func RegisterActivityServiceServer(s grpc.ServiceRegistrar, srv ActivityServiceServer)
Types ¶
type API ¶
type API struct {
// Path prefix ("/api/"); gRPC routes use "/<full service name>/".
Prefix string `protobuf:"bytes,1,opt,name=prefix,proto3" json:"prefix,omitempty"`
// Host header to match in addition to the prefix; empty matches any host.
Host string `protobuf:"bytes,2,opt,name=host,proto3" json:"host,omitempty"`
Kind ApiKind `protobuf:"varint,3,opt,name=kind,proto3,enum=backplane.v1.ApiKind" json:"kind,omitempty"`
// Port of the external API this route leads to; 0 = the port registered
// in Consul.
Port uint32 `protobuf:"varint,4,opt,name=port,proto3" json:"port,omitempty"`
// gRPC and ws-proto: full names of the services behind the
// route; their descriptors are in Manifest.descriptors unless the route
// carries its own.
Services []string `protobuf:"bytes,8,rep,name=services,proto3" json:"services,omitempty"`
// Schema for the console's API tab; optional.
//
// Types that are valid to be assigned to Schema:
//
// *API_Openapi
// *API_Descriptors
// *API_Graphql
// *API_Bundle
Schema isAPI_Schema `protobuf_oneof:"schema"`
// contains filtered or unexported fields
}
An API served by the service. Does not configure external routing.
func (*API) Descriptor
deprecated
func (*API) GetBundle ¶
func (x *API) GetBundle() *APISchemaBundle
func (*API) GetDescriptors ¶
func (*API) GetGraphql ¶
func (*API) GetOpenapi ¶
func (*API) GetServices ¶
func (*API) ProtoMessage ¶
func (*API) ProtoMessage()
func (*API) ProtoReflect ¶
func (x *API) ProtoReflect() protoreflect.Message
type APISchemaBundle ¶
type APISchemaBundle struct {
Hash string `protobuf:"bytes,1,opt,name=hash,proto3" json:"hash,omitempty"`
// Entry file relative to the bundle root; may reference other bundle files.
Entry string `protobuf:"bytes,2,opt,name=entry,proto3" json:"entry,omitempty"`
Format SchemaFormat `protobuf:"varint,3,opt,name=format,proto3,enum=backplane.v1.SchemaFormat" json:"format,omitempty"`
// contains filtered or unexported fields
}
An immutable API file snapshot, delivered separately from the manifest.
func (*APISchemaBundle) Descriptor
deprecated
func (*APISchemaBundle) Descriptor() ([]byte, []int)
Deprecated: Use APISchemaBundle.ProtoReflect.Descriptor instead.
func (*APISchemaBundle) GetEntry ¶
func (x *APISchemaBundle) GetEntry() string
func (*APISchemaBundle) GetFormat ¶
func (x *APISchemaBundle) GetFormat() SchemaFormat
func (*APISchemaBundle) GetHash ¶
func (x *APISchemaBundle) GetHash() string
func (*APISchemaBundle) ProtoMessage ¶
func (*APISchemaBundle) ProtoMessage()
func (*APISchemaBundle) ProtoReflect ¶
func (x *APISchemaBundle) ProtoReflect() protoreflect.Message
func (*APISchemaBundle) Reset ¶
func (x *APISchemaBundle) Reset()
func (*APISchemaBundle) String ¶
func (x *APISchemaBundle) String() string
type API_Bundle ¶
type API_Bundle struct {
// Files served by the SDK on the platform port, outside Consul KV.
Bundle *APISchemaBundle `protobuf:"bytes,10,opt,name=bundle,proto3,oneof"`
}
type API_Descriptors ¶
type API_Descriptors struct {
// Serialized FileDescriptorSet (gRPC, Connect, ws-proto).
Descriptors []byte `protobuf:"bytes,6,opt,name=descriptors,proto3,oneof"`
}
type API_Graphql ¶
type API_Graphql struct {
// Introspection result as JSON (GraphQL).
Graphql []byte `protobuf:"bytes,7,opt,name=graphql,proto3,oneof"`
}
type API_Openapi ¶
type API_Openapi struct {
// OpenAPI document (HTTP).
Openapi []byte `protobuf:"bytes,5,opt,name=openapi,proto3,oneof"`
}
type Activity ¶
type Activity struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Input *schemapb.Schema `protobuf:"bytes,2,opt,name=input,proto3" json:"input,omitempty"`
Output *schemapb.Schema `protobuf:"bytes,3,opt,name=output,proto3" json:"output,omitempty"`
Kind ActivityKind `protobuf:"varint,4,opt,name=kind,proto3,enum=backplane.v1.ActivityKind" json:"kind,omitempty"`
// Defaults for a binding step calling it; the binding may override.
StartToClose *durationpb.Duration `protobuf:"bytes,5,opt,name=start_to_close,json=startToClose,proto3" json:"start_to_close,omitempty"`
Heartbeat *durationpb.Duration `protobuf:"bytes,6,opt,name=heartbeat,proto3" json:"heartbeat,omitempty"`
Retry *ActivityRetry `protobuf:"bytes,7,opt,name=retry,proto3" json:"retry,omitempty"`
Description string `protobuf:"bytes,8,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
An operation the service implements; a binding step target.
func (*Activity) Descriptor
deprecated
func (*Activity) GetDescription ¶
func (*Activity) GetHeartbeat ¶
func (x *Activity) GetHeartbeat() *durationpb.Duration
func (*Activity) GetKind ¶
func (x *Activity) GetKind() ActivityKind
func (*Activity) GetRetry ¶
func (x *Activity) GetRetry() *ActivityRetry
func (*Activity) GetStartToClose ¶
func (x *Activity) GetStartToClose() *durationpb.Duration
func (*Activity) ProtoMessage ¶
func (*Activity) ProtoMessage()
func (*Activity) ProtoReflect ¶
func (x *Activity) ProtoReflect() protoreflect.Message
type ActivityCall ¶
type ActivityCall struct {
Activity string `protobuf:"bytes,1,opt,name=activity,proto3" json:"activity,omitempty"`
Payload []byte `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"`
Trace map[string]string `` /* 137-byte string literal not displayed */
// For diagnostics: which binding or rule and which step.
Binding string `protobuf:"bytes,4,opt,name=binding,proto3" json:"binding,omitempty"`
Step string `protobuf:"bytes,5,opt,name=step,proto3" json:"step,omitempty"`
// Direct runtime: the attempt (1 for the first) and the key of the step
// execution — the same for every attempt — as activity.Info shows them;
// Temporal supplies its own.
Attempt int32 `protobuf:"varint,6,opt,name=attempt,proto3" json:"attempt,omitempty"`
Key string `protobuf:"bytes,7,opt,name=key,proto3" json:"key,omitempty"`
// Metadata of the hook call whose run calls this activity (HookCall.metadata).
Metadata map[string]string `` /* 143-byte string literal not displayed */
// contains filtered or unexported fields
}
Input of an activity or child workflow the binding workflow executes on the target service's task queue.
func (*ActivityCall) Descriptor
deprecated
func (*ActivityCall) Descriptor() ([]byte, []int)
Deprecated: Use ActivityCall.ProtoReflect.Descriptor instead.
func (*ActivityCall) GetActivity ¶
func (x *ActivityCall) GetActivity() string
func (*ActivityCall) GetAttempt ¶ added in v0.3.0
func (x *ActivityCall) GetAttempt() int32
func (*ActivityCall) GetBinding ¶
func (x *ActivityCall) GetBinding() string
func (*ActivityCall) GetKey ¶ added in v0.3.0
func (x *ActivityCall) GetKey() string
func (*ActivityCall) GetMetadata ¶ added in v0.6.36
func (x *ActivityCall) GetMetadata() map[string]string
func (*ActivityCall) GetPayload ¶
func (x *ActivityCall) GetPayload() []byte
func (*ActivityCall) GetStep ¶
func (x *ActivityCall) GetStep() string
func (*ActivityCall) GetTrace ¶
func (x *ActivityCall) GetTrace() map[string]string
func (*ActivityCall) ProtoMessage ¶
func (*ActivityCall) ProtoMessage()
func (*ActivityCall) ProtoReflect ¶
func (x *ActivityCall) ProtoReflect() protoreflect.Message
func (*ActivityCall) Reset ¶
func (x *ActivityCall) Reset()
func (*ActivityCall) String ¶
func (x *ActivityCall) String() string
type ActivityKind ¶
type ActivityKind int32
const ( ActivityKind_ACTIVITY_KIND_UNSPECIFIED ActivityKind = 0 // A Temporal activity on the service's queue. ActivityKind_ACTIVITY_KIND_ACTIVITY ActivityKind = 1 // A Temporal workflow on the service's queue, run as a child workflow. ActivityKind_ACTIVITY_KIND_WORKFLOW ActivityKind = 2 )
func (ActivityKind) Descriptor ¶
func (ActivityKind) Descriptor() protoreflect.EnumDescriptor
func (ActivityKind) Enum ¶
func (x ActivityKind) Enum() *ActivityKind
func (ActivityKind) EnumDescriptor
deprecated
func (ActivityKind) EnumDescriptor() ([]byte, []int)
Deprecated: Use ActivityKind.Descriptor instead.
func (ActivityKind) Number ¶
func (x ActivityKind) Number() protoreflect.EnumNumber
func (ActivityKind) String ¶
func (x ActivityKind) String() string
func (ActivityKind) Type ¶
func (ActivityKind) Type() protoreflect.EnumType
type ActivityResult ¶
type ActivityResult struct {
Payload []byte `protobuf:"bytes,1,opt,name=payload,proto3" json:"payload,omitempty"`
// contains filtered or unexported fields
}
func (*ActivityResult) Descriptor
deprecated
func (*ActivityResult) Descriptor() ([]byte, []int)
Deprecated: Use ActivityResult.ProtoReflect.Descriptor instead.
func (*ActivityResult) GetPayload ¶
func (x *ActivityResult) GetPayload() []byte
func (*ActivityResult) ProtoMessage ¶
func (*ActivityResult) ProtoMessage()
func (*ActivityResult) ProtoReflect ¶
func (x *ActivityResult) ProtoReflect() protoreflect.Message
func (*ActivityResult) Reset ¶
func (x *ActivityResult) Reset()
func (*ActivityResult) String ¶
func (x *ActivityResult) String() string
type ActivityRetry ¶
type ActivityRetry struct {
Attempts uint32 `protobuf:"varint,1,opt,name=attempts,proto3" json:"attempts,omitempty"`
PerTryTimeout *durationpb.Duration `protobuf:"bytes,2,opt,name=per_try_timeout,json=perTryTimeout,proto3" json:"per_try_timeout,omitempty"`
// contains filtered or unexported fields
}
Default retries for a binding step executing this activity or workflow.
func (*ActivityRetry) Descriptor
deprecated
func (*ActivityRetry) Descriptor() ([]byte, []int)
Deprecated: Use ActivityRetry.ProtoReflect.Descriptor instead.
func (*ActivityRetry) GetAttempts ¶
func (x *ActivityRetry) GetAttempts() uint32
func (*ActivityRetry) GetPerTryTimeout ¶
func (x *ActivityRetry) GetPerTryTimeout() *durationpb.Duration
func (*ActivityRetry) ProtoMessage ¶
func (*ActivityRetry) ProtoMessage()
func (*ActivityRetry) ProtoReflect ¶
func (x *ActivityRetry) ProtoReflect() protoreflect.Message
func (*ActivityRetry) Reset ¶
func (x *ActivityRetry) Reset()
func (*ActivityRetry) String ¶
func (x *ActivityRetry) String() string
type ActivityServiceClient ¶ added in v0.3.0
type ActivityServiceClient interface {
// Run executes one activity call and answers its result. A handler
// error is a status with a CallFailure detail: FAILED_PRECONDITION when
// not retryable, UNAVAILABLE when it is; an unknown activity is
// NOT_FOUND.
Run(ctx context.Context, in *RunRequest, opts ...grpc.CallOption) (*RunResponse, error)
}
ActivityServiceClient is the client API for ActivityService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
ActivityService is served by the SDK on a service's platform port, behind the internal secret: the direct runtime runs the service's activities through it, the handlers activity.Handle registered. Temporal's worker serves the same handlers from its task queue.
func NewActivityServiceClient ¶ added in v0.3.0
func NewActivityServiceClient(cc grpc.ClientConnInterface) ActivityServiceClient
type ActivityServiceServer ¶ added in v0.3.0
type ActivityServiceServer interface {
// Run executes one activity call and answers its result. A handler
// error is a status with a CallFailure detail: FAILED_PRECONDITION when
// not retryable, UNAVAILABLE when it is; an unknown activity is
// NOT_FOUND.
Run(context.Context, *RunRequest) (*RunResponse, error)
// contains filtered or unexported methods
}
ActivityServiceServer is the server API for ActivityService service. All implementations must embed UnimplementedActivityServiceServer for forward compatibility.
ActivityService is served by the SDK on a service's platform port, behind the internal secret: the direct runtime runs the service's activities through it, the handlers activity.Handle registered. Temporal's worker serves the same handlers from its task queue.
type ApiKind ¶
type ApiKind int32
func (ApiKind) Descriptor ¶
func (ApiKind) Descriptor() protoreflect.EnumDescriptor
func (ApiKind) EnumDescriptor
deprecated
func (ApiKind) Number ¶
func (x ApiKind) Number() protoreflect.EnumNumber
func (ApiKind) Type ¶
func (ApiKind) Type() protoreflect.EnumType
type CallFailure ¶ added in v0.3.0
type CallFailure struct {
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
Retryable bool `protobuf:"varint,2,opt,name=retryable,proto3" json:"retryable,omitempty"`
RetryAfter *durationpb.Duration `protobuf:"bytes,3,opt,name=retry_after,json=retryAfter,proto3" json:"retry_after,omitempty"`
// contains filtered or unexported fields
}
CallFailure is the detail of a failed direct call (a gRPC status detail): the type the binding knows (backplane.NonRetryable, ...), whether retrying can help, and how long to wait before the next attempt when the handler said so (activity.RetryAfter).
func (*CallFailure) Descriptor
deprecated
added in
v0.3.0
func (*CallFailure) Descriptor() ([]byte, []int)
Deprecated: Use CallFailure.ProtoReflect.Descriptor instead.
func (*CallFailure) GetRetryAfter ¶ added in v0.6.0
func (x *CallFailure) GetRetryAfter() *durationpb.Duration
func (*CallFailure) GetRetryable ¶ added in v0.3.0
func (x *CallFailure) GetRetryable() bool
func (*CallFailure) GetType ¶ added in v0.3.0
func (x *CallFailure) GetType() string
func (*CallFailure) ProtoMessage ¶ added in v0.3.0
func (*CallFailure) ProtoMessage()
func (*CallFailure) ProtoReflect ¶ added in v0.3.0
func (x *CallFailure) ProtoReflect() protoreflect.Message
func (*CallFailure) Reset ¶ added in v0.3.0
func (x *CallFailure) Reset()
func (*CallFailure) String ¶ added in v0.3.0
func (x *CallFailure) String() string
type ConfigSection ¶
type ConfigSection struct {
Keys []string `protobuf:"bytes,1,rep,name=keys,proto3" json:"keys,omitempty"`
Schema *schemapb.Schema `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
// Paths of Live fields, dot-separated ("postgres.log_level").
Live []string `protobuf:"bytes,3,rep,name=live,proto3" json:"live,omitempty"`
// contains filtered or unexported fields
}
The configuration. `keys` is the declaration; `schema` is optional and, when present, drives forms, validation and secret masking.
func (*ConfigSection) Descriptor
deprecated
func (*ConfigSection) Descriptor() ([]byte, []int)
Deprecated: Use ConfigSection.ProtoReflect.Descriptor instead.
func (*ConfigSection) GetKeys ¶
func (x *ConfigSection) GetKeys() []string
func (*ConfigSection) GetLive ¶
func (x *ConfigSection) GetLive() []string
func (*ConfigSection) GetSchema ¶
func (x *ConfigSection) GetSchema() *schemapb.Schema
func (*ConfigSection) ProtoMessage ¶
func (*ConfigSection) ProtoMessage()
func (*ConfigSection) ProtoReflect ¶
func (x *ConfigSection) ProtoReflect() protoreflect.Message
func (*ConfigSection) Reset ¶
func (x *ConfigSection) Reset()
func (*ConfigSection) String ¶
func (x *ConfigSection) String() string
type ConfigSource ¶
type ConfigSource int32
const ( ConfigSource_CONFIG_SOURCE_UNSPECIFIED ConfigSource = 0 ConfigSource_CONFIG_SOURCE_DEFAULT ConfigSource = 1 ConfigSource_CONFIG_SOURCE_FILE ConfigSource = 2 ConfigSource_CONFIG_SOURCE_ENV ConfigSource = 3 ConfigSource_CONFIG_SOURCE_KV ConfigSource = 4 )
func (ConfigSource) Descriptor ¶
func (ConfigSource) Descriptor() protoreflect.EnumDescriptor
func (ConfigSource) Enum ¶
func (x ConfigSource) Enum() *ConfigSource
func (ConfigSource) EnumDescriptor
deprecated
func (ConfigSource) EnumDescriptor() ([]byte, []int)
Deprecated: Use ConfigSource.Descriptor instead.
func (ConfigSource) Number ¶
func (x ConfigSource) Number() protoreflect.EnumNumber
func (ConfigSource) String ¶
func (x ConfigSource) String() string
func (ConfigSource) Type ¶
func (ConfigSource) Type() protoreflect.EnumType
type Event ¶
type Event struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Schema *schemapb.Schema `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
func (*Event) Descriptor
deprecated
func (*Event) GetDescription ¶
func (*Event) ProtoMessage ¶
func (*Event) ProtoMessage()
func (*Event) ProtoReflect ¶
func (x *Event) ProtoReflect() protoreflect.Message
type Hook ¶
type Hook struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Input *schemapb.Schema `protobuf:"bytes,2,opt,name=input,proto3" json:"input,omitempty"`
Output *schemapb.Schema `protobuf:"bytes,3,opt,name=output,proto3" json:"output,omitempty"`
// The service cannot work without a binding.
Required bool `protobuf:"varint,4,opt,name=required,proto3" json:"required,omitempty"`
// Default deadline of a call; 0 = platform default.
Timeout *durationpb.Duration `protobuf:"bytes,5,opt,name=timeout,proto3" json:"timeout,omitempty"`
Description string `protobuf:"bytes,6,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
An operation the service calls without implementing it.
func (*Hook) Descriptor
deprecated
func (*Hook) GetDescription ¶
func (*Hook) GetRequired ¶
func (*Hook) GetTimeout ¶
func (x *Hook) GetTimeout() *durationpb.Duration
func (*Hook) ProtoMessage ¶
func (*Hook) ProtoMessage()
func (*Hook) ProtoReflect ¶
func (x *Hook) ProtoReflect() protoreflect.Message
type HookCall ¶
type HookCall struct {
Hook string `protobuf:"bytes,1,opt,name=hook,proto3" json:"hook,omitempty"`
Instance string `protobuf:"bytes,2,opt,name=instance,proto3" json:"instance,omitempty"`
Payload []byte `protobuf:"bytes,3,opt,name=payload,proto3" json:"payload,omitempty"`
// W3C trace context: traceparent, tracestate, baggage.
Trace map[string]string `` /* 137-byte string literal not displayed */
Deadline *durationpb.Duration `protobuf:"bytes,5,opt,name=deadline,proto3" json:"deadline,omitempty"`
// Idempotency key (hook.Key): a call repeating one with the same hook and
// key answers with the first one's outcome while its run is retained; a
// failed or canceled run runs again. The SDK's direct transport sends it
// as the bp-call-key header, which backplane reads when this is empty.
Key string `protobuf:"bytes,6,opt,name=key,proto3" json:"key,omitempty"`
// The call's metadata (pkg/backplane/meta): the product's pairs, carried
// to every activity the binding's run calls. Backplane does not read
// them.
Metadata map[string]string `` /* 143-byte string literal not displayed */
// contains filtered or unexported fields
}
Input of the Nexus operation a service raises.
func (*HookCall) Descriptor
deprecated
func (*HookCall) GetDeadline ¶
func (x *HookCall) GetDeadline() *durationpb.Duration
func (*HookCall) GetInstance ¶
func (*HookCall) GetMetadata ¶ added in v0.6.36
func (*HookCall) GetPayload ¶
func (*HookCall) ProtoMessage ¶
func (*HookCall) ProtoMessage()
func (*HookCall) ProtoReflect ¶
func (x *HookCall) ProtoReflect() protoreflect.Message
type HookResult ¶
type HookResult struct {
Payload []byte `protobuf:"bytes,1,opt,name=payload,proto3" json:"payload,omitempty"`
// contains filtered or unexported fields
}
func (*HookResult) Descriptor
deprecated
func (*HookResult) Descriptor() ([]byte, []int)
Deprecated: Use HookResult.ProtoReflect.Descriptor instead.
func (*HookResult) GetPayload ¶
func (x *HookResult) GetPayload() []byte
func (*HookResult) ProtoMessage ¶
func (*HookResult) ProtoMessage()
func (*HookResult) ProtoReflect ¶
func (x *HookResult) ProtoReflect() protoreflect.Message
func (*HookResult) Reset ¶
func (x *HookResult) Reset()
func (*HookResult) String ¶
func (x *HookResult) String() string
type InstancePhase ¶
type InstancePhase int32
const ( InstancePhase_INSTANCE_PHASE_UNSPECIFIED InstancePhase = 0 // The tree is starting: dependencies are being provided. InstancePhase_INSTANCE_PHASE_STARTING InstancePhase = 1 InstancePhase_INSTANCE_PHASE_SERVING InstancePhase = 2 InstancePhase_INSTANCE_PHASE_STOPPING InstancePhase = 3 )
func (InstancePhase) Descriptor ¶
func (InstancePhase) Descriptor() protoreflect.EnumDescriptor
func (InstancePhase) Enum ¶
func (x InstancePhase) Enum() *InstancePhase
func (InstancePhase) EnumDescriptor
deprecated
func (InstancePhase) EnumDescriptor() ([]byte, []int)
Deprecated: Use InstancePhase.Descriptor instead.
func (InstancePhase) Number ¶
func (x InstancePhase) Number() protoreflect.EnumNumber
func (InstancePhase) String ¶
func (x InstancePhase) String() string
func (InstancePhase) Type ¶
func (InstancePhase) Type() protoreflect.EnumType
type InstanceState ¶
type InstanceState struct {
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
Service string `protobuf:"bytes,2,opt,name=service,proto3" json:"service,omitempty"`
Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
Address string `protobuf:"bytes,4,opt,name=address,proto3" json:"address,omitempty"`
PlatformPort uint32 `protobuf:"varint,5,opt,name=platform_port,json=platformPort,proto3" json:"platform_port,omitempty"`
StartedAt *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=started_at,json=startedAt,proto3" json:"started_at,omitempty"`
// Effective configuration as JSON, secrets masked.
Config []byte `protobuf:"bytes,7,opt,name=config,proto3" json:"config,omitempty"`
// Source of every configuration path.
Sources map[string]ConfigSource `` /* 173-byte string literal not displayed */
// Revision from Consul KV `config/<service>/_revision` that is applied.
ConfigRevision uint64 `protobuf:"varint,9,opt,name=config_revision,json=configRevision,proto3" json:"config_revision,omitempty"`
// Why the last KV update was not applied; empty when applied.
ConfigError string `protobuf:"bytes,10,opt,name=config_error,json=configError,proto3" json:"config_error,omitempty"`
// Revision of the last KV update that was rejected; 0 when none.
ConfigRejectedRevision uint64 `` /* 131-byte string literal not displayed */
Phase InstancePhase `protobuf:"varint,12,opt,name=phase,proto3,enum=backplane.v1.InstancePhase" json:"phase,omitempty"`
// Author's nodes that hold readiness or can fail: dependencies.
Nodes []*NodeStatus `protobuf:"bytes,13,rep,name=nodes,proto3" json:"nodes,omitempty"`
// Consul, NATS, Temporal, OTLP.
Transports []*TransportStatus `protobuf:"bytes,14,rep,name=transports,proto3" json:"transports,omitempty"`
SdkVersion string `protobuf:"bytes,15,opt,name=sdk_version,json=sdkVersion,proto3" json:"sdk_version,omitempty"`
Commit string `protobuf:"bytes,16,opt,name=commit,proto3" json:"commit,omitempty"`
// contains filtered or unexported fields
}
InstanceState is written by the SDK to Consul KV `backplane/services/<service>/instances/<id>` under a session with TTL, so it dies with the instance. The console shows what is really applied; the console relay takes address and port from here.
func (*InstanceState) Descriptor
deprecated
func (*InstanceState) Descriptor() ([]byte, []int)
Deprecated: Use InstanceState.ProtoReflect.Descriptor instead.
func (*InstanceState) GetAddress ¶
func (x *InstanceState) GetAddress() string
func (*InstanceState) GetCommit ¶
func (x *InstanceState) GetCommit() string
func (*InstanceState) GetConfig ¶
func (x *InstanceState) GetConfig() []byte
func (*InstanceState) GetConfigError ¶
func (x *InstanceState) GetConfigError() string
func (*InstanceState) GetConfigRejectedRevision ¶
func (x *InstanceState) GetConfigRejectedRevision() uint64
func (*InstanceState) GetConfigRevision ¶
func (x *InstanceState) GetConfigRevision() uint64
func (*InstanceState) GetId ¶
func (x *InstanceState) GetId() string
func (*InstanceState) GetNodes ¶
func (x *InstanceState) GetNodes() []*NodeStatus
func (*InstanceState) GetPhase ¶
func (x *InstanceState) GetPhase() InstancePhase
func (*InstanceState) GetPlatformPort ¶
func (x *InstanceState) GetPlatformPort() uint32
func (*InstanceState) GetSdkVersion ¶
func (x *InstanceState) GetSdkVersion() string
func (*InstanceState) GetService ¶
func (x *InstanceState) GetService() string
func (*InstanceState) GetSources ¶
func (x *InstanceState) GetSources() map[string]ConfigSource
func (*InstanceState) GetStartedAt ¶
func (x *InstanceState) GetStartedAt() *timestamppb.Timestamp
func (*InstanceState) GetTransports ¶
func (x *InstanceState) GetTransports() []*TransportStatus
func (*InstanceState) GetVersion ¶
func (x *InstanceState) GetVersion() string
func (*InstanceState) ProtoMessage ¶
func (*InstanceState) ProtoMessage()
func (*InstanceState) ProtoReflect ¶
func (x *InstanceState) ProtoReflect() protoreflect.Message
func (*InstanceState) Reset ¶
func (x *InstanceState) Reset()
func (*InstanceState) String ¶
func (x *InstanceState) String() string
type Manifest ¶
type Manifest struct {
Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
SdkVersion string `protobuf:"bytes,3,opt,name=sdk_version,json=sdkVersion,proto3" json:"sdk_version,omitempty"`
// The service configuration: one struct; Live fields are listed in
// config.live and are the only ones Consul KV overrides.
Config *ConfigSection `protobuf:"bytes,4,opt,name=config,proto3" json:"config,omitempty"`
// APIs served by the service. Informational: publication belongs to deployment.
Apis []*API `protobuf:"bytes,6,rep,name=apis,proto3" json:"apis,omitempty"`
// Internal API: full gRPC service names on the platform port; the only
// methods the console relay forwards.
InternalServices []string `protobuf:"bytes,7,rep,name=internal_services,json=internalServices,proto3" json:"internal_services,omitempty"`
Events []*Event `protobuf:"bytes,8,rep,name=events,proto3" json:"events,omitempty"`
Hooks []*Hook `protobuf:"bytes,9,rep,name=hooks,proto3" json:"hooks,omitempty"`
Activities []*Activity `protobuf:"bytes,10,rep,name=activities,proto3" json:"activities,omitempty"`
Ui *UI `protobuf:"bytes,11,opt,name=ui,proto3" json:"ui,omitempty"`
// The node tree the author composed, depth-first in creation (= start)
// order.
Nodes []*Node `protobuf:"bytes,12,rep,name=nodes,proto3" json:"nodes,omitempty"`
// Serialized FileDescriptorSet covering every service named by a managed
// API (API.services) and by internal_services, with transitive
// imports: stored once instead of per API.
Descriptors []byte `protobuf:"bytes,13,opt,name=descriptors,proto3" json:"descriptors,omitempty"`
// Events the service reacts to.
Subscriptions []*Subscription `protobuf:"bytes,14,rep,name=subscriptions,proto3" json:"subscriptions,omitempty"`
// Temporal Schedules of the service's own workflows.
Schedules []*Schedule `protobuf:"bytes,15,rep,name=schedules,proto3" json:"schedules,omitempty"`
// The service's own workflows the console may start (§9).
Workflows []*Workflow `protobuf:"bytes,16,rep,name=workflows,proto3" json:"workflows,omitempty"`
// Optional telemetry view presets. Absence uses service.name convention;
// an explicitly empty declaration disables presets, never signal ingestion.
Telemetry *TelemetrySources `protobuf:"bytes,17,opt,name=telemetry,proto3" json:"telemetry,omitempty"`
// contains filtered or unexported fields
}
Manifest is everything a service declares. The SDK assembles it at start and writes it to Consul KV `backplane/services/<service>/manifests/<version>` as protobuf binary. Names are mandatory; schemas are optional.
func (*Manifest) Descriptor
deprecated
func (*Manifest) GetActivities ¶
func (*Manifest) GetConfig ¶
func (x *Manifest) GetConfig() *ConfigSection
func (*Manifest) GetDescriptors ¶
func (*Manifest) GetInternalServices ¶
func (*Manifest) GetSchedules ¶
func (*Manifest) GetSdkVersion ¶
func (*Manifest) GetService ¶
func (*Manifest) GetSubscriptions ¶
func (x *Manifest) GetSubscriptions() []*Subscription
func (*Manifest) GetTelemetry ¶
func (x *Manifest) GetTelemetry() *TelemetrySources
func (*Manifest) GetVersion ¶
func (*Manifest) GetWorkflows ¶
func (*Manifest) ProtoMessage ¶
func (*Manifest) ProtoMessage()
func (*Manifest) ProtoReflect ¶
func (x *Manifest) ProtoReflect() protoreflect.Message
type Node ¶
type Node struct {
// Place in the tree: "users", "users/templates".
Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
Kind NodeKind `protobuf:"varint,2,opt,name=kind,proto3,enum=backplane.v1.NodeKind" json:"kind,omitempty"`
// Optional dependencies do not hold readiness.
Optional bool `protobuf:"varint,3,opt,name=optional,proto3" json:"optional,omitempty"`
// contains filtered or unexported fields
}
A node of the service tree: component, dependency or singleton.
func (*Node) Descriptor
deprecated
func (*Node) GetOptional ¶
func (*Node) ProtoMessage ¶
func (*Node) ProtoMessage()
func (*Node) ProtoReflect ¶
func (x *Node) ProtoReflect() protoreflect.Message
type NodeKind ¶
type NodeKind int32
func (NodeKind) Descriptor ¶
func (NodeKind) Descriptor() protoreflect.EnumDescriptor
func (NodeKind) EnumDescriptor
deprecated
func (NodeKind) Number ¶
func (x NodeKind) Number() protoreflect.EnumNumber
func (NodeKind) Type ¶
func (NodeKind) Type() protoreflect.EnumType
type NodeStatus ¶
type NodeStatus struct {
Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
Ready bool `protobuf:"varint,2,opt,name=ready,proto3" json:"ready,omitempty"`
// Why it is not ready.
Error string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
// contains filtered or unexported fields
}
func (*NodeStatus) Descriptor
deprecated
func (*NodeStatus) Descriptor() ([]byte, []int)
Deprecated: Use NodeStatus.ProtoReflect.Descriptor instead.
func (*NodeStatus) GetError ¶
func (x *NodeStatus) GetError() string
func (*NodeStatus) GetPath ¶
func (x *NodeStatus) GetPath() string
func (*NodeStatus) GetReady ¶
func (x *NodeStatus) GetReady() bool
func (*NodeStatus) ProtoMessage ¶
func (*NodeStatus) ProtoMessage()
func (*NodeStatus) ProtoReflect ¶
func (x *NodeStatus) ProtoReflect() protoreflect.Message
func (*NodeStatus) Reset ¶
func (x *NodeStatus) Reset()
func (*NodeStatus) String ¶
func (x *NodeStatus) String() string
type RunRequest ¶ added in v0.3.0
type RunRequest struct {
Call *ActivityCall `protobuf:"bytes,1,opt,name=call,proto3" json:"call,omitempty"`
// contains filtered or unexported fields
}
func (*RunRequest) Descriptor
deprecated
added in
v0.3.0
func (*RunRequest) Descriptor() ([]byte, []int)
Deprecated: Use RunRequest.ProtoReflect.Descriptor instead.
func (*RunRequest) GetCall ¶ added in v0.3.0
func (x *RunRequest) GetCall() *ActivityCall
func (*RunRequest) ProtoMessage ¶ added in v0.3.0
func (*RunRequest) ProtoMessage()
func (*RunRequest) ProtoReflect ¶ added in v0.3.0
func (x *RunRequest) ProtoReflect() protoreflect.Message
func (*RunRequest) Reset ¶ added in v0.3.0
func (x *RunRequest) Reset()
func (*RunRequest) String ¶ added in v0.3.0
func (x *RunRequest) String() string
type RunResponse ¶ added in v0.3.0
type RunResponse struct {
Result *ActivityResult `protobuf:"bytes,1,opt,name=result,proto3" json:"result,omitempty"`
// contains filtered or unexported fields
}
func (*RunResponse) Descriptor
deprecated
added in
v0.3.0
func (*RunResponse) Descriptor() ([]byte, []int)
Deprecated: Use RunResponse.ProtoReflect.Descriptor instead.
func (*RunResponse) GetResult ¶ added in v0.3.0
func (x *RunResponse) GetResult() *ActivityResult
func (*RunResponse) ProtoMessage ¶ added in v0.3.0
func (*RunResponse) ProtoMessage()
func (*RunResponse) ProtoReflect ¶ added in v0.3.0
func (x *RunResponse) ProtoReflect() protoreflect.Message
func (*RunResponse) Reset ¶ added in v0.3.0
func (x *RunResponse) Reset()
func (*RunResponse) String ¶ added in v0.3.0
func (x *RunResponse) String() string
type Schedule ¶
type Schedule struct {
// Unique within the service: [A-Za-z][A-Za-z0-9_]*.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// When the workflow starts.
//
// Types that are valid to be assigned to Spec:
//
// *Schedule_Cron
// *Schedule_Every
Spec isSchedule_Spec `protobuf_oneof:"spec"`
// Workflow type started.
Workflow string `protobuf:"bytes,4,opt,name=workflow,proto3" json:"workflow,omitempty"`
Overlap ScheduleOverlap `protobuf:"varint,5,opt,name=overlap,proto3,enum=backplane.v1.ScheduleOverlap" json:"overlap,omitempty"`
// Created paused.
Paused bool `protobuf:"varint,6,opt,name=paused,proto3" json:"paused,omitempty"`
// IANA time zone of a cron spec; empty is UTC.
TimeZone string `protobuf:"bytes,7,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
// Random delay up to this added to every start.
Jitter *durationpb.Duration `protobuf:"bytes,8,opt,name=jitter,proto3" json:"jitter,omitempty"`
// contains filtered or unexported fields
}
A Temporal Schedule the service declares; the SDK reconciles it at start. Schedule id "<service>/<name>"; it starts the workflow on the service's task queue with workflow id "<service>/<name>-<time>".
func (*Schedule) Descriptor
deprecated
func (*Schedule) GetEvery ¶
func (x *Schedule) GetEvery() *durationpb.Duration
func (*Schedule) GetJitter ¶
func (x *Schedule) GetJitter() *durationpb.Duration
func (*Schedule) GetOverlap ¶
func (x *Schedule) GetOverlap() ScheduleOverlap
func (*Schedule) GetTimeZone ¶
func (*Schedule) GetWorkflow ¶
func (*Schedule) ProtoMessage ¶
func (*Schedule) ProtoMessage()
func (*Schedule) ProtoReflect ¶
func (x *Schedule) ProtoReflect() protoreflect.Message
type ScheduleOverlap ¶
type ScheduleOverlap int32
What a start does while the previous run is still going.
const ( ScheduleOverlap_SCHEDULE_OVERLAP_UNSPECIFIED ScheduleOverlap = 0 // Do not start (the default). ScheduleOverlap_SCHEDULE_OVERLAP_SKIP ScheduleOverlap = 1 // Start once the running one ends; at most one waits. ScheduleOverlap_SCHEDULE_OVERLAP_BUFFER_ONE ScheduleOverlap = 2 // Start every missed one after the running one ends. ScheduleOverlap_SCHEDULE_OVERLAP_BUFFER_ALL ScheduleOverlap = 3 // Cancel the running one, then start. ScheduleOverlap_SCHEDULE_OVERLAP_CANCEL_OTHER ScheduleOverlap = 4 // Terminate the running one, then start. ScheduleOverlap_SCHEDULE_OVERLAP_TERMINATE_OTHER ScheduleOverlap = 5 // Start regardless. ScheduleOverlap_SCHEDULE_OVERLAP_ALLOW_ALL ScheduleOverlap = 6 )
func (ScheduleOverlap) Descriptor ¶
func (ScheduleOverlap) Descriptor() protoreflect.EnumDescriptor
func (ScheduleOverlap) Enum ¶
func (x ScheduleOverlap) Enum() *ScheduleOverlap
func (ScheduleOverlap) EnumDescriptor
deprecated
func (ScheduleOverlap) EnumDescriptor() ([]byte, []int)
Deprecated: Use ScheduleOverlap.Descriptor instead.
func (ScheduleOverlap) Number ¶
func (x ScheduleOverlap) Number() protoreflect.EnumNumber
func (ScheduleOverlap) String ¶
func (x ScheduleOverlap) String() string
func (ScheduleOverlap) Type ¶
func (ScheduleOverlap) Type() protoreflect.EnumType
type Schedule_Cron ¶
type Schedule_Cron struct {
// Cron expression as Temporal reads it (5-7 fields, @daily, ...).
Cron string `protobuf:"bytes,2,opt,name=cron,proto3,oneof"`
}
type Schedule_Every ¶
type Schedule_Every struct {
// Fixed interval.
Every *durationpb.Duration `protobuf:"bytes,3,opt,name=every,proto3,oneof"`
}
type SchemaFormat ¶
type SchemaFormat int32
const ( SchemaFormat_SCHEMA_FORMAT_UNSPECIFIED SchemaFormat = 0 SchemaFormat_SCHEMA_FORMAT_OPENAPI SchemaFormat = 1 SchemaFormat_SCHEMA_FORMAT_GRAPHQL SchemaFormat = 2 )
func (SchemaFormat) Descriptor ¶
func (SchemaFormat) Descriptor() protoreflect.EnumDescriptor
func (SchemaFormat) Enum ¶
func (x SchemaFormat) Enum() *SchemaFormat
func (SchemaFormat) EnumDescriptor
deprecated
func (SchemaFormat) EnumDescriptor() ([]byte, []int)
Deprecated: Use SchemaFormat.Descriptor instead.
func (SchemaFormat) Number ¶
func (x SchemaFormat) Number() protoreflect.EnumNumber
func (SchemaFormat) String ¶
func (x SchemaFormat) String() string
func (SchemaFormat) Type ¶
func (SchemaFormat) Type() protoreflect.EnumType
type Subscription ¶
type Subscription struct {
// Full event name "<service>.<Event>".
Event string `protobuf:"bytes,1,opt,name=event,proto3" json:"event,omitempty"`
// Durable consumer name, unique within the service: the node path of the
// reactor plus the event name.
Consumer string `protobuf:"bytes,2,opt,name=consumer,proto3" json:"consumer,omitempty"`
// contains filtered or unexported fields
}
A reactor: a durable consumer of another service's event.
func (*Subscription) Descriptor
deprecated
func (*Subscription) Descriptor() ([]byte, []int)
Deprecated: Use Subscription.ProtoReflect.Descriptor instead.
func (*Subscription) GetConsumer ¶
func (x *Subscription) GetConsumer() string
func (*Subscription) GetEvent ¶
func (x *Subscription) GetEvent() string
func (*Subscription) ProtoMessage ¶
func (*Subscription) ProtoMessage()
func (*Subscription) ProtoReflect ¶
func (x *Subscription) ProtoReflect() protoreflect.Message
func (*Subscription) Reset ¶
func (x *Subscription) Reset()
func (*Subscription) String ¶
func (x *Subscription) String() string
type TelemetrySourceSelector ¶
type TelemetrySourceSelector struct {
Resource map[string]string `` /* 143-byte string literal not displayed */
// contains filtered or unexported fields
}
Selectors are OR alternatives; attributes within one selector are AND exact matches against OTel resource attributes. They never grant access or identify trusted senders. The query driver maps resource names to storage fields.
func (*TelemetrySourceSelector) Descriptor
deprecated
func (*TelemetrySourceSelector) Descriptor() ([]byte, []int)
Deprecated: Use TelemetrySourceSelector.ProtoReflect.Descriptor instead.
func (*TelemetrySourceSelector) GetResource ¶
func (x *TelemetrySourceSelector) GetResource() map[string]string
func (*TelemetrySourceSelector) ProtoMessage ¶
func (*TelemetrySourceSelector) ProtoMessage()
func (*TelemetrySourceSelector) ProtoReflect ¶
func (x *TelemetrySourceSelector) ProtoReflect() protoreflect.Message
func (*TelemetrySourceSelector) Reset ¶
func (x *TelemetrySourceSelector) Reset()
func (*TelemetrySourceSelector) String ¶
func (x *TelemetrySourceSelector) String() string
type TelemetrySources ¶
type TelemetrySources struct {
Selectors []*TelemetrySourceSelector `protobuf:"bytes,1,rep,name=selectors,proto3" json:"selectors,omitempty"`
// contains filtered or unexported fields
}
func (*TelemetrySources) Descriptor
deprecated
func (*TelemetrySources) Descriptor() ([]byte, []int)
Deprecated: Use TelemetrySources.ProtoReflect.Descriptor instead.
func (*TelemetrySources) GetSelectors ¶
func (x *TelemetrySources) GetSelectors() []*TelemetrySourceSelector
func (*TelemetrySources) ProtoMessage ¶
func (*TelemetrySources) ProtoMessage()
func (*TelemetrySources) ProtoReflect ¶
func (x *TelemetrySources) ProtoReflect() protoreflect.Message
func (*TelemetrySources) Reset ¶
func (x *TelemetrySources) Reset()
func (*TelemetrySources) String ¶
func (x *TelemetrySources) String() string
type TransportStatus ¶
type TransportStatus struct {
// "consul", "nats", "temporal", "otlp".
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Connected bool `protobuf:"varint,2,opt,name=connected,proto3" json:"connected,omitempty"`
Error string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
// contains filtered or unexported fields
}
func (*TransportStatus) Descriptor
deprecated
func (*TransportStatus) Descriptor() ([]byte, []int)
Deprecated: Use TransportStatus.ProtoReflect.Descriptor instead.
func (*TransportStatus) GetConnected ¶
func (x *TransportStatus) GetConnected() bool
func (*TransportStatus) GetError ¶
func (x *TransportStatus) GetError() string
func (*TransportStatus) GetName ¶
func (x *TransportStatus) GetName() string
func (*TransportStatus) ProtoMessage ¶
func (*TransportStatus) ProtoMessage()
func (*TransportStatus) ProtoReflect ¶
func (x *TransportStatus) ProtoReflect() protoreflect.Message
func (*TransportStatus) Reset ¶
func (x *TransportStatus) Reset()
func (*TransportStatus) String ¶
func (x *TransportStatus) String() string
type UI ¶
type UI struct {
// Content hash of the bundle served at GET /_backplane/ui/.
Hash string `protobuf:"bytes,1,opt,name=hash,proto3" json:"hash,omitempty"`
SdkMajor uint32 `protobuf:"varint,2,opt,name=sdk_major,json=sdkMajor,proto3" json:"sdk_major,omitempty"`
// contains filtered or unexported fields
}
func (*UI) Descriptor
deprecated
func (*UI) GetSdkMajor ¶
func (*UI) ProtoMessage ¶
func (*UI) ProtoMessage()
func (*UI) ProtoReflect ¶
func (x *UI) ProtoReflect() protoreflect.Message
type UnimplementedActivityServiceServer ¶ added in v0.3.0
type UnimplementedActivityServiceServer struct{}
UnimplementedActivityServiceServer must be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedActivityServiceServer) Run ¶ added in v0.3.0
func (UnimplementedActivityServiceServer) Run(context.Context, *RunRequest) (*RunResponse, error)
type UnsafeActivityServiceServer ¶ added in v0.3.0
type UnsafeActivityServiceServer interface {
// contains filtered or unexported methods
}
UnsafeActivityServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ActivityServiceServer will result in compilation errors.
type Workflow ¶
type Workflow struct {
// Temporal workflow type name.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Input *schemapb.Schema `protobuf:"bytes,2,opt,name=input,proto3" json:"input,omitempty"`
Output *schemapb.Schema `protobuf:"bytes,3,opt,name=output,proto3" json:"output,omitempty"`
Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
A workflow of the service the console may start with a form.
func (*Workflow) Descriptor
deprecated
func (*Workflow) GetDescription ¶
func (*Workflow) ProtoMessage ¶
func (*Workflow) ProtoMessage()
func (*Workflow) ProtoReflect ¶
func (x *Workflow) ProtoReflect() protoreflect.Message