psm_j5pb

package
v0.0.0-...-96e4ad1 Latest Latest
Warning

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

 Go to latest Published: Feb 20, 2025 License: MIT Imports: 9 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_j5_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
	//	*Cause_Init
	//	*Cause_Message
	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() *auth_j5pb.Action

func (*Cause) GetExternalEvent 

func (x *Cause) GetExternalEvent() *ExternalEventCause

func (*Cause) GetInit 

func (x *Cause) GetInit() *InitCause

func (*Cause) GetMessage 

func (x *Cause) GetMessage() *MessageCause

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 *auth_j5pb.Action `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_Init 

type Cause_Init struct {
	Init *InitCause `protobuf:"bytes,5,opt,name=init,proto3,oneof"`
}

type Cause_Message 

type Cause_Message struct {
	Message *MessageCause `protobuf:"bytes,6,opt,name=message,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 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
}

EventPublishMetadata is like EventMetadata but used in publish messages, and doesn't cause protostate/psm parsers to think the message is an event.

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 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 InitCause 

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

func (*InitCause) Descriptor deprecated 

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

Deprecated: Use InitCause.ProtoReflect.Descriptor instead.

func (*InitCause) ProtoMessage 

func (*InitCause) ProtoMessage()

func (*InitCause) ProtoReflect 

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

func (*InitCause) Reset 

func (x *InitCause) Reset()

func (*InitCause) String 

func (x *InitCause) String() string

type IsCause_Type 

type IsCause_Type = isCause_Type

type MessageCause 

type MessageCause struct {
	Method    string `protobuf:"bytes,1,opt,name=method,proto3" json:"method,omitempty"`
	MessageId string `protobuf:"bytes,2,opt,name=message_id,json=messageId,proto3" json:"message_id,omitempty"`
	// Then o5.application.name which sent the message
	SourceApp string `protobuf:"bytes,3,opt,name=source_app,json=sourceApp,proto3" json:"source_app,omitempty"`
	// The o5.environment.full_name which sent the message
	SourceEnv string `protobuf:"bytes,4,opt,name=source_env,json=sourceEnv,proto3" json:"source_env,omitempty"`
	// contains filtered or unexported fields
}

The event was caused by an o5 message

func (*MessageCause) Descriptor deprecated 

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

Deprecated: Use MessageCause.ProtoReflect.Descriptor instead.

func (*MessageCause) GetMessageId 

func (x *MessageCause) GetMessageId() string

func (*MessageCause) GetMethod 

func (x *MessageCause) GetMethod() string

func (*MessageCause) GetSourceApp 

func (x *MessageCause) GetSourceApp() string

func (*MessageCause) GetSourceEnv 

func (x *MessageCause) GetSourceEnv() string

func (*MessageCause) ProtoMessage 

func (*MessageCause) ProtoMessage()

func (*MessageCause) ProtoReflect 

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

func (*MessageCause) Reset 

func (x *MessageCause) Reset()

func (*MessageCause) String 

func (x *MessageCause) 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
	// j5.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 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

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.