sdk

package
v1.34.0 Latest Latest
Warning

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

 Go to latest Published: May 22, 2024 License: MIT Imports: 6 Imported by: 7

Documentation

Overview

Code generated by protoc-gen-go-helpers. DO NOT EDIT.

Code generated by protoc-gen-go-helpers. DO NOT EDIT.

Code generated by protoc-gen-go-helpers. DO NOT EDIT.

Index

Constants

This section is empty.

Variables

View Source 
var File_temporal_api_sdk_v1_task_complete_metadata_proto protoreflect.FileDescriptor
View Source 
var File_temporal_api_sdk_v1_user_metadata_proto protoreflect.FileDescriptor
View Source 
var File_temporal_api_sdk_v1_workflow_metadata_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type UserMetadata added in v1.34.0 

type UserMetadata struct {

	// Short-form text that provides a summary. This payload should be a "json/plain"-encoded payload
	// that is a single JSON string for use in user interfaces. User interface formatting may not
	// apply to this text when used in "title" situations. The payload data section is limited to 400
	// bytes by default.
	Summary *v1.Payload `protobuf:"bytes,1,opt,name=summary,proto3" json:"summary,omitempty"`
	// Long-form text that provides details. This payload should be a "json/plain"-encoded payload
	// that is a single JSON string for use in user interfaces. User interface formatting may apply to
	// this text in common use. The payload data section is limited to 20000 bytes by default.
	Details *v1.Payload `protobuf:"bytes,2,opt,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

Information a user can set, often for use by user interfaces.

func (*UserMetadata) Descriptor deprecated added in v1.34.0 

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

Deprecated: Use UserMetadata.ProtoReflect.Descriptor instead.

func (*UserMetadata) Equal added in v1.34.0 

func (this *UserMetadata) Equal(that interface{}) bool

Equal returns whether two UserMetadata 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 (*UserMetadata) GetDetails added in v1.34.0 

func (x *UserMetadata) GetDetails() *v1.Payload

func (*UserMetadata) GetSummary added in v1.34.0 

func (x *UserMetadata) GetSummary() *v1.Payload

func (*UserMetadata) Marshal added in v1.34.0 

func (val *UserMetadata) Marshal() ([]byte, error)

Marshal an object of type UserMetadata to the protobuf v3 wire format

func (*UserMetadata) ProtoMessage added in v1.34.0 

func (*UserMetadata) ProtoMessage()

func (*UserMetadata) ProtoReflect added in v1.34.0 

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

func (*UserMetadata) Reset added in v1.34.0 

func (x *UserMetadata) Reset()

func (*UserMetadata) Size added in v1.34.0 

func (val *UserMetadata) Size() int

Size returns the size of the object, in bytes, once serialized

func (*UserMetadata) String added in v1.34.0 

func (x *UserMetadata) String() string

func (*UserMetadata) Unmarshal added in v1.34.0 

func (val *UserMetadata) Unmarshal(buf []byte) error

Unmarshal an object of type UserMetadata from the protobuf v3 wire format

type WorkflowDefinition added in v1.27.0 

type WorkflowDefinition struct {

	// A name scoped by the task queue that maps to this workflow definition.
	// If missing, this workflow is a dynamic workflow.
	Type              string                           `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	QueryDefinitions  []*WorkflowInteractionDefinition `protobuf:"bytes,2,rep,name=query_definitions,json=queryDefinitions,proto3" json:"query_definitions,omitempty"`
	SignalDefinitions []*WorkflowInteractionDefinition `protobuf:"bytes,3,rep,name=signal_definitions,json=signalDefinitions,proto3" json:"signal_definitions,omitempty"`
	UpdateDefinitions []*WorkflowInteractionDefinition `protobuf:"bytes,4,rep,name=update_definitions,json=updateDefinitions,proto3" json:"update_definitions,omitempty"`
	// contains filtered or unexported fields
}

(-- api-linter: core::0203::optional=disabled --)

func (*WorkflowDefinition) Descriptor deprecated added in v1.27.0 

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

Deprecated: Use WorkflowDefinition.ProtoReflect.Descriptor instead.

func (*WorkflowDefinition) Equal added in v1.27.0 

func (this *WorkflowDefinition) Equal(that interface{}) bool

Equal returns whether two WorkflowDefinition 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 (*WorkflowDefinition) GetQueryDefinitions added in v1.27.0 

func (x *WorkflowDefinition) GetQueryDefinitions() []*WorkflowInteractionDefinition

func (*WorkflowDefinition) GetSignalDefinitions added in v1.27.0 

func (x *WorkflowDefinition) GetSignalDefinitions() []*WorkflowInteractionDefinition

func (*WorkflowDefinition) GetType added in v1.27.0 

func (x *WorkflowDefinition) GetType() string

func (*WorkflowDefinition) GetUpdateDefinitions added in v1.27.0 

func (x *WorkflowDefinition) GetUpdateDefinitions() []*WorkflowInteractionDefinition

func (*WorkflowDefinition) Marshal added in v1.27.0 

func (val *WorkflowDefinition) Marshal() ([]byte, error)

Marshal an object of type WorkflowDefinition to the protobuf v3 wire format

func (*WorkflowDefinition) ProtoMessage added in v1.27.0 

func (*WorkflowDefinition) ProtoMessage()

func (*WorkflowDefinition) ProtoReflect added in v1.27.0 

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

func (*WorkflowDefinition) Reset added in v1.27.0 

func (x *WorkflowDefinition) Reset()

func (*WorkflowDefinition) Size added in v1.27.0 

func (val *WorkflowDefinition) Size() int

Size returns the size of the object, in bytes, once serialized

func (*WorkflowDefinition) String added in v1.27.0 

func (x *WorkflowDefinition) String() string

func (*WorkflowDefinition) Unmarshal added in v1.27.0 

func (val *WorkflowDefinition) Unmarshal(buf []byte) error

Unmarshal an object of type WorkflowDefinition from the protobuf v3 wire format

type WorkflowInteractionDefinition added in v1.27.0 

type WorkflowInteractionDefinition struct {

	// An optional name for the handler. If missing, it represents
	// a dynamic handler that processes any interactions not handled by others.
	// There is at most one dynamic handler per workflow and interaction kind.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// An optional interaction description provided by the application.
	// By convention, external tools may interpret its first part,
	// i.e., ending with a line break, as a summary of the description.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

(-- api-linter: core::0123::resource-annotation=disabled 

aip.dev/not-precedent: The `name` field is optional. --)

(-- api-linter: core::0203::optional=disabled --)

func (*WorkflowInteractionDefinition) Descriptor deprecated added in v1.27.0 

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

Deprecated: Use WorkflowInteractionDefinition.ProtoReflect.Descriptor instead.

func (*WorkflowInteractionDefinition) Equal added in v1.27.0 

func (this *WorkflowInteractionDefinition) Equal(that interface{}) bool

Equal returns whether two WorkflowInteractionDefinition 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 (*WorkflowInteractionDefinition) GetDescription added in v1.27.0 

func (x *WorkflowInteractionDefinition) GetDescription() string

func (*WorkflowInteractionDefinition) GetName added in v1.27.0 

func (x *WorkflowInteractionDefinition) GetName() string

func (*WorkflowInteractionDefinition) Marshal added in v1.27.0 

func (val *WorkflowInteractionDefinition) Marshal() ([]byte, error)

Marshal an object of type WorkflowInteractionDefinition to the protobuf v3 wire format

func (*WorkflowInteractionDefinition) ProtoMessage added in v1.27.0 

func (*WorkflowInteractionDefinition) ProtoMessage()

func (*WorkflowInteractionDefinition) ProtoReflect added in v1.27.0 

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

func (*WorkflowInteractionDefinition) Reset added in v1.27.0 

func (x *WorkflowInteractionDefinition) Reset()

func (*WorkflowInteractionDefinition) Size added in v1.27.0 

func (val *WorkflowInteractionDefinition) Size() int

Size returns the size of the object, in bytes, once serialized

func (*WorkflowInteractionDefinition) String added in v1.27.0 

func (x *WorkflowInteractionDefinition) String() string

func (*WorkflowInteractionDefinition) Unmarshal added in v1.27.0 

func (val *WorkflowInteractionDefinition) Unmarshal(buf []byte) error

Unmarshal an object of type WorkflowInteractionDefinition from the protobuf v3 wire format

type WorkflowMetadata added in v1.27.0 

type WorkflowMetadata struct {

	// Metadata provided at declaration or creation time.
	Definition *WorkflowDefinition `protobuf:"bytes,1,opt,name=definition,proto3" json:"definition,omitempty"`
	// Current long-form details of the workflow's state. This is used by user interfaces to show
	// long-form text. This text may be formatted by the user interface.
	CurrentDetails string `protobuf:"bytes,2,opt,name=current_details,json=currentDetails,proto3" json:"current_details,omitempty"`
	// contains filtered or unexported fields
}

The name of the query to retrieve this information is `__temporal_workflow_metadata`.

func (*WorkflowMetadata) Descriptor deprecated added in v1.27.0 

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

Deprecated: Use WorkflowMetadata.ProtoReflect.Descriptor instead.

func (*WorkflowMetadata) Equal added in v1.27.0 

func (this *WorkflowMetadata) Equal(that interface{}) bool

Equal returns whether two WorkflowMetadata 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 (*WorkflowMetadata) GetCurrentDetails added in v1.34.0 

func (x *WorkflowMetadata) GetCurrentDetails() string

func (*WorkflowMetadata) GetDefinition added in v1.27.0 

func (x *WorkflowMetadata) GetDefinition() *WorkflowDefinition

func (*WorkflowMetadata) Marshal added in v1.27.0 

func (val *WorkflowMetadata) Marshal() ([]byte, error)

Marshal an object of type WorkflowMetadata to the protobuf v3 wire format

func (*WorkflowMetadata) ProtoMessage added in v1.27.0 

func (*WorkflowMetadata) ProtoMessage()

func (*WorkflowMetadata) ProtoReflect added in v1.27.0 

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

func (*WorkflowMetadata) Reset added in v1.27.0 

func (x *WorkflowMetadata) Reset()

func (*WorkflowMetadata) Size added in v1.27.0 

func (val *WorkflowMetadata) Size() int

Size returns the size of the object, in bytes, once serialized

func (*WorkflowMetadata) String added in v1.27.0 

func (x *WorkflowMetadata) String() string

func (*WorkflowMetadata) Unmarshal added in v1.27.0 

func (val *WorkflowMetadata) Unmarshal(buf []byte) error

Unmarshal an object of type WorkflowMetadata from the protobuf v3 wire format

type WorkflowTaskCompletedMetadata 

type WorkflowTaskCompletedMetadata struct {

	// Internal flags used by the core SDK. SDKs using flags must comply with the following behavior:
	//
	// During replay:
	//   - If a flag is not recognized (value is too high or not defined), it must fail the workflow
	//     task.
	//   - If a flag is recognized, it is stored in a set of used flags for the run. Code checks for
	//     that flag during and after this WFT are allowed to assume that the flag is present.
	//   - If a code check for a flag does not find the flag in the set of used flags, it must take
	//     the branch corresponding to the absence of that flag.
	//
	// During non-replay execution of new WFTs:
	//   - The SDK is free to use all flags it knows about. It must record any newly-used (IE: not
	//     previously recorded) flags when completing the WFT.
	//
	// SDKs which are too old to even know about this field at all are considered to produce
	// undefined behavior if they replay workflows which used this mechanism.
	//
	// (-- api-linter: core::0141::forbidden-types=disabled
	//
	//	aip.dev/not-precedent: These really shouldn't have negative values. --)
	CoreUsedFlags []uint32 `protobuf:"varint,1,rep,packed,name=core_used_flags,json=coreUsedFlags,proto3" json:"core_used_flags,omitempty"`
	// Flags used by the SDK lang. No attempt is made to distinguish between different SDK languages
	// here as processing a workflow with a different language than the one which authored it is
	// already undefined behavior. See `core_used_patches` for more.
	//
	// (-- api-linter: core::0141::forbidden-types=disabled
	//
	//	aip.dev/not-precedent: These really shouldn't have negative values. --)
	LangUsedFlags []uint32 `protobuf:"varint,2,rep,packed,name=lang_used_flags,json=langUsedFlags,proto3" json:"lang_used_flags,omitempty"`
	// Name of the SDK that processed the task. This is usually something like "temporal-go" and is
	// usually the same as client-name gRPC header. This should only be set if its value changed
	// since the last time recorded on the workflow (or be set on the first task).
	//
	// (-- api-linter: core::0122::name-suffix=disabled
	//
	//	aip.dev/not-precedent: We're ok with a name suffix here. --)
	SdkName string `protobuf:"bytes,3,opt,name=sdk_name,json=sdkName,proto3" json:"sdk_name,omitempty"`
	// Version of the SDK that processed the task. This is usually something like "1.20.0" and is
	// usually the same as client-version gRPC header. This should only be set if its value changed
	// since the last time recorded on the workflow (or be set on the first task).
	SdkVersion string `protobuf:"bytes,4,opt,name=sdk_version,json=sdkVersion,proto3" json:"sdk_version,omitempty"`
	// contains filtered or unexported fields
}

func (*WorkflowTaskCompletedMetadata) Descriptor deprecated 

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

Deprecated: Use WorkflowTaskCompletedMetadata.ProtoReflect.Descriptor instead.

func (*WorkflowTaskCompletedMetadata) Equal 

func (this *WorkflowTaskCompletedMetadata) Equal(that interface{}) bool

Equal returns whether two WorkflowTaskCompletedMetadata 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 (*WorkflowTaskCompletedMetadata) GetCoreUsedFlags 

func (x *WorkflowTaskCompletedMetadata) GetCoreUsedFlags() []uint32

func (*WorkflowTaskCompletedMetadata) GetLangUsedFlags 

func (x *WorkflowTaskCompletedMetadata) GetLangUsedFlags() []uint32

func (*WorkflowTaskCompletedMetadata) GetSdkName added in v1.24.0 

func (x *WorkflowTaskCompletedMetadata) GetSdkName() string

func (*WorkflowTaskCompletedMetadata) GetSdkVersion added in v1.24.0 

func (x *WorkflowTaskCompletedMetadata) GetSdkVersion() string

func (*WorkflowTaskCompletedMetadata) Marshal 

func (val *WorkflowTaskCompletedMetadata) Marshal() ([]byte, error)

Marshal an object of type WorkflowTaskCompletedMetadata to the protobuf v3 wire format

func (*WorkflowTaskCompletedMetadata) ProtoMessage 

func (*WorkflowTaskCompletedMetadata) ProtoMessage()

func (*WorkflowTaskCompletedMetadata) ProtoReflect added in v1.26.1 

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

func (*WorkflowTaskCompletedMetadata) Reset 

func (x *WorkflowTaskCompletedMetadata) Reset()

func (*WorkflowTaskCompletedMetadata) Size 

func (val *WorkflowTaskCompletedMetadata) Size() int

Size returns the size of the object, in bytes, once serialized

func (*WorkflowTaskCompletedMetadata) String 

func (x *WorkflowTaskCompletedMetadata) String() string

func (*WorkflowTaskCompletedMetadata) Unmarshal 

func (val *WorkflowTaskCompletedMetadata) Unmarshal(buf []byte) error

Unmarshal an object of type WorkflowTaskCompletedMetadata from the protobuf v3 wire format

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.