nexus

package
v4.12.0 Latest Latest
Warning

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

Go to latest
Published: Mar 28, 2024 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_temporal_api_nexus_v1_message_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CancelOperationRequest

type CancelOperationRequest struct {

	// Type of operation to cancel.
	Operation string `protobuf:"bytes,1,opt,name=operation,proto3" json:"operation,omitempty"`
	// Operation ID as originally generated by a Handler.
	OperationId string `protobuf:"bytes,2,opt,name=operation_id,json=operationId,proto3" json:"operation_id,omitempty"`
	// contains filtered or unexported fields
}

A request to cancel an operation.

func (*CancelOperationRequest) Descriptor deprecated

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

Deprecated: Use CancelOperationRequest.ProtoReflect.Descriptor instead.

func (*CancelOperationRequest) GetOperation

func (x *CancelOperationRequest) GetOperation() string

func (*CancelOperationRequest) GetOperationId

func (x *CancelOperationRequest) GetOperationId() string

func (*CancelOperationRequest) ProtoMessage

func (*CancelOperationRequest) ProtoMessage()

func (*CancelOperationRequest) ProtoReflect

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

func (*CancelOperationRequest) Reset

func (x *CancelOperationRequest) Reset()

func (*CancelOperationRequest) String

func (x *CancelOperationRequest) String() string

type CancelOperationResponse

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

Response variant for CancelOperationRequest.

func (*CancelOperationResponse) Descriptor deprecated

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

Deprecated: Use CancelOperationResponse.ProtoReflect.Descriptor instead.

func (*CancelOperationResponse) ProtoMessage

func (*CancelOperationResponse) ProtoMessage()

func (*CancelOperationResponse) ProtoReflect

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

func (*CancelOperationResponse) Reset

func (x *CancelOperationResponse) Reset()

func (*CancelOperationResponse) String

func (x *CancelOperationResponse) String() string

type Failure

type Failure struct {
	Message  string            `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	Details  *structpb.Value   `protobuf:"bytes,3,opt,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

A general purpose failure message. See: https://github.com/nexus-rpc/api/blob/main/SPEC.md#failure

func (*Failure) Descriptor deprecated

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

Deprecated: Use Failure.ProtoReflect.Descriptor instead.

func (*Failure) GetDetails

func (x *Failure) GetDetails() *structpb.Value

func (*Failure) GetMessage

func (x *Failure) GetMessage() string

func (*Failure) GetMetadata

func (x *Failure) GetMetadata() map[string]string

func (*Failure) ProtoMessage

func (*Failure) ProtoMessage()

func (*Failure) ProtoReflect

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

func (*Failure) Reset

func (x *Failure) Reset()

func (*Failure) String

func (x *Failure) String() string

type HandlerError

type HandlerError struct {

	// See https://github.com/nexus-rpc/api/blob/main/SPEC.md#predefined-handler-errors.
	ErrorType string   `protobuf:"bytes,1,opt,name=error_type,json=errorType,proto3" json:"error_type,omitempty"`
	Failure   *Failure `protobuf:"bytes,2,opt,name=failure,proto3" json:"failure,omitempty"`
	// contains filtered or unexported fields
}

func (*HandlerError) Descriptor deprecated

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

Deprecated: Use HandlerError.ProtoReflect.Descriptor instead.

func (*HandlerError) GetErrorType

func (x *HandlerError) GetErrorType() string

func (*HandlerError) GetFailure

func (x *HandlerError) GetFailure() *Failure

func (*HandlerError) ProtoMessage

func (*HandlerError) ProtoMessage()

func (*HandlerError) ProtoReflect

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

func (*HandlerError) Reset

func (x *HandlerError) Reset()

func (*HandlerError) String

func (x *HandlerError) String() string

type IncomingService

type IncomingService struct {

	// Data version for this service. Must match current version on update or set to 0 to create a new service.
	Version int64 `protobuf:"varint,1,opt,name=version,proto3" json:"version,omitempty"`
	// Service name, unique for this cluster.
	// The service name is used to address this service.
	// By default, when using Nexus over HTTP, the service name is matched against the base URL path.
	// E.g. the URL /my-service would match a service named "my-service".
	// The name can contain any characters and is escaped when matched against a URL.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Namespace to route requests to.
	Namespace string `protobuf:"bytes,3,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// Task queue to route requests to.
	TaskQueue string `protobuf:"bytes,4,opt,name=task_queue,json=taskQueue,proto3" json:"task_queue,omitempty"`
	// Generic service metadata that is available to the server's authorizer.
	Metadata map[string]*anypb.Any `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

A binding from a service name to namespace, task queue, and metadata for dispatching incoming Nexus requests.

func (*IncomingService) Descriptor deprecated

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

Deprecated: Use IncomingService.ProtoReflect.Descriptor instead.

func (*IncomingService) GetMetadata

func (x *IncomingService) GetMetadata() map[string]*anypb.Any

func (*IncomingService) GetName

func (x *IncomingService) GetName() string

func (*IncomingService) GetNamespace

func (x *IncomingService) GetNamespace() string

func (*IncomingService) GetTaskQueue

func (x *IncomingService) GetTaskQueue() string

func (*IncomingService) GetVersion

func (x *IncomingService) GetVersion() int64

func (*IncomingService) ProtoMessage

func (*IncomingService) ProtoMessage()

func (*IncomingService) ProtoReflect

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

func (*IncomingService) Reset

func (x *IncomingService) Reset()

func (*IncomingService) String

func (x *IncomingService) String() string

type Request

type Request struct {

	// Headers extracted from the original request in the Temporal frontend.
	// When using Nexus over HTTP, this includes the request's HTTP headers ignoring multiple values.
	Header map[string]string `` /* 153-byte string literal not displayed */
	// Types that are assignable to Variant:
	//
	//	*Request_StartOperation
	//	*Request_CancelOperation
	Variant isRequest_Variant `protobuf_oneof:"variant"`
	// contains filtered or unexported fields
}

A Nexus request.

func (*Request) Descriptor deprecated

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

Deprecated: Use Request.ProtoReflect.Descriptor instead.

func (*Request) GetCancelOperation

func (x *Request) GetCancelOperation() *CancelOperationRequest

func (*Request) GetHeader

func (x *Request) GetHeader() map[string]string

func (*Request) GetStartOperation

func (x *Request) GetStartOperation() *StartOperationRequest

func (*Request) GetVariant

func (m *Request) GetVariant() isRequest_Variant

func (*Request) ProtoMessage

func (*Request) ProtoMessage()

func (*Request) ProtoReflect

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

func (*Request) Reset

func (x *Request) Reset()

func (*Request) String

func (x *Request) String() string

type Request_CancelOperation

type Request_CancelOperation struct {
	CancelOperation *CancelOperationRequest `protobuf:"bytes,3,opt,name=cancel_operation,json=cancelOperation,proto3,oneof"`
}

type Request_StartOperation

type Request_StartOperation struct {
	StartOperation *StartOperationRequest `protobuf:"bytes,2,opt,name=start_operation,json=startOperation,proto3,oneof"`
}

type Response

type Response struct {

	// Variant must correlate to the corresponding Request's variant.
	//
	// Types that are assignable to Variant:
	//
	//	*Response_StartOperation
	//	*Response_CancelOperation
	Variant isResponse_Variant `protobuf_oneof:"variant"`
	// contains filtered or unexported fields
}

A response indicating that the handler has successfully processed a request.

func (*Response) Descriptor deprecated

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

Deprecated: Use Response.ProtoReflect.Descriptor instead.

func (*Response) GetCancelOperation

func (x *Response) GetCancelOperation() *CancelOperationResponse

func (*Response) GetStartOperation

func (x *Response) GetStartOperation() *StartOperationResponse

func (*Response) GetVariant

func (m *Response) GetVariant() isResponse_Variant

func (*Response) ProtoMessage

func (*Response) ProtoMessage()

func (*Response) ProtoReflect

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

func (*Response) Reset

func (x *Response) Reset()

func (*Response) String

func (x *Response) String() string

type Response_CancelOperation

type Response_CancelOperation struct {
	CancelOperation *CancelOperationResponse `protobuf:"bytes,2,opt,name=cancel_operation,json=cancelOperation,proto3,oneof"`
}

type Response_StartOperation

type Response_StartOperation struct {
	StartOperation *StartOperationResponse `protobuf:"bytes,1,opt,name=start_operation,json=startOperation,proto3,oneof"`
}

type StartOperationRequest

type StartOperationRequest struct {

	// Type of operation to start.
	Operation string `protobuf:"bytes,1,opt,name=operation,proto3" json:"operation,omitempty"`
	// A request ID that can be used as an idempotentency key.
	RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// Callback URL to call upon completion if the started operation is async.
	Callback string `protobuf:"bytes,3,opt,name=callback,proto3" json:"callback,omitempty"`
	// Full request body from the incoming HTTP request.
	Payload *v1.Payload `protobuf:"bytes,4,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

A request to start an operation.

func (*StartOperationRequest) Descriptor deprecated

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

Deprecated: Use StartOperationRequest.ProtoReflect.Descriptor instead.

func (*StartOperationRequest) GetCallback

func (x *StartOperationRequest) GetCallback() string

func (*StartOperationRequest) GetOperation

func (x *StartOperationRequest) GetOperation() string

func (*StartOperationRequest) GetPayload

func (x *StartOperationRequest) GetPayload() *v1.Payload

func (*StartOperationRequest) GetRequestId

func (x *StartOperationRequest) GetRequestId() string

func (*StartOperationRequest) ProtoMessage

func (*StartOperationRequest) ProtoMessage()

func (*StartOperationRequest) ProtoReflect

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

func (*StartOperationRequest) Reset

func (x *StartOperationRequest) Reset()

func (*StartOperationRequest) String

func (x *StartOperationRequest) String() string

type StartOperationResponse

type StartOperationResponse struct {

	// Types that are assignable to Variant:
	//
	//	*StartOperationResponse_SyncSuccess
	//	*StartOperationResponse_AsyncSuccess
	//	*StartOperationResponse_OperationError
	Variant isStartOperationResponse_Variant `protobuf_oneof:"variant"`
	// contains filtered or unexported fields
}

Response variant for StartOperationRequest.

func (*StartOperationResponse) Descriptor deprecated

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

Deprecated: Use StartOperationResponse.ProtoReflect.Descriptor instead.

func (*StartOperationResponse) GetAsyncSuccess

func (*StartOperationResponse) GetOperationError

func (x *StartOperationResponse) GetOperationError() *UnsuccessfulOperationError

func (*StartOperationResponse) GetSyncSuccess

func (*StartOperationResponse) GetVariant

func (m *StartOperationResponse) GetVariant() isStartOperationResponse_Variant

func (*StartOperationResponse) ProtoMessage

func (*StartOperationResponse) ProtoMessage()

func (*StartOperationResponse) ProtoReflect

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

func (*StartOperationResponse) Reset

func (x *StartOperationResponse) Reset()

func (*StartOperationResponse) String

func (x *StartOperationResponse) String() string

type StartOperationResponse_Async

type StartOperationResponse_Async struct {
	OperationId string `protobuf:"bytes,1,opt,name=operation_id,json=operationId,proto3" json:"operation_id,omitempty"`
	// contains filtered or unexported fields
}

The operation will complete asynchronously. The returned ID can be used to reference this operation.

func (*StartOperationResponse_Async) Descriptor deprecated

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

Deprecated: Use StartOperationResponse_Async.ProtoReflect.Descriptor instead.

func (*StartOperationResponse_Async) GetOperationId

func (x *StartOperationResponse_Async) GetOperationId() string

func (*StartOperationResponse_Async) ProtoMessage

func (*StartOperationResponse_Async) ProtoMessage()

func (*StartOperationResponse_Async) ProtoReflect

func (*StartOperationResponse_Async) Reset

func (x *StartOperationResponse_Async) Reset()

func (*StartOperationResponse_Async) String

type StartOperationResponse_AsyncSuccess

type StartOperationResponse_AsyncSuccess struct {
	AsyncSuccess *StartOperationResponse_Async `protobuf:"bytes,2,opt,name=async_success,json=asyncSuccess,proto3,oneof"`
}

type StartOperationResponse_OperationError

type StartOperationResponse_OperationError struct {
	// The operation completed unsuccessfully (failed or canceled).
	OperationError *UnsuccessfulOperationError `protobuf:"bytes,3,opt,name=operation_error,json=operationError,proto3,oneof"`
}

type StartOperationResponse_Sync

type StartOperationResponse_Sync struct {
	Payload *v1.Payload `protobuf:"bytes,1,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

An operation completed successfully.

func (*StartOperationResponse_Sync) Descriptor deprecated

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

Deprecated: Use StartOperationResponse_Sync.ProtoReflect.Descriptor instead.

func (*StartOperationResponse_Sync) GetPayload

func (x *StartOperationResponse_Sync) GetPayload() *v1.Payload

func (*StartOperationResponse_Sync) ProtoMessage

func (*StartOperationResponse_Sync) ProtoMessage()

func (*StartOperationResponse_Sync) ProtoReflect

func (*StartOperationResponse_Sync) Reset

func (x *StartOperationResponse_Sync) Reset()

func (*StartOperationResponse_Sync) String

func (x *StartOperationResponse_Sync) String() string

type StartOperationResponse_SyncSuccess

type StartOperationResponse_SyncSuccess struct {
	SyncSuccess *StartOperationResponse_Sync `protobuf:"bytes,1,opt,name=sync_success,json=syncSuccess,proto3,oneof"`
}

type UnsuccessfulOperationError

type UnsuccessfulOperationError struct {

	// See https://github.com/nexus-rpc/api/blob/main/SPEC.md#operationinfo.
	OperationState string   `protobuf:"bytes,1,opt,name=operation_state,json=operationState,proto3" json:"operation_state,omitempty"`
	Failure        *Failure `protobuf:"bytes,2,opt,name=failure,proto3" json:"failure,omitempty"`
	// contains filtered or unexported fields
}

func (*UnsuccessfulOperationError) Descriptor deprecated

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

Deprecated: Use UnsuccessfulOperationError.ProtoReflect.Descriptor instead.

func (*UnsuccessfulOperationError) GetFailure

func (x *UnsuccessfulOperationError) GetFailure() *Failure

func (*UnsuccessfulOperationError) GetOperationState

func (x *UnsuccessfulOperationError) GetOperationState() string

func (*UnsuccessfulOperationError) ProtoMessage

func (*UnsuccessfulOperationError) ProtoMessage()

func (*UnsuccessfulOperationError) ProtoReflect

func (*UnsuccessfulOperationError) Reset

func (x *UnsuccessfulOperationError) Reset()

func (*UnsuccessfulOperationError) String

func (x *UnsuccessfulOperationError) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL