Documentation ¶
Overview ¶
Code generated by protoc-gen-go-helpers. DO NOT EDIT.
Index ¶
- Variables
- type Acceptance
- func (*Acceptance) Descriptor() ([]byte, []int)deprecated
- func (this *Acceptance) Equal(that interface{}) bool
- func (x *Acceptance) GetAcceptedRequest() *Request
- func (x *Acceptance) GetAcceptedRequestMessageId() string
- func (x *Acceptance) GetAcceptedRequestSequencingEventId() int64
- func (val *Acceptance) Marshal() ([]byte, error)
- func (*Acceptance) ProtoMessage()
- func (x *Acceptance) ProtoReflect() protoreflect.Message
- func (x *Acceptance) Reset()
- func (val *Acceptance) Size() int
- func (x *Acceptance) String() string
- func (val *Acceptance) Unmarshal(buf []byte) error
- type Input
- func (*Input) Descriptor() ([]byte, []int)deprecated
- func (this *Input) Equal(that interface{}) bool
- func (x *Input) GetArgs() *v11.Payloads
- func (x *Input) GetHeader() *v11.Header
- func (x *Input) GetName() string
- func (val *Input) Marshal() ([]byte, error)
- func (*Input) ProtoMessage()
- func (x *Input) ProtoReflect() protoreflect.Message
- func (x *Input) Reset()
- func (val *Input) Size() int
- func (x *Input) String() string
- func (val *Input) Unmarshal(buf []byte) error
- type Meta
- func (*Meta) Descriptor() ([]byte, []int)deprecated
- func (this *Meta) Equal(that interface{}) bool
- func (x *Meta) GetIdentity() string
- func (x *Meta) GetUpdateId() string
- func (val *Meta) Marshal() ([]byte, error)
- func (*Meta) ProtoMessage()
- func (x *Meta) ProtoReflect() protoreflect.Message
- func (x *Meta) Reset()
- func (val *Meta) Size() int
- func (x *Meta) String() string
- func (val *Meta) Unmarshal(buf []byte) error
- type Outcome
- func (*Outcome) Descriptor() ([]byte, []int)deprecated
- func (this *Outcome) Equal(that interface{}) bool
- func (x *Outcome) GetFailure() *v12.Failure
- func (x *Outcome) GetSuccess() *v11.Payloads
- func (m *Outcome) GetValue() isOutcome_Value
- func (val *Outcome) Marshal() ([]byte, error)
- func (*Outcome) ProtoMessage()
- func (x *Outcome) ProtoReflect() protoreflect.Message
- func (x *Outcome) Reset()
- func (val *Outcome) Size() int
- func (x *Outcome) String() string
- func (val *Outcome) Unmarshal(buf []byte) error
- type Outcome_Failure
- type Outcome_Success
- type Rejection
- func (*Rejection) Descriptor() ([]byte, []int)deprecated
- func (this *Rejection) Equal(that interface{}) bool
- func (x *Rejection) GetFailure() *v12.Failure
- func (x *Rejection) GetRejectedRequest() *Request
- func (x *Rejection) GetRejectedRequestMessageId() string
- func (x *Rejection) GetRejectedRequestSequencingEventId() int64
- func (val *Rejection) Marshal() ([]byte, error)
- func (*Rejection) ProtoMessage()
- func (x *Rejection) ProtoReflect() protoreflect.Message
- func (x *Rejection) Reset()
- func (val *Rejection) Size() int
- func (x *Rejection) String() string
- func (val *Rejection) Unmarshal(buf []byte) error
- type Request
- func (*Request) Descriptor() ([]byte, []int)deprecated
- func (this *Request) Equal(that interface{}) bool
- func (x *Request) GetInput() *Input
- func (x *Request) GetMeta() *Meta
- func (val *Request) Marshal() ([]byte, error)
- func (*Request) ProtoMessage()
- func (x *Request) ProtoReflect() protoreflect.Message
- func (x *Request) Reset()
- func (val *Request) Size() int
- func (x *Request) String() string
- func (val *Request) Unmarshal(buf []byte) error
- type Response
- func (*Response) Descriptor() ([]byte, []int)deprecated
- func (this *Response) Equal(that interface{}) bool
- func (x *Response) GetMeta() *Meta
- func (x *Response) GetOutcome() *Outcome
- func (val *Response) Marshal() ([]byte, error)
- func (*Response) ProtoMessage()
- func (x *Response) ProtoReflect() protoreflect.Message
- func (x *Response) Reset()
- func (val *Response) Size() int
- func (x *Response) String() string
- func (val *Response) Unmarshal(buf []byte) error
- type UpdateRef
- func (*UpdateRef) Descriptor() ([]byte, []int)deprecated
- func (this *UpdateRef) Equal(that interface{}) bool
- func (x *UpdateRef) GetUpdateId() string
- func (x *UpdateRef) GetWorkflowExecution() *v11.WorkflowExecution
- func (val *UpdateRef) Marshal() ([]byte, error)
- func (*UpdateRef) ProtoMessage()
- func (x *UpdateRef) ProtoReflect() protoreflect.Message
- func (x *UpdateRef) Reset()
- func (val *UpdateRef) Size() int
- func (x *UpdateRef) String() string
- func (val *UpdateRef) Unmarshal(buf []byte) error
- type WaitPolicy
- func (*WaitPolicy) Descriptor() ([]byte, []int)deprecated
- func (this *WaitPolicy) Equal(that interface{}) bool
- func (x *WaitPolicy) GetLifecycleStage() v1.UpdateWorkflowExecutionLifecycleStage
- func (val *WaitPolicy) Marshal() ([]byte, error)
- func (*WaitPolicy) ProtoMessage()
- func (x *WaitPolicy) ProtoReflect() protoreflect.Message
- func (x *WaitPolicy) Reset()
- func (val *WaitPolicy) Size() int
- func (x *WaitPolicy) String() string
- func (val *WaitPolicy) Unmarshal(buf []byte) error
Constants ¶
This section is empty.
Variables ¶
var File_temporal_api_update_v1_message_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Acceptance ¶ added in v1.16.0
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 Update has been accepted (i.e. passed the worker-side validation phase).
func (*Acceptance) Descriptor
deprecated
added in
v1.16.0
func (*Acceptance) Descriptor() ([]byte, []int)
Deprecated: Use Acceptance.ProtoReflect.Descriptor instead.
func (*Acceptance) Equal ¶ added in v1.16.0
func (this *Acceptance) Equal(that interface{}) bool
Equal returns whether two Acceptance values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal
func (*Acceptance) GetAcceptedRequest ¶ added in v1.16.0
func (x *Acceptance) GetAcceptedRequest() *Request
func (*Acceptance) GetAcceptedRequestMessageId ¶ added in v1.16.0
func (x *Acceptance) GetAcceptedRequestMessageId() string
func (*Acceptance) GetAcceptedRequestSequencingEventId ¶ added in v1.16.0
func (x *Acceptance) GetAcceptedRequestSequencingEventId() int64
func (*Acceptance) Marshal ¶ added in v1.16.0
func (val *Acceptance) Marshal() ([]byte, error)
Marshal an object of type Acceptance to the protobuf v3 wire format
func (*Acceptance) ProtoMessage ¶ added in v1.16.0
func (*Acceptance) ProtoMessage()
func (*Acceptance) ProtoReflect ¶ added in v1.26.1
func (x *Acceptance) ProtoReflect() protoreflect.Message
func (*Acceptance) Reset ¶ added in v1.16.0
func (x *Acceptance) Reset()
func (*Acceptance) Size ¶ added in v1.16.0
func (val *Acceptance) Size() int
Size returns the size of the object, in bytes, once serialized
func (*Acceptance) String ¶ added in v1.16.0
func (x *Acceptance) String() string
func (*Acceptance) Unmarshal ¶ added in v1.16.0
func (val *Acceptance) Unmarshal(buf []byte) error
Unmarshal an object of type Acceptance from the protobuf v3 wire format
type Input ¶ added in v1.16.0
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 Update 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 Update handler. Args *v11.Payloads `protobuf:"bytes,3,opt,name=args,proto3" json:"args,omitempty"` // contains filtered or unexported fields }
func (*Input) Descriptor
deprecated
added in
v1.16.0
func (*Input) Equal ¶ added in v1.16.0
Equal returns whether two Input values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal
func (*Input) Marshal ¶ added in v1.16.0
Marshal an object of type Input to the protobuf v3 wire format
func (*Input) ProtoMessage ¶ added in v1.16.0
func (*Input) ProtoMessage()
func (*Input) ProtoReflect ¶ added in v1.26.1
func (x *Input) ProtoReflect() protoreflect.Message
type Meta ¶ added in v1.16.0
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 Update.
func (*Meta) Descriptor
deprecated
added in
v1.16.0
func (*Meta) Equal ¶ added in v1.16.0
Equal returns whether two Meta values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal
func (*Meta) GetIdentity ¶ added in v1.16.0
func (*Meta) GetUpdateId ¶ added in v1.16.0
func (*Meta) Marshal ¶ added in v1.16.0
Marshal an object of type Meta to the protobuf v3 wire format
func (*Meta) ProtoMessage ¶ added in v1.16.0
func (*Meta) ProtoMessage()
func (*Meta) ProtoReflect ¶ added in v1.26.1
func (x *Meta) ProtoReflect() protoreflect.Message
type Outcome ¶ added in v1.16.0
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
added in
v1.16.0
func (*Outcome) Equal ¶ added in v1.16.0
Equal returns whether two Outcome values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal
func (*Outcome) GetFailure ¶ added in v1.16.0
func (*Outcome) GetSuccess ¶ added in v1.16.0
func (*Outcome) Marshal ¶ added in v1.16.0
Marshal an object of type Outcome to the protobuf v3 wire format
func (*Outcome) ProtoMessage ¶ added in v1.16.0
func (*Outcome) ProtoMessage()
func (*Outcome) ProtoReflect ¶ added in v1.26.1
func (x *Outcome) ProtoReflect() protoreflect.Message
type Outcome_Failure ¶ added in v1.16.0
type Outcome_Success ¶ added in v1.16.0
type Rejection ¶ added in v1.16.0
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 Update has been rejected.
func (*Rejection) Descriptor
deprecated
added in
v1.16.0
func (*Rejection) Equal ¶ added in v1.16.0
Equal returns whether two Rejection values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal
func (*Rejection) GetFailure ¶ added in v1.16.0
func (*Rejection) GetRejectedRequest ¶ added in v1.16.0
func (*Rejection) GetRejectedRequestMessageId ¶ added in v1.16.0
func (*Rejection) GetRejectedRequestSequencingEventId ¶ added in v1.16.0
func (*Rejection) Marshal ¶ added in v1.16.0
Marshal an object of type Rejection to the protobuf v3 wire format
func (*Rejection) ProtoMessage ¶ added in v1.16.0
func (*Rejection) ProtoMessage()
func (*Rejection) ProtoReflect ¶ added in v1.26.1
func (x *Rejection) ProtoReflect() protoreflect.Message
type Request ¶ added in v1.16.0
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 Update.
func (*Request) Descriptor
deprecated
added in
v1.16.0
func (*Request) Equal ¶ added in v1.16.0
Equal returns whether two Request values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal
func (*Request) Marshal ¶ added in v1.16.0
Marshal an object of type Request to the protobuf v3 wire format
func (*Request) ProtoMessage ¶ added in v1.16.0
func (*Request) ProtoMessage()
func (*Request) ProtoReflect ¶ added in v1.26.1
func (x *Request) ProtoReflect() protoreflect.Message
type Response ¶ added in v1.16.0
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 Update has completed with the contained outcome.
func (*Response) Descriptor
deprecated
added in
v1.16.0
func (*Response) Equal ¶ added in v1.16.0
Equal returns whether two Response values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal
func (*Response) GetOutcome ¶ added in v1.16.0
func (*Response) Marshal ¶ added in v1.16.0
Marshal an object of type Response to the protobuf v3 wire format
func (*Response) ProtoMessage ¶ added in v1.16.0
func (*Response) ProtoMessage()
func (*Response) ProtoReflect ¶ added in v1.26.1
func (x *Response) ProtoReflect() protoreflect.Message
type UpdateRef ¶ added in v1.16.0
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 a previously invoked Workflow Update.
func (*UpdateRef) Descriptor
deprecated
added in
v1.16.0
func (*UpdateRef) Equal ¶ added in v1.16.0
Equal returns whether two UpdateRef values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal
func (*UpdateRef) GetUpdateId ¶ added in v1.16.0
func (*UpdateRef) GetWorkflowExecution ¶ added in v1.16.0
func (x *UpdateRef) GetWorkflowExecution() *v11.WorkflowExecution
func (*UpdateRef) Marshal ¶ added in v1.16.0
Marshal an object of type UpdateRef to the protobuf v3 wire format
func (*UpdateRef) ProtoMessage ¶ added in v1.16.0
func (*UpdateRef) ProtoMessage()
func (*UpdateRef) ProtoReflect ¶ added in v1.26.1
func (x *UpdateRef) ProtoReflect() protoreflect.Message
type WaitPolicy ¶ added in v1.16.0
type WaitPolicy struct { // Indicates the Update lifecycle stage that the Update must reach before // API call is returned. // NOTE: This field works together with API call timeout which is limited by // server timeout (maximum wait time). If server timeout is expired before // user specified timeout, API call returns even if specified stage is not reached. LifecycleStage v1.UpdateWorkflowExecutionLifecycleStage `` /* 169-byte string literal not displayed */ // contains filtered or unexported fields }
Specifies client's intent to wait for Update results.
func (*WaitPolicy) Descriptor
deprecated
added in
v1.16.0
func (*WaitPolicy) Descriptor() ([]byte, []int)
Deprecated: Use WaitPolicy.ProtoReflect.Descriptor instead.
func (*WaitPolicy) Equal ¶ added in v1.16.0
func (this *WaitPolicy) Equal(that interface{}) bool
Equal returns whether two WaitPolicy values are equivalent by recursively comparing the message's fields. For more information see the documentation for https://pkg.go.dev/google.golang.org/protobuf/proto#Equal
func (*WaitPolicy) GetLifecycleStage ¶ added in v1.16.0
func (x *WaitPolicy) GetLifecycleStage() v1.UpdateWorkflowExecutionLifecycleStage
func (*WaitPolicy) Marshal ¶ added in v1.16.0
func (val *WaitPolicy) Marshal() ([]byte, error)
Marshal an object of type WaitPolicy to the protobuf v3 wire format
func (*WaitPolicy) ProtoMessage ¶ added in v1.16.0
func (*WaitPolicy) ProtoMessage()
func (*WaitPolicy) ProtoReflect ¶ added in v1.26.1
func (x *WaitPolicy) ProtoReflect() protoreflect.Message
func (*WaitPolicy) Reset ¶ added in v1.16.0
func (x *WaitPolicy) Reset()
func (*WaitPolicy) Size ¶ added in v1.16.0
func (val *WaitPolicy) Size() int
Size returns the size of the object, in bytes, once serialized
func (*WaitPolicy) String ¶ added in v1.16.0
func (x *WaitPolicy) String() string
func (*WaitPolicy) Unmarshal ¶ added in v1.16.0
func (val *WaitPolicy) Unmarshal(buf []byte) error
Unmarshal an object of type WaitPolicy from the protobuf v3 wire format