operation

Documentation

Index

• Variables
• type AsyncOperation
  • func (*AsyncOperation) Descriptor() ([]byte, []int)
  • func (x *AsyncOperation) GetCheckDuration() *durationpb.Duration
  • func (x *AsyncOperation) GetFailureReason() string
  • func (x *AsyncOperation) GetFinishedTime() *timestamppb.Timestamp
  • func (x *AsyncOperation) GetId() string
  • func (x *AsyncOperation) GetOperationInput() *anypb.Any
  • func (x *AsyncOperation) GetOperationType() string
  • func (x *AsyncOperation) GetStartedTime() *timestamppb.Timestamp
  • func (x *AsyncOperation) GetState() AsyncOperation_State
  • func (x *AsyncOperation) GetStateDeprecated() string
  • func (*AsyncOperation) ProtoMessage()
  • func (x *AsyncOperation) ProtoReflect() protoreflect.Message
  • func (x *AsyncOperation) Reset()
  • func (x *AsyncOperation) String() string
• type AsyncOperation_State
  • func (AsyncOperation_State) Descriptor() protoreflect.EnumDescriptor
  • func (x AsyncOperation_State) Enum() *AsyncOperation_State
  • func (AsyncOperation_State) EnumDescriptor() ([]byte, []int)
  • func (x AsyncOperation_State) Number() protoreflect.EnumNumber
  • func (x AsyncOperation_State) String() string
  • func (AsyncOperation_State) Type() protoreflect.EnumType

Variables

var (
	AsyncOperation_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "STATE_PENDING",
		2: "STATE_IN_PROGRESS",
		3: "STATE_FAILED",
		4: "STATE_CANCELLED",
		5: "STATE_FULFILLED",
	}
	AsyncOperation_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"STATE_PENDING":     1,
		"STATE_IN_PROGRESS": 2,
		"STATE_FAILED":      3,
		"STATE_CANCELLED":   4,
		"STATE_FULFILLED":   5,
	}
)

Enum value maps for AsyncOperation_State.

var File_temporal_api_cloud_operation_v1_message_proto protoreflect.FileDescriptor

Types

type AsyncOperation

type AsyncOperation struct {

	// The operation id.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The current state of this operation.
	// Possible values are: pending, in_progress, failed, cancelled, fulfilled.
	// Deprecated: Not supported after v0.3.0 api version. Use state instead.
	// temporal:versioning:max_version=v0.3.0
	//
	// Deprecated: Marked as deprecated in temporal/api/cloud/operation/v1/message.proto.
	StateDeprecated string `protobuf:"bytes,2,opt,name=state_deprecated,json=stateDeprecated,proto3" json:"state_deprecated,omitempty"`
	// The current state of this operation.
	// temporal:versioning:min_version=v0.3.0
	// temporal:enums:replaces=state_deprecated
	State AsyncOperation_State `protobuf:"varint,9,opt,name=state,proto3,enum=temporal.api.cloud.operation.v1.AsyncOperation_State" json:"state,omitempty"`
	// The recommended duration to check back for an update in the operation's state.
	CheckDuration *durationpb.Duration `protobuf:"bytes,3,opt,name=check_duration,json=checkDuration,proto3" json:"check_duration,omitempty"`
	// The type of operation being performed.
	OperationType string `protobuf:"bytes,4,opt,name=operation_type,json=operationType,proto3" json:"operation_type,omitempty"`
	// The input to the operation being performed.
	//
	// (-- api-linter: core::0146::any=disabled --)
	OperationInput *anypb.Any `protobuf:"bytes,5,opt,name=operation_input,json=operationInput,proto3" json:"operation_input,omitempty"`
	// If the operation failed, the reason for the failure.
	FailureReason string `protobuf:"bytes,6,opt,name=failure_reason,json=failureReason,proto3" json:"failure_reason,omitempty"`
	// The date and time when the operation initiated.
	StartedTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=started_time,json=startedTime,proto3" json:"started_time,omitempty"`
	// The date and time when the operation completed.
	FinishedTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=finished_time,json=finishedTime,proto3" json:"finished_time,omitempty"`
	// contains filtered or unexported fields
}

func (*AsyncOperation) Descriptor

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

Deprecated: Use AsyncOperation.ProtoReflect.Descriptor instead.

func (*AsyncOperation) GetCheckDuration

func (x *AsyncOperation) GetCheckDuration() *durationpb.Duration

func (*AsyncOperation) GetFailureReason

func (x *AsyncOperation) GetFailureReason() string

func (*AsyncOperation) GetFinishedTime

func (x *AsyncOperation) GetFinishedTime() *timestamppb.Timestamp

func (*AsyncOperation) GetId

func (x *AsyncOperation) GetId() string

func (*AsyncOperation) GetOperationInput

func (x *AsyncOperation) GetOperationInput() *anypb.Any

func (*AsyncOperation) GetOperationType

func (x *AsyncOperation) GetOperationType() string

func (*AsyncOperation) GetStartedTime

func (x *AsyncOperation) GetStartedTime() *timestamppb.Timestamp

func (*AsyncOperation) GetState

func (x *AsyncOperation) GetState() AsyncOperation_State

func (*AsyncOperation) GetStateDeprecated

func (x *AsyncOperation) GetStateDeprecated() string

Deprecated: Marked as deprecated in temporal/api/cloud/operation/v1/message.proto.

func (*AsyncOperation) ProtoMessage

func (*AsyncOperation) ProtoMessage()

func (*AsyncOperation) ProtoReflect

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

func (*AsyncOperation) Reset

func (x *AsyncOperation) Reset()

func (*AsyncOperation) String

func (x *AsyncOperation) String() string

type AsyncOperation_State

type AsyncOperation_State int32

const (
	AsyncOperation_STATE_UNSPECIFIED AsyncOperation_State = 0
	AsyncOperation_STATE_PENDING     AsyncOperation_State = 1 // The operation is pending.
	AsyncOperation_STATE_IN_PROGRESS AsyncOperation_State = 2 // The operation is in progress.
	AsyncOperation_STATE_FAILED      AsyncOperation_State = 3 // The operation failed, check failure_reason for more details.
	AsyncOperation_STATE_CANCELLED   AsyncOperation_State = 4 // The operation was cancelled.
	AsyncOperation_STATE_FULFILLED   AsyncOperation_State = 5 // The operation was fulfilled.
)

func (AsyncOperation_State) Descriptor

func (AsyncOperation_State) Descriptor() protoreflect.EnumDescriptor

func (AsyncOperation_State) Enum

func (x AsyncOperation_State) Enum() *AsyncOperation_State

func (AsyncOperation_State) EnumDescriptor

func (AsyncOperation_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use AsyncOperation_State.Descriptor instead.

func (AsyncOperation_State) Number

func (x AsyncOperation_State) Number() protoreflect.EnumNumber

func (AsyncOperation_State) String

func (x AsyncOperation_State) String() string

func (AsyncOperation_State) Type

func (AsyncOperation_State) Type() protoreflect.EnumType