Documentation
¶
Index ¶
- Variables
- type Acceptance
- func (*Acceptance) Descriptor() ([]byte, []int)deprecated
- func (x *Acceptance) GetAcceptedRequest() *Request
- func (x *Acceptance) GetAcceptedRequestMessageId() string
- func (x *Acceptance) GetAcceptedRequestSequencingEventId() int64
- func (*Acceptance) ProtoMessage()
- func (x *Acceptance) ProtoReflect() protoreflect.Message
- func (x *Acceptance) Reset()
- func (x *Acceptance) String() string
- type Input
- func (*Input) Descriptor() ([]byte, []int)deprecated
- func (x *Input) GetArgs() *v11.Payloads
- func (x *Input) GetHeader() *v11.Header
- func (x *Input) GetName() string
- func (*Input) ProtoMessage()
- func (x *Input) ProtoReflect() protoreflect.Message
- func (x *Input) Reset()
- func (x *Input) String() string
- type Meta
- type Outcome
- func (*Outcome) Descriptor() ([]byte, []int)deprecated
- func (x *Outcome) GetFailure() *v12.Failure
- func (x *Outcome) GetSuccess() *v11.Payloads
- func (m *Outcome) GetValue() isOutcome_Value
- func (*Outcome) ProtoMessage()
- func (x *Outcome) ProtoReflect() protoreflect.Message
- func (x *Outcome) Reset()
- func (x *Outcome) String() string
- type Outcome_Failure
- type Outcome_Success
- type Rejection
- func (*Rejection) Descriptor() ([]byte, []int)deprecated
- func (x *Rejection) GetFailure() *v12.Failure
- func (x *Rejection) GetRejectedRequest() *Request
- func (x *Rejection) GetRejectedRequestMessageId() string
- func (x *Rejection) GetRejectedRequestSequencingEventId() int64
- func (*Rejection) ProtoMessage()
- func (x *Rejection) ProtoReflect() protoreflect.Message
- func (x *Rejection) Reset()
- func (x *Rejection) String() string
- type Request
- type Response
- type UpdateRef
- func (*UpdateRef) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateRef) GetUpdateId() string
- func (x *UpdateRef) GetWorkflowExecution() *v11.WorkflowExecution
- func (*UpdateRef) ProtoMessage()
- func (x *UpdateRef) ProtoReflect() protoreflect.Message
- func (x *UpdateRef) Reset()
- func (x *UpdateRef) String() string
- type WaitPolicy
Constants ¶
This section is empty.
Variables ¶
var File_temporal_api_update_v1_message_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Acceptance ¶
type Acceptance struct {
AcceptedRequestMessageId string `` /* 137-byte string literal not displayed */
AcceptedRequestSequencingEventId int64 `` /* 164-byte string literal not displayed */
AcceptedRequest *Request `protobuf:"bytes,3,opt,name=accepted_request,json=acceptedRequest,proto3" json:"accepted_request,omitempty"`
// contains filtered or unexported fields
}
An update protocol message indicating that a workflow execution update has been accepted (i.e. passed the worker-side validation phase).
func (*Acceptance) Descriptor
deprecated
func (*Acceptance) Descriptor() ([]byte, []int)
Deprecated: Use Acceptance.ProtoReflect.Descriptor instead.
func (*Acceptance) GetAcceptedRequest ¶
func (x *Acceptance) GetAcceptedRequest() *Request
func (*Acceptance) GetAcceptedRequestMessageId ¶
func (x *Acceptance) GetAcceptedRequestMessageId() string
func (*Acceptance) GetAcceptedRequestSequencingEventId ¶
func (x *Acceptance) GetAcceptedRequestSequencingEventId() int64
func (*Acceptance) ProtoMessage ¶
func (*Acceptance) ProtoMessage()
func (*Acceptance) ProtoReflect ¶
func (x *Acceptance) ProtoReflect() protoreflect.Message
func (*Acceptance) Reset ¶
func (x *Acceptance) Reset()
func (*Acceptance) String ¶
func (x *Acceptance) String() string
type Input ¶
type Input struct {
// Headers that are passed with the update from the requesting entity.
// These can include things like auth or tracing tokens.
Header *v11.Header `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
// The name of the input handler to invoke on the target workflow
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// The arguments to pass to the named handler.
Args *v11.Payloads `protobuf:"bytes,3,opt,name=args,proto3" json:"args,omitempty"`
// contains filtered or unexported fields
}
func (*Input) Descriptor
deprecated
func (*Input) ProtoMessage ¶
func (*Input) ProtoMessage()
func (*Input) ProtoReflect ¶
func (x *Input) ProtoReflect() protoreflect.Message
type Meta ¶
type Meta struct {
// An ID with workflow-scoped uniqueness for this update
UpdateId string `protobuf:"bytes,1,opt,name=update_id,json=updateId,proto3" json:"update_id,omitempty"`
// A string identifying the agent that requested this update.
Identity string `protobuf:"bytes,2,opt,name=identity,proto3" json:"identity,omitempty"`
// contains filtered or unexported fields
}
Metadata about a workflow execution update.
func (*Meta) Descriptor
deprecated
func (*Meta) GetIdentity ¶
func (*Meta) GetUpdateId ¶
func (*Meta) ProtoMessage ¶
func (*Meta) ProtoMessage()
func (*Meta) ProtoReflect ¶
func (x *Meta) ProtoReflect() protoreflect.Message
type Outcome ¶
type Outcome struct {
// Types that are assignable to Value:
//
// *Outcome_Success
// *Outcome_Failure
Value isOutcome_Value `protobuf_oneof:"value"`
// contains filtered or unexported fields
}
The outcome of a workflow update - success or failure.
func (*Outcome) Descriptor
deprecated
func (*Outcome) GetFailure ¶
func (*Outcome) GetSuccess ¶
func (*Outcome) ProtoMessage ¶
func (*Outcome) ProtoMessage()
func (*Outcome) ProtoReflect ¶
func (x *Outcome) ProtoReflect() protoreflect.Message
type Outcome_Failure ¶
type Outcome_Success ¶
type Rejection ¶
type Rejection struct {
RejectedRequestMessageId string `` /* 137-byte string literal not displayed */
RejectedRequestSequencingEventId int64 `` /* 164-byte string literal not displayed */
RejectedRequest *Request `protobuf:"bytes,3,opt,name=rejected_request,json=rejectedRequest,proto3" json:"rejected_request,omitempty"`
Failure *v12.Failure `protobuf:"bytes,4,opt,name=failure,proto3" json:"failure,omitempty"`
// contains filtered or unexported fields
}
An update protocol message indicating that a workflow execution update has been rejected.
func (*Rejection) Descriptor
deprecated
func (*Rejection) GetFailure ¶
func (*Rejection) GetRejectedRequest ¶
func (*Rejection) GetRejectedRequestMessageId ¶
func (*Rejection) GetRejectedRequestSequencingEventId ¶
func (*Rejection) ProtoMessage ¶
func (*Rejection) ProtoMessage()
func (*Rejection) ProtoReflect ¶
func (x *Rejection) ProtoReflect() protoreflect.Message
type Request ¶
type Request struct {
Meta *Meta `protobuf:"bytes,1,opt,name=meta,proto3" json:"meta,omitempty"`
Input *Input `protobuf:"bytes,2,opt,name=input,proto3" json:"input,omitempty"`
// contains filtered or unexported fields
}
The client request that triggers a workflow execution update
func (*Request) Descriptor
deprecated
func (*Request) ProtoMessage ¶
func (*Request) ProtoMessage()
func (*Request) ProtoReflect ¶
func (x *Request) ProtoReflect() protoreflect.Message
type Response ¶
type Response struct {
Meta *Meta `protobuf:"bytes,1,opt,name=meta,proto3" json:"meta,omitempty"`
Outcome *Outcome `protobuf:"bytes,2,opt,name=outcome,proto3" json:"outcome,omitempty"`
// contains filtered or unexported fields
}
An update protocol message indicating that a workflow execution update has completed with the contained outcome.
func (*Response) Descriptor
deprecated
func (*Response) GetOutcome ¶
func (*Response) ProtoMessage ¶
func (*Response) ProtoMessage()
func (*Response) ProtoReflect ¶
func (x *Response) ProtoReflect() protoreflect.Message
type UpdateRef ¶
type UpdateRef struct {
WorkflowExecution *v11.WorkflowExecution `protobuf:"bytes,1,opt,name=workflow_execution,json=workflowExecution,proto3" json:"workflow_execution,omitempty"`
UpdateId string `protobuf:"bytes,2,opt,name=update_id,json=updateId,proto3" json:"update_id,omitempty"`
// contains filtered or unexported fields
}
The data needed by a client to refer to an previously invoked workflow execution update process.
func (*UpdateRef) Descriptor
deprecated
func (*UpdateRef) GetUpdateId ¶
func (*UpdateRef) GetWorkflowExecution ¶
func (x *UpdateRef) GetWorkflowExecution() *v11.WorkflowExecution
func (*UpdateRef) ProtoMessage ¶
func (*UpdateRef) ProtoMessage()
func (*UpdateRef) ProtoReflect ¶
func (x *UpdateRef) ProtoReflect() protoreflect.Message
type WaitPolicy ¶
type WaitPolicy struct {
// Indicates the update lifecycle stage that the gRPC call should wait for
// before returning.
LifecycleStage v1.UpdateWorkflowExecutionLifecycleStage `` /* 169-byte string literal not displayed */
// contains filtered or unexported fields
}
Specifies to the gRPC server how long the client wants the an update-related RPC call to wait before returning control to the caller.
func (*WaitPolicy) Descriptor
deprecated
func (*WaitPolicy) Descriptor() ([]byte, []int)
Deprecated: Use WaitPolicy.ProtoReflect.Descriptor instead.
func (*WaitPolicy) GetLifecycleStage ¶
func (x *WaitPolicy) GetLifecycleStage() v1.UpdateWorkflowExecutionLifecycleStage
func (*WaitPolicy) ProtoMessage ¶
func (*WaitPolicy) ProtoMessage()
func (*WaitPolicy) ProtoReflect ¶
func (x *WaitPolicy) ProtoReflect() protoreflect.Message
func (*WaitPolicy) Reset ¶
func (x *WaitPolicy) Reset()
func (*WaitPolicy) String ¶
func (x *WaitPolicy) String() string