psm_pb

package
v0.0.0-...-6ae7d31 Latest Latest
Warning

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

 Go to latest Published: Jun 6, 2024 License: MIT Imports: 9 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// optional psm.state.v1.PSMOptions psm = 90443400;
	E_Psm = &file_psm_state_v1_annotations_proto_extTypes[0]
	// optional psm.state.v1.EventTypeObjectOptions event_type = 90443402;
	E_EventType = &file_psm_state_v1_annotations_proto_extTypes[1]
)

Extension fields to descriptorpb.MessageOptions.

View Source 
var (
	// optional psm.state.v1.FieldOptions field = 90443405;
	E_Field = &file_psm_state_v1_annotations_proto_extTypes[2]
	// optional psm.state.v1.EventTypeField event_type_field = 90443404;
	E_EventTypeField = &file_psm_state_v1_annotations_proto_extTypes[3]
)

Extension fields to descriptorpb.FieldOptions.

View Source 
var (
	// optional psm.state.v1.StateQueryServiceOptions state_query = 90443405;
	E_StateQuery = &file_psm_state_v1_annotations_proto_extTypes[4]
)

Extension fields to descriptorpb.ServiceOptions.

View Source 
var (
	// optional psm.state.v1.StateQueryMethodOptions state_query_method = 90443406;
	E_StateQueryMethod = &file_psm_state_v1_annotations_proto_extTypes[5]
)

Extension fields to descriptorpb.MethodOptions.

View Source 
var File_psm_state_v1_annotations_proto protoreflect.FileDescriptor
View Source 
var File_psm_state_v1_metadata_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Cause 

type Cause struct {

	// Types that are assignable to Type:
	//
	//	*Cause_PsmEvent
	//	*Cause_Command
	//	*Cause_ExternalEvent
	//	*Cause_Reply
	Type isCause_Type `protobuf_oneof:"type"`
	// contains filtered or unexported fields
}

Events are caused by either an actor external to the boundary, an application within the boundary, the state machine itself,

func (*Cause) Descriptor deprecated 

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

Deprecated: Use Cause.ProtoReflect.Descriptor instead.

func (*Cause) GetCommand 

func (x *Cause) GetCommand() *CommandCause

func (*Cause) GetExternalEvent 

func (x *Cause) GetExternalEvent() *ExternalEventCause

func (*Cause) GetPsmEvent 

func (x *Cause) GetPsmEvent() *PSMEventCause

func (*Cause) GetReply 

func (x *Cause) GetReply() *ReplyCause

func (*Cause) GetType 

func (m *Cause) GetType() isCause_Type

func (*Cause) ProtoMessage 

func (*Cause) ProtoMessage()

func (*Cause) ProtoReflect 

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

func (*Cause) Reset 

func (x *Cause) Reset()

func (*Cause) String 

func (x *Cause) String() string

type Cause_Command 

type Cause_Command struct {
	Command *CommandCause `protobuf:"bytes,2,opt,name=command,proto3,oneof"`
}

type Cause_ExternalEvent 

type Cause_ExternalEvent struct {
	ExternalEvent *ExternalEventCause `protobuf:"bytes,3,opt,name=external_event,json=externalEvent,proto3,oneof"`
}

type Cause_PsmEvent 

type Cause_PsmEvent struct {
	PsmEvent *PSMEventCause `protobuf:"bytes,1,opt,name=psm_event,json=psmEvent,proto3,oneof"`
}

type Cause_Reply 

type Cause_Reply struct {
	Reply *ReplyCause `protobuf:"bytes,4,opt,name=reply,proto3,oneof"`
}

type CommandCause 

type CommandCause struct {

	// {package}.{service}/{method}. E.g. "foo.bar.v1.FooService/BarMethod"
	MethodName string         `protobuf:"bytes,1,opt,name=method_name,json=methodName,proto3" json:"method_name,omitempty"`
	Actor      *auth_pb.Actor `protobuf:"bytes,2,opt,name=actor,proto3" json:"actor,omitempty"`
	// contains filtered or unexported fields
}

The event was caused by a 'Command' service, i.e. an authenticated gRPC call to a service from outside of the environment boundary which was translated into an event

func (*CommandCause) Descriptor deprecated 

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

Deprecated: Use CommandCause.ProtoReflect.Descriptor instead.

func (*CommandCause) GetActor 

func (x *CommandCause) GetActor() *auth_pb.Actor

func (*CommandCause) GetMethodName 

func (x *CommandCause) GetMethodName() string

func (*CommandCause) ProtoMessage 

func (*CommandCause) ProtoMessage()

func (*CommandCause) ProtoReflect 

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

func (*CommandCause) Reset 

func (x *CommandCause) Reset()

func (*CommandCause) String 

func (x *CommandCause) String() string

type EventMetadata 

type EventMetadata struct {
	EventId string `protobuf:"bytes,1,opt,name=event_id,json=eventId,proto3" json:"event_id,omitempty"`
	// Sequence within the state machine. Discrete, 1,2,3
	Sequence  uint64                 `protobuf:"varint,2,opt,name=sequence,proto3" json:"sequence,omitempty"`
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	Cause     *Cause                 `protobuf:"bytes,4,opt,name=cause,proto3" json:"cause,omitempty"`
	// contains filtered or unexported fields
}

func (*EventMetadata) Descriptor deprecated 

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

Deprecated: Use EventMetadata.ProtoReflect.Descriptor instead.

func (*EventMetadata) GetCause 

func (x *EventMetadata) GetCause() *Cause

func (*EventMetadata) GetEventId 

func (x *EventMetadata) GetEventId() string

func (*EventMetadata) GetSequence 

func (x *EventMetadata) GetSequence() uint64

func (*EventMetadata) GetTimestamp 

func (x *EventMetadata) GetTimestamp() *timestamppb.Timestamp

func (*EventMetadata) ProtoMessage 

func (*EventMetadata) ProtoMessage()

func (*EventMetadata) ProtoReflect 

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

func (*EventMetadata) Reset 

func (x *EventMetadata) Reset()

func (*EventMetadata) String 

func (x *EventMetadata) String() string

type EventPublishMetadata 

type EventPublishMetadata struct {
	EventId string `protobuf:"bytes,1,opt,name=event_id,json=eventId,proto3" json:"event_id,omitempty"`
	// Sequence within the state machine. Discrete, 1,2,3
	Sequence  uint64                 `protobuf:"varint,2,opt,name=sequence,proto3" json:"sequence,omitempty"`
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	Cause     *Cause                 `protobuf:"bytes,4,opt,name=cause,proto3" json:"cause,omitempty"`
	// contains filtered or unexported fields
}

func (*EventPublishMetadata) Descriptor deprecated 

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

Deprecated: Use EventPublishMetadata.ProtoReflect.Descriptor instead.

func (*EventPublishMetadata) GetCause 

func (x *EventPublishMetadata) GetCause() *Cause

func (*EventPublishMetadata) GetEventId 

func (x *EventPublishMetadata) GetEventId() string

func (*EventPublishMetadata) GetSequence 

func (x *EventPublishMetadata) GetSequence() uint64

func (*EventPublishMetadata) GetTimestamp 

func (x *EventPublishMetadata) GetTimestamp() *timestamppb.Timestamp

func (*EventPublishMetadata) ProtoMessage 

func (*EventPublishMetadata) ProtoMessage()

func (*EventPublishMetadata) ProtoReflect 

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

func (*EventPublishMetadata) Reset 

func (x *EventPublishMetadata) Reset()

func (*EventPublishMetadata) String 

func (x *EventPublishMetadata) String() string

type EventTypeField 

type EventTypeField struct {
	SubKey bool `protobuf:"varint,1,opt,name=sub_key,json=subKey,proto3" json:"sub_key,omitempty"`
	// contains filtered or unexported fields
}

func (*EventTypeField) Descriptor deprecated 

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

Deprecated: Use EventTypeField.ProtoReflect.Descriptor instead.

func (*EventTypeField) GetSubKey 

func (x *EventTypeField) GetSubKey() bool

func (*EventTypeField) ProtoMessage 

func (*EventTypeField) ProtoMessage()

func (*EventTypeField) ProtoReflect 

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

func (*EventTypeField) Reset 

func (x *EventTypeField) Reset()

func (*EventTypeField) String 

func (x *EventTypeField) String() string

type EventTypeObjectOptions 

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

func (*EventTypeObjectOptions) Descriptor deprecated 

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

Deprecated: Use EventTypeObjectOptions.ProtoReflect.Descriptor instead.

func (*EventTypeObjectOptions) ProtoMessage 

func (*EventTypeObjectOptions) ProtoMessage()

func (*EventTypeObjectOptions) ProtoReflect 

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

func (*EventTypeObjectOptions) Reset 

func (x *EventTypeObjectOptions) Reset()

func (*EventTypeObjectOptions) String 

func (x *EventTypeObjectOptions) String() string

type ExternalEventCause 

type ExternalEventCause struct {

	// The name of the external system that caused the event. No specific format
	// or rules.
	SystemName string `protobuf:"bytes,1,opt,name=system_name,json=systemName,proto3" json:"system_name,omitempty"`
	// The name of the event in the external system. No specific format or rules.
	EventName string `protobuf:"bytes,2,opt,name=event_name,json=eventName,proto3" json:"event_name,omitempty"`
	// The ID of the event in the external system as defined by that system.
	// ID generation must consistently derivable from the source event.
	// Do not make up IDs from the// current system time or random
	// Leave nil if an acceptable unique ID is not available.
	ExternalId *string `protobuf:"bytes,3,opt,name=external_id,json=externalId,proto3,oneof" json:"external_id,omitempty"`
	// contains filtered or unexported fields
}

The event was caused by an external event, e.g. a webhook, a message from a queue, etc.

func (*ExternalEventCause) Descriptor deprecated 

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

Deprecated: Use ExternalEventCause.ProtoReflect.Descriptor instead.

func (*ExternalEventCause) GetEventName 

func (x *ExternalEventCause) GetEventName() string

func (*ExternalEventCause) GetExternalId 

func (x *ExternalEventCause) GetExternalId() string

func (*ExternalEventCause) GetSystemName 

func (x *ExternalEventCause) GetSystemName() string

func (*ExternalEventCause) ProtoMessage 

func (*ExternalEventCause) ProtoMessage()

func (*ExternalEventCause) ProtoReflect 

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

func (*ExternalEventCause) Reset 

func (x *ExternalEventCause) Reset()

func (*ExternalEventCause) String 

func (x *ExternalEventCause) String() string

type FieldOptions 

type FieldOptions struct {

	// the field is the primary key of the state, or is one field in a multi-key
	// primary key for the state object. This field must exist on both the event
	// and the state
	PrimaryKey bool `protobuf:"varint,1,opt,name=primary_key,json=primaryKey,proto3" json:"primary_key,omitempty"`
	// contains filtered or unexported fields
}

func (*FieldOptions) Descriptor deprecated 

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

Deprecated: Use FieldOptions.ProtoReflect.Descriptor instead.

func (*FieldOptions) GetPrimaryKey 

func (x *FieldOptions) GetPrimaryKey() bool

func (*FieldOptions) ProtoMessage 

func (*FieldOptions) ProtoMessage()

func (*FieldOptions) ProtoReflect 

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

func (*FieldOptions) Reset 

func (x *FieldOptions) Reset()

func (*FieldOptions) String 

func (x *FieldOptions) String() string

type PSMEventCause 

type PSMEventCause struct {

	// The ID of the event that caused this event
	EventId string `protobuf:"bytes,1,opt,name=event_id,json=eventId,proto3" json:"event_id,omitempty"`
	// The identity of the state machine for the event.
	// {package}.{name}, where name is the annotated name in
	// psm.state.v1.(State|Event)ObjectOptions.name
	// e.g. "foo.bar.v1.foobar" (not foo.bar.v1.FooBarState)
	StateMachine string `protobuf:"bytes,2,opt,name=state_machine,json=stateMachine,proto3" json:"state_machine,omitempty"`
	// contains filtered or unexported fields
}

The event was caused by a transition in this or another state machine

func (*PSMEventCause) Descriptor deprecated 

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

Deprecated: Use PSMEventCause.ProtoReflect.Descriptor instead.

func (*PSMEventCause) GetEventId 

func (x *PSMEventCause) GetEventId() string

func (*PSMEventCause) GetStateMachine 

func (x *PSMEventCause) GetStateMachine() string

func (*PSMEventCause) ProtoMessage 

func (*PSMEventCause) ProtoMessage()

func (*PSMEventCause) ProtoReflect 

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

func (*PSMEventCause) Reset 

func (x *PSMEventCause) Reset()

func (*PSMEventCause) String 

func (x *PSMEventCause) String() string

type PSMOptions 

type PSMOptions struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*PSMOptions) Descriptor deprecated 

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

Deprecated: Use PSMOptions.ProtoReflect.Descriptor instead.

func (*PSMOptions) GetName 

func (x *PSMOptions) GetName() string

func (*PSMOptions) ProtoMessage 

func (*PSMOptions) ProtoMessage()

func (*PSMOptions) ProtoReflect 

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

func (*PSMOptions) Reset 

func (x *PSMOptions) Reset()

func (*PSMOptions) String 

func (x *PSMOptions) String() string

type ReplyCause 

type ReplyCause struct {
	Request *PSMEventCause `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"`
	// When true, the reply was via an event input from the external system, rather than
	// a simple request-reply like a HTTP call. This means the event was matched
	// using lookup keys in the vendor's event, and therefore not guaranteed to be
	// linked to the correct state machine.
	Async bool `protobuf:"varint,2,opt,name=async,proto3" json:"async,omitempty"`
	// contains filtered or unexported fields
}

An external system replying to a side-effect request, e.g. where the application sends a request to a vendor system, and the vendor replies.

func (*ReplyCause) Descriptor deprecated 

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

Deprecated: Use ReplyCause.ProtoReflect.Descriptor instead.

func (*ReplyCause) GetAsync 

func (x *ReplyCause) GetAsync() bool

func (*ReplyCause) GetRequest 

func (x *ReplyCause) GetRequest() *PSMEventCause

func (*ReplyCause) ProtoMessage 

func (*ReplyCause) ProtoMessage()

func (*ReplyCause) ProtoReflect 

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

func (*ReplyCause) Reset 

func (x *ReplyCause) Reset()

func (*ReplyCause) String 

func (x *ReplyCause) String() string

type StateMetadata 

type StateMetadata struct {

	// Time of the first event on the state machine
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Time of the most recent event on the state machine
	UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// Sequcence number of the most recent event on the state machine
	LastSequence uint64 `protobuf:"varint,3,opt,name=last_sequence,json=lastSequence,proto3" json:"last_sequence,omitempty"`
	// contains filtered or unexported fields
}

func (*StateMetadata) Descriptor deprecated 

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

Deprecated: Use StateMetadata.ProtoReflect.Descriptor instead.

func (*StateMetadata) GetCreatedAt 

func (x *StateMetadata) GetCreatedAt() *timestamppb.Timestamp

func (*StateMetadata) GetLastSequence 

func (x *StateMetadata) GetLastSequence() uint64

func (*StateMetadata) GetUpdatedAt 

func (x *StateMetadata) GetUpdatedAt() *timestamppb.Timestamp

func (*StateMetadata) ProtoMessage 

func (*StateMetadata) ProtoMessage()

func (*StateMetadata) ProtoReflect 

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

func (*StateMetadata) Reset 

func (x *StateMetadata) Reset()

func (*StateMetadata) String 

func (x *StateMetadata) String() string

type StateQueryMethodOptions 

type StateQueryMethodOptions struct {
	Get        bool `protobuf:"varint,1,opt,name=get,proto3" json:"get,omitempty"`
	List       bool `protobuf:"varint,2,opt,name=list,proto3" json:"list,omitempty"`
	ListEvents bool `protobuf:"varint,3,opt,name=list_events,json=listEvents,proto3" json:"list_events,omitempty"`
	// use name here instead of the service option to put multiple state query
	// methods in one service
	Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*StateQueryMethodOptions) Descriptor deprecated 

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

Deprecated: Use StateQueryMethodOptions.ProtoReflect.Descriptor instead.

func (*StateQueryMethodOptions) GetGet 

func (x *StateQueryMethodOptions) GetGet() bool

func (*StateQueryMethodOptions) GetList 

func (x *StateQueryMethodOptions) GetList() bool

func (*StateQueryMethodOptions) GetListEvents 

func (x *StateQueryMethodOptions) GetListEvents() bool

func (*StateQueryMethodOptions) GetName 

func (x *StateQueryMethodOptions) GetName() string

func (*StateQueryMethodOptions) ProtoMessage 

func (*StateQueryMethodOptions) ProtoMessage()

func (*StateQueryMethodOptions) ProtoReflect 

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

func (*StateQueryMethodOptions) Reset 

func (x *StateQueryMethodOptions) Reset()

func (*StateQueryMethodOptions) String 

func (x *StateQueryMethodOptions) String() string

type StateQueryServiceOptions 

type StateQueryServiceOptions struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*StateQueryServiceOptions) Descriptor deprecated 

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

Deprecated: Use StateQueryServiceOptions.ProtoReflect.Descriptor instead.

func (*StateQueryServiceOptions) GetName 

func (x *StateQueryServiceOptions) GetName() string

func (*StateQueryServiceOptions) ProtoMessage 

func (*StateQueryServiceOptions) ProtoMessage()

func (*StateQueryServiceOptions) ProtoReflect 

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

func (*StateQueryServiceOptions) Reset 

func (x *StateQueryServiceOptions) Reset()

func (*StateQueryServiceOptions) String 

func (x *StateQueryServiceOptions) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.