backplanev1

package
v0.6.89 Latest Latest
Warning

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

Go to latest
Published: Nov 13, 2026 License: MIT Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ActivityService_Run_FullMethodName = "/backplane.v1.ActivityService/Run"
)

Variables

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

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

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

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

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

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

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

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

View Source
var File_backplanepb_v1_call_proto protoreflect.FileDescriptor
View Source
var File_backplanepb_v1_instance_proto protoreflect.FileDescriptor
View Source
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"`
	// The listener the route is served on, by the name the code gives it
	// (api.Listen, api.Port); empty: the default public port. Its port is the
	// instance's: InstanceState.public_port and listeners.
	Listener string `protobuf:"bytes,11,opt,name=listener,proto3" json:"listener,omitempty"`
	// gRPC and ws-proto: full names of the services behind the
	// route; their descriptors are in the service's descriptor set
	// (Manifest.descriptors_hash).
	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_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) Descriptor() ([]byte, []int)

Deprecated: Use API.ProtoReflect.Descriptor instead.

func (*API) GetBundle

func (x *API) GetBundle() *APISchemaBundle

func (*API) GetGraphql

func (x *API) GetGraphql() []byte

func (*API) GetHost

func (x *API) GetHost() string

func (*API) GetKind

func (x *API) GetKind() ApiKind

func (*API) GetListener added in v0.6.58

func (x *API) GetListener() string

func (*API) GetOpenapi

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

func (*API) GetPrefix

func (x *API) GetPrefix() string

func (*API) GetSchema

func (x *API) GetSchema() isAPI_Schema

func (*API) GetServices

func (x *API) GetServices() []string

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 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_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) Descriptor() ([]byte, []int)

Deprecated: Use Activity.ProtoReflect.Descriptor instead.

func (*Activity) GetDescription

func (x *Activity) GetDescription() string

func (*Activity) GetHeartbeat

func (x *Activity) GetHeartbeat() *durationpb.Duration

func (*Activity) GetInput

func (x *Activity) GetInput() *schemapb.Schema

func (*Activity) GetKind

func (x *Activity) GetKind() ActivityKind

func (*Activity) GetName

func (x *Activity) GetName() string

func (*Activity) GetOutput

func (x *Activity) GetOutput() *schemapb.Schema

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

func (*Activity) Reset

func (x *Activity) Reset()

func (*Activity) String

func (x *Activity) String() string

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) Enum

func (x ActivityKind) Enum() *ActivityKind

func (ActivityKind) EnumDescriptor deprecated

func (ActivityKind) EnumDescriptor() ([]byte, []int)

Deprecated: Use ActivityKind.Descriptor instead.

func (ActivityKind) Number

func (ActivityKind) String

func (x ActivityKind) String() string

func (ActivityKind) Type

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
const (
	ApiKind_API_KIND_UNSPECIFIED ApiKind = 0
	ApiKind_API_KIND_HTTP        ApiKind = 1
	ApiKind_API_KIND_GRPC        ApiKind = 2
	ApiKind_API_KIND_WS_PROTO    ApiKind = 4
	ApiKind_API_KIND_GRAPHQL     ApiKind = 5
)

func (ApiKind) Descriptor

func (ApiKind) Descriptor() protoreflect.EnumDescriptor

func (ApiKind) Enum

func (x ApiKind) Enum() *ApiKind

func (ApiKind) EnumDescriptor deprecated

func (ApiKind) EnumDescriptor() ([]byte, []int)

Deprecated: Use ApiKind.Descriptor instead.

func (ApiKind) Number

func (x ApiKind) Number() protoreflect.EnumNumber

func (ApiKind) String

func (x ApiKind) String() string

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) Enum

func (x ConfigSource) Enum() *ConfigSource

func (ConfigSource) EnumDescriptor deprecated

func (ConfigSource) EnumDescriptor() ([]byte, []int)

Deprecated: Use ConfigSource.Descriptor instead.

func (ConfigSource) Number

func (ConfigSource) String

func (x ConfigSource) String() string

func (ConfigSource) Type

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) Descriptor() ([]byte, []int)

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetDescription

func (x *Event) GetDescription() string

func (*Event) GetName

func (x *Event) GetName() string

func (*Event) GetSchema

func (x *Event) GetSchema() *schemapb.Schema

func (*Event) ProtoMessage

func (*Event) ProtoMessage()

func (*Event) ProtoReflect

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

func (*Event) Reset

func (x *Event) Reset()

func (*Event) String

func (x *Event) String() string

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) Descriptor() ([]byte, []int)

Deprecated: Use Hook.ProtoReflect.Descriptor instead.

func (*Hook) GetDescription

func (x *Hook) GetDescription() string

func (*Hook) GetInput

func (x *Hook) GetInput() *schemapb.Schema

func (*Hook) GetName

func (x *Hook) GetName() string

func (*Hook) GetOutput

func (x *Hook) GetOutput() *schemapb.Schema

func (*Hook) GetRequired

func (x *Hook) GetRequired() bool

func (*Hook) GetTimeout

func (x *Hook) GetTimeout() *durationpb.Duration

func (*Hook) ProtoMessage

func (*Hook) ProtoMessage()

func (*Hook) ProtoReflect

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

func (*Hook) Reset

func (x *Hook) Reset()

func (*Hook) String

func (x *Hook) String() string

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) Descriptor() ([]byte, []int)

Deprecated: Use HookCall.ProtoReflect.Descriptor instead.

func (*HookCall) GetDeadline

func (x *HookCall) GetDeadline() *durationpb.Duration

func (*HookCall) GetHook

func (x *HookCall) GetHook() string

func (*HookCall) GetInstance

func (x *HookCall) GetInstance() string

func (*HookCall) GetKey added in v0.6.35

func (x *HookCall) GetKey() string

func (*HookCall) GetMetadata added in v0.6.36

func (x *HookCall) GetMetadata() map[string]string

func (*HookCall) GetPayload

func (x *HookCall) GetPayload() []byte

func (*HookCall) GetTrace

func (x *HookCall) GetTrace() map[string]string

func (*HookCall) ProtoMessage

func (*HookCall) ProtoMessage()

func (*HookCall) ProtoReflect

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

func (*HookCall) Reset

func (x *HookCall) Reset()

func (*HookCall) String

func (x *HookCall) String() string

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) Enum

func (x InstancePhase) Enum() *InstancePhase

func (InstancePhase) EnumDescriptor deprecated

func (InstancePhase) EnumDescriptor() ([]byte, []int)

Deprecated: Use InstancePhase.Descriptor instead.

func (InstancePhase) Number

func (InstancePhase) String

func (x InstancePhase) String() string

func (InstancePhase) Type

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"`
	// The node tree the author composed, depth-first in creation (= start)
	// order: components, dependencies and singletons.
	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"`
	// Live values of sections the manifest declares (sections.OfferLive), by
	// name: they replace the manifest's value while the instance runs.
	Sections map[string]*anypb.Any `` /* 144-byte string literal not displayed */
	// Port of the default public port's routes (API.listener empty); 0 when
	// none is served there.
	PublicPort uint32 `protobuf:"varint,18,opt,name=public_port,json=publicPort,proto3" json:"public_port,omitempty"`
	// Ports of the named listeners of routes (API.listener), by name.
	Listeners map[string]uint32 `` /* 147-byte string literal not displayed */
	// 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) GetListeners added in v0.6.58

func (x *InstanceState) GetListeners() map[string]uint32

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) GetPublicPort added in v0.6.58

func (x *InstanceState) GetPublicPort() uint32

func (*InstanceState) GetSdkVersion

func (x *InstanceState) GetSdkVersion() string

func (*InstanceState) GetSections added in v0.6.45

func (x *InstanceState) GetSections() map[string]*anypb.Any

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"`
	// Content hash of the service's FileDescriptorSet: every service named by
	// an API (API.services, with descriptors registration or api.Descriptors
	// gives) and by internal_services, with transitive imports. The SDK
	// serves it on the platform port as file descriptors.binpb of the API
	// file bundle with this hash, like APISchemaBundle; empty: no services.
	DescriptorsHash string `protobuf:"bytes,19,opt,name=descriptors_hash,json=descriptorsHash,proto3" json:"descriptors_hash,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"`
	// Sections of the service's own: proto messages by name the product
	// defines (sections.Offer). Backplane publishes those of the serving
	// services to Consul KV `backplane/sections/<name>` (SectionSet); a
	// service follows a name with sections.Follow — discovery without a
	// registry of the product's.
	Sections map[string]*anypb.Any `` /* 144-byte string literal not displayed */
	// 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) Descriptor() ([]byte, []int)

Deprecated: Use Manifest.ProtoReflect.Descriptor instead.

func (*Manifest) GetActivities

func (x *Manifest) GetActivities() []*Activity

func (*Manifest) GetApis

func (x *Manifest) GetApis() []*API

func (*Manifest) GetConfig

func (x *Manifest) GetConfig() *ConfigSection

func (*Manifest) GetDescriptorsHash added in v0.6.71

func (x *Manifest) GetDescriptorsHash() string

func (*Manifest) GetEvents

func (x *Manifest) GetEvents() []*Event

func (*Manifest) GetHooks

func (x *Manifest) GetHooks() []*Hook

func (*Manifest) GetInternalServices

func (x *Manifest) GetInternalServices() []string

func (*Manifest) GetSchedules

func (x *Manifest) GetSchedules() []*Schedule

func (*Manifest) GetSdkVersion

func (x *Manifest) GetSdkVersion() string

func (*Manifest) GetSections added in v0.6.37

func (x *Manifest) GetSections() map[string]*anypb.Any

func (*Manifest) GetService

func (x *Manifest) GetService() string

func (*Manifest) GetSubscriptions

func (x *Manifest) GetSubscriptions() []*Subscription

func (*Manifest) GetTelemetry

func (x *Manifest) GetTelemetry() *TelemetrySources

func (*Manifest) GetUi

func (x *Manifest) GetUi() *UI

func (*Manifest) GetVersion

func (x *Manifest) GetVersion() string

func (*Manifest) GetWorkflows

func (x *Manifest) GetWorkflows() []*Workflow

func (*Manifest) ProtoMessage

func (*Manifest) ProtoMessage()

func (*Manifest) ProtoReflect

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

func (*Manifest) Reset

func (x *Manifest) Reset()

func (*Manifest) String

func (x *Manifest) String() string

type NodeKind

type NodeKind int32
const (
	NodeKind_NODE_KIND_UNSPECIFIED NodeKind = 0
	NodeKind_NODE_KIND_COMPONENT   NodeKind = 1
	NodeKind_NODE_KIND_DEPENDENCY  NodeKind = 2
	NodeKind_NODE_KIND_SINGLETON   NodeKind = 3
)

func (NodeKind) Descriptor

func (NodeKind) Descriptor() protoreflect.EnumDescriptor

func (NodeKind) Enum

func (x NodeKind) Enum() *NodeKind

func (NodeKind) EnumDescriptor deprecated

func (NodeKind) EnumDescriptor() ([]byte, []int)

Deprecated: Use NodeKind.Descriptor instead.

func (NodeKind) Number

func (x NodeKind) Number() protoreflect.EnumNumber

func (NodeKind) String

func (x NodeKind) String() string

func (NodeKind) Type

type NodeStatus

type NodeStatus struct {

	// Place in the tree: "users", "users/templates".
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// Dependencies only: whether it is ready.
	Ready bool `protobuf:"varint,2,opt,name=ready,proto3" json:"ready,omitempty"`
	// Dependencies only: why it is not ready.
	Error string   `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	Kind  NodeKind `protobuf:"varint,4,opt,name=kind,proto3,enum=backplane.v1.NodeKind" json:"kind,omitempty"`
	// Optional dependencies do not hold readiness.
	Optional bool `protobuf:"varint,5,opt,name=optional,proto3" json:"optional,omitempty"`
	// contains filtered or unexported fields
}

A node of the service tree: component, dependency or singleton.

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) GetKind added in v0.6.58

func (x *NodeStatus) GetKind() NodeKind

func (*NodeStatus) GetOptional added in v0.6.58

func (x *NodeStatus) GetOptional() bool

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) Descriptor() ([]byte, []int)

Deprecated: Use Schedule.ProtoReflect.Descriptor instead.

func (*Schedule) GetCron

func (x *Schedule) GetCron() string

func (*Schedule) GetEvery

func (x *Schedule) GetEvery() *durationpb.Duration

func (*Schedule) GetJitter

func (x *Schedule) GetJitter() *durationpb.Duration

func (*Schedule) GetName

func (x *Schedule) GetName() string

func (*Schedule) GetOverlap

func (x *Schedule) GetOverlap() ScheduleOverlap

func (*Schedule) GetPaused

func (x *Schedule) GetPaused() bool

func (*Schedule) GetSpec

func (x *Schedule) GetSpec() isSchedule_Spec

func (*Schedule) GetTimeZone

func (x *Schedule) GetTimeZone() string

func (*Schedule) GetWorkflow

func (x *Schedule) GetWorkflow() string

func (*Schedule) ProtoMessage

func (*Schedule) ProtoMessage()

func (*Schedule) ProtoReflect

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

func (*Schedule) Reset

func (x *Schedule) Reset()

func (*Schedule) String

func (x *Schedule) String() string

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) Enum

func (x ScheduleOverlap) Enum() *ScheduleOverlap

func (ScheduleOverlap) EnumDescriptor deprecated

func (ScheduleOverlap) EnumDescriptor() ([]byte, []int)

Deprecated: Use ScheduleOverlap.Descriptor instead.

func (ScheduleOverlap) Number

func (ScheduleOverlap) String

func (x ScheduleOverlap) String() string

func (ScheduleOverlap) Type

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) Enum

func (x SchemaFormat) Enum() *SchemaFormat

func (SchemaFormat) EnumDescriptor deprecated

func (SchemaFormat) EnumDescriptor() ([]byte, []int)

Deprecated: Use SchemaFormat.Descriptor instead.

func (SchemaFormat) Number

func (SchemaFormat) String

func (x SchemaFormat) String() string

func (SchemaFormat) Type

type SectionSet added in v0.6.37

type SectionSet struct {
	Services map[string]*anypb.Any `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

SectionSet is one section name across the installation: by service, the section of its highest serving version. Backplane writes it to Consul KV `backplane/sections/<name>` as protobuf binary.

func (*SectionSet) Descriptor deprecated added in v0.6.37

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

Deprecated: Use SectionSet.ProtoReflect.Descriptor instead.

func (*SectionSet) GetServices added in v0.6.37

func (x *SectionSet) GetServices() map[string]*anypb.Any

func (*SectionSet) ProtoMessage added in v0.6.37

func (*SectionSet) ProtoMessage()

func (*SectionSet) ProtoReflect added in v0.6.37

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

func (*SectionSet) Reset added in v0.6.37

func (x *SectionSet) Reset()

func (*SectionSet) String added in v0.6.37

func (x *SectionSet) String() string

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) Descriptor() ([]byte, []int)

Deprecated: Use UI.ProtoReflect.Descriptor instead.

func (*UI) GetHash

func (x *UI) GetHash() string

func (*UI) GetSdkMajor

func (x *UI) GetSdkMajor() uint32

func (*UI) ProtoMessage

func (*UI) ProtoMessage()

func (*UI) ProtoReflect

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

func (*UI) Reset

func (x *UI) Reset()

func (*UI) String

func (x *UI) String() string

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

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) Descriptor() ([]byte, []int)

Deprecated: Use Workflow.ProtoReflect.Descriptor instead.

func (*Workflow) GetDescription

func (x *Workflow) GetDescription() string

func (*Workflow) GetInput

func (x *Workflow) GetInput() *schemapb.Schema

func (*Workflow) GetName

func (x *Workflow) GetName() string

func (*Workflow) GetOutput

func (x *Workflow) GetOutput() *schemapb.Schema

func (*Workflow) ProtoMessage

func (*Workflow) ProtoMessage()

func (*Workflow) ProtoReflect

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

func (*Workflow) Reset

func (x *Workflow) Reset()

func (*Workflow) String

func (x *Workflow) String() string

Jump to

Keyboard shortcuts

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