Documentation ¶
Index ¶
- Variables
- type CancelOperationRequest
- func (*CancelOperationRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CancelOperationRequest) GetOperation() string
- func (x *CancelOperationRequest) GetOperationId() string
- func (x *CancelOperationRequest) GetService() string
- func (*CancelOperationRequest) ProtoMessage()
- func (x *CancelOperationRequest) ProtoReflect() protoreflect.Message
- func (x *CancelOperationRequest) Reset()
- func (x *CancelOperationRequest) String() string
- type CancelOperationResponse
- type Endpoint
- func (*Endpoint) Descriptor() ([]byte, []int)deprecated
- func (x *Endpoint) GetCreatedTime() *timestamppb.Timestamp
- func (x *Endpoint) GetId() string
- func (x *Endpoint) GetLastModifiedTime() *timestamppb.Timestamp
- func (x *Endpoint) GetSpec() *EndpointSpec
- func (x *Endpoint) GetUrlPrefix() string
- func (x *Endpoint) GetVersion() int64
- func (*Endpoint) ProtoMessage()
- func (x *Endpoint) ProtoReflect() protoreflect.Message
- func (x *Endpoint) Reset()
- func (x *Endpoint) String() string
- type EndpointSpec
- func (*EndpointSpec) Descriptor() ([]byte, []int)deprecated
- func (x *EndpointSpec) GetDescription() *v1.Payload
- func (x *EndpointSpec) GetName() string
- func (x *EndpointSpec) GetTarget() *EndpointTarget
- func (*EndpointSpec) ProtoMessage()
- func (x *EndpointSpec) ProtoReflect() protoreflect.Message
- func (x *EndpointSpec) Reset()
- func (x *EndpointSpec) String() string
- type EndpointTarget
- func (*EndpointTarget) Descriptor() ([]byte, []int)deprecated
- func (x *EndpointTarget) GetExternal() *EndpointTarget_External
- func (m *EndpointTarget) GetVariant() isEndpointTarget_Variant
- func (x *EndpointTarget) GetWorker() *EndpointTarget_Worker
- func (*EndpointTarget) ProtoMessage()
- func (x *EndpointTarget) ProtoReflect() protoreflect.Message
- func (x *EndpointTarget) Reset()
- func (x *EndpointTarget) String() string
- type EndpointTarget_External
- func (*EndpointTarget_External) Descriptor() ([]byte, []int)deprecated
- func (x *EndpointTarget_External) GetUrl() string
- func (*EndpointTarget_External) ProtoMessage()
- func (x *EndpointTarget_External) ProtoReflect() protoreflect.Message
- func (x *EndpointTarget_External) Reset()
- func (x *EndpointTarget_External) String() string
- type EndpointTarget_External_
- type EndpointTarget_Worker
- func (*EndpointTarget_Worker) Descriptor() ([]byte, []int)deprecated
- func (x *EndpointTarget_Worker) GetNamespace() string
- func (x *EndpointTarget_Worker) GetTaskQueue() string
- func (*EndpointTarget_Worker) ProtoMessage()
- func (x *EndpointTarget_Worker) ProtoReflect() protoreflect.Message
- func (x *EndpointTarget_Worker) Reset()
- func (x *EndpointTarget_Worker) String() string
- type EndpointTarget_Worker_
- type Failure
- func (*Failure) Descriptor() ([]byte, []int)deprecated
- func (x *Failure) GetDetails() []byte
- func (x *Failure) GetMessage() string
- func (x *Failure) GetMetadata() map[string]string
- func (*Failure) ProtoMessage()
- func (x *Failure) ProtoReflect() protoreflect.Message
- func (x *Failure) Reset()
- func (x *Failure) String() string
- type HandlerError
- func (*HandlerError) Descriptor() ([]byte, []int)deprecated
- func (x *HandlerError) GetErrorType() string
- func (x *HandlerError) GetFailure() *Failure
- func (*HandlerError) ProtoMessage()
- func (x *HandlerError) ProtoReflect() protoreflect.Message
- func (x *HandlerError) Reset()
- func (x *HandlerError) String() string
- type Request
- func (*Request) Descriptor() ([]byte, []int)deprecated
- func (x *Request) GetCancelOperation() *CancelOperationRequest
- func (x *Request) GetHeader() map[string]string
- func (x *Request) GetScheduledTime() *timestamppb.Timestamp
- func (x *Request) GetStartOperation() *StartOperationRequest
- func (m *Request) GetVariant() isRequest_Variant
- func (*Request) ProtoMessage()
- func (x *Request) ProtoReflect() protoreflect.Message
- func (x *Request) Reset()
- func (x *Request) String() string
- type Request_CancelOperation
- type Request_StartOperation
- type Response
- func (*Response) Descriptor() ([]byte, []int)deprecated
- func (x *Response) GetCancelOperation() *CancelOperationResponse
- func (x *Response) GetStartOperation() *StartOperationResponse
- func (m *Response) GetVariant() isResponse_Variant
- func (*Response) ProtoMessage()
- func (x *Response) ProtoReflect() protoreflect.Message
- func (x *Response) Reset()
- func (x *Response) String() string
- type Response_CancelOperation
- type Response_StartOperation
- type StartOperationRequest
- func (*StartOperationRequest) Descriptor() ([]byte, []int)deprecated
- func (x *StartOperationRequest) GetCallback() string
- func (x *StartOperationRequest) GetCallbackHeader() map[string]string
- func (x *StartOperationRequest) GetOperation() string
- func (x *StartOperationRequest) GetPayload() *v1.Payload
- func (x *StartOperationRequest) GetRequestId() string
- func (x *StartOperationRequest) GetService() string
- func (*StartOperationRequest) ProtoMessage()
- func (x *StartOperationRequest) ProtoReflect() protoreflect.Message
- func (x *StartOperationRequest) Reset()
- func (x *StartOperationRequest) String() string
- type StartOperationResponse
- func (*StartOperationResponse) Descriptor() ([]byte, []int)deprecated
- func (x *StartOperationResponse) GetAsyncSuccess() *StartOperationResponse_Async
- func (x *StartOperationResponse) GetOperationError() *UnsuccessfulOperationError
- func (x *StartOperationResponse) GetSyncSuccess() *StartOperationResponse_Sync
- func (m *StartOperationResponse) GetVariant() isStartOperationResponse_Variant
- func (*StartOperationResponse) ProtoMessage()
- func (x *StartOperationResponse) ProtoReflect() protoreflect.Message
- func (x *StartOperationResponse) Reset()
- func (x *StartOperationResponse) String() string
- type StartOperationResponse_Async
- func (*StartOperationResponse_Async) Descriptor() ([]byte, []int)deprecated
- func (x *StartOperationResponse_Async) GetOperationId() string
- func (*StartOperationResponse_Async) ProtoMessage()
- func (x *StartOperationResponse_Async) ProtoReflect() protoreflect.Message
- func (x *StartOperationResponse_Async) Reset()
- func (x *StartOperationResponse_Async) String() string
- type StartOperationResponse_AsyncSuccess
- type StartOperationResponse_OperationError
- type StartOperationResponse_Sync
- func (*StartOperationResponse_Sync) Descriptor() ([]byte, []int)deprecated
- func (x *StartOperationResponse_Sync) GetPayload() *v1.Payload
- func (*StartOperationResponse_Sync) ProtoMessage()
- func (x *StartOperationResponse_Sync) ProtoReflect() protoreflect.Message
- func (x *StartOperationResponse_Sync) Reset()
- func (x *StartOperationResponse_Sync) String() string
- type StartOperationResponse_SyncSuccess
- type UnsuccessfulOperationError
- func (*UnsuccessfulOperationError) Descriptor() ([]byte, []int)deprecated
- func (x *UnsuccessfulOperationError) GetFailure() *Failure
- func (x *UnsuccessfulOperationError) GetOperationState() string
- func (*UnsuccessfulOperationError) ProtoMessage()
- func (x *UnsuccessfulOperationError) ProtoReflect() protoreflect.Message
- func (x *UnsuccessfulOperationError) Reset()
- func (x *UnsuccessfulOperationError) String() string
Constants ¶
This section is empty.
Variables ¶
var File_temporal_api_nexus_v1_message_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type CancelOperationRequest ¶
type CancelOperationRequest struct { // Service name. Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"` // Type of operation to cancel. Operation string `protobuf:"bytes,2,opt,name=operation,proto3" json:"operation,omitempty"` // Operation ID as originally generated by a Handler. OperationId string `protobuf:"bytes,3,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) GetService ¶ added in v4.13.0
func (x *CancelOperationRequest) GetService() 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 Endpoint ¶ added in v4.13.0
type Endpoint struct { // Data version for this endpoint, incremented for every update issued via the UpdateNexusEndpoint API. Version int64 `protobuf:"varint,1,opt,name=version,proto3" json:"version,omitempty"` // Unique server-generated endpoint ID. Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"` // Spec for the endpoint. Spec *EndpointSpec `protobuf:"bytes,3,opt,name=spec,proto3" json:"spec,omitempty"` // The date and time when the endpoint was created. // (-- api-linter: core::0142::time-field-names=disabled // // aip.dev/not-precedent: Not following linter rules. --) CreatedTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=created_time,json=createdTime,proto3" json:"created_time,omitempty"` // The date and time when the endpoint was last modified. // Will not be set if the endpoint has never been modified. // (-- api-linter: core::0142::time-field-names=disabled // // aip.dev/not-precedent: Not following linter rules. --) LastModifiedTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=last_modified_time,json=lastModifiedTime,proto3" json:"last_modified_time,omitempty"` // Server exposed URL prefix for invocation of operations on this endpoint. // This doesn't include the protocol, hostname or port as the server does not know how it should be accessed // publicly. The URL is stable in the face of endpoint renames. UrlPrefix string `protobuf:"bytes,6,opt,name=url_prefix,json=urlPrefix,proto3" json:"url_prefix,omitempty"` // contains filtered or unexported fields }
A cluster-global binding from an endpoint ID to a target for dispatching incoming Nexus requests.
func (*Endpoint) Descriptor
deprecated
added in
v4.13.0
func (*Endpoint) GetCreatedTime ¶ added in v4.13.0
func (x *Endpoint) GetCreatedTime() *timestamppb.Timestamp
func (*Endpoint) GetLastModifiedTime ¶ added in v4.13.0
func (x *Endpoint) GetLastModifiedTime() *timestamppb.Timestamp
func (*Endpoint) GetSpec ¶ added in v4.13.0
func (x *Endpoint) GetSpec() *EndpointSpec
func (*Endpoint) GetUrlPrefix ¶ added in v4.13.0
func (*Endpoint) GetVersion ¶ added in v4.13.0
func (*Endpoint) ProtoMessage ¶ added in v4.13.0
func (*Endpoint) ProtoMessage()
func (*Endpoint) ProtoReflect ¶ added in v4.13.0
func (x *Endpoint) ProtoReflect() protoreflect.Message
type EndpointSpec ¶ added in v4.13.0
type EndpointSpec struct { // Endpoint name, unique for this cluster. Must match `[a-zA-Z_][a-zA-Z0-9_]*`. // Renaming an endpoint breaks all workflow callers that reference this endpoint, causing operations to fail. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Markdown description serialized as a single JSON string. // If the Payload is encrypted, the UI and CLI may decrypt with the configured codec server endpoint. Description *v1.Payload `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` // Target to route requests to. Target *EndpointTarget `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"` // contains filtered or unexported fields }
Contains mutable fields for an Endpoint.
func (*EndpointSpec) Descriptor
deprecated
added in
v4.13.0
func (*EndpointSpec) Descriptor() ([]byte, []int)
Deprecated: Use EndpointSpec.ProtoReflect.Descriptor instead.
func (*EndpointSpec) GetDescription ¶ added in v4.13.0
func (x *EndpointSpec) GetDescription() *v1.Payload
func (*EndpointSpec) GetName ¶ added in v4.13.0
func (x *EndpointSpec) GetName() string
func (*EndpointSpec) GetTarget ¶ added in v4.13.0
func (x *EndpointSpec) GetTarget() *EndpointTarget
func (*EndpointSpec) ProtoMessage ¶ added in v4.13.0
func (*EndpointSpec) ProtoMessage()
func (*EndpointSpec) ProtoReflect ¶ added in v4.13.0
func (x *EndpointSpec) ProtoReflect() protoreflect.Message
func (*EndpointSpec) Reset ¶ added in v4.13.0
func (x *EndpointSpec) Reset()
func (*EndpointSpec) String ¶ added in v4.13.0
func (x *EndpointSpec) String() string
type EndpointTarget ¶ added in v4.13.0
type EndpointTarget struct { // Types that are assignable to Variant: // // *EndpointTarget_Worker_ // *EndpointTarget_External_ Variant isEndpointTarget_Variant `protobuf_oneof:"variant"` // contains filtered or unexported fields }
Target to route requests to.
func (*EndpointTarget) Descriptor
deprecated
added in
v4.13.0
func (*EndpointTarget) Descriptor() ([]byte, []int)
Deprecated: Use EndpointTarget.ProtoReflect.Descriptor instead.
func (*EndpointTarget) GetExternal ¶ added in v4.13.0
func (x *EndpointTarget) GetExternal() *EndpointTarget_External
func (*EndpointTarget) GetVariant ¶ added in v4.13.0
func (m *EndpointTarget) GetVariant() isEndpointTarget_Variant
func (*EndpointTarget) GetWorker ¶ added in v4.13.0
func (x *EndpointTarget) GetWorker() *EndpointTarget_Worker
func (*EndpointTarget) ProtoMessage ¶ added in v4.13.0
func (*EndpointTarget) ProtoMessage()
func (*EndpointTarget) ProtoReflect ¶ added in v4.13.0
func (x *EndpointTarget) ProtoReflect() protoreflect.Message
func (*EndpointTarget) Reset ¶ added in v4.13.0
func (x *EndpointTarget) Reset()
func (*EndpointTarget) String ¶ added in v4.13.0
func (x *EndpointTarget) String() string
type EndpointTarget_External ¶ added in v4.13.0
type EndpointTarget_External struct { // URL to call. Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"` // contains filtered or unexported fields }
Target an external server by URL. At a later point, this will support providing credentials, in the meantime, an http.RoundTripper can be injected into the server to modify the request.
func (*EndpointTarget_External) Descriptor
deprecated
added in
v4.13.0
func (*EndpointTarget_External) Descriptor() ([]byte, []int)
Deprecated: Use EndpointTarget_External.ProtoReflect.Descriptor instead.
func (*EndpointTarget_External) GetUrl ¶ added in v4.13.0
func (x *EndpointTarget_External) GetUrl() string
func (*EndpointTarget_External) ProtoMessage ¶ added in v4.13.0
func (*EndpointTarget_External) ProtoMessage()
func (*EndpointTarget_External) ProtoReflect ¶ added in v4.13.0
func (x *EndpointTarget_External) ProtoReflect() protoreflect.Message
func (*EndpointTarget_External) Reset ¶ added in v4.13.0
func (x *EndpointTarget_External) Reset()
func (*EndpointTarget_External) String ¶ added in v4.13.0
func (x *EndpointTarget_External) String() string
type EndpointTarget_External_ ¶ added in v4.13.0
type EndpointTarget_External_ struct {
External *EndpointTarget_External `protobuf:"bytes,2,opt,name=external,proto3,oneof"`
}
type EndpointTarget_Worker ¶ added in v4.13.0
type EndpointTarget_Worker struct { // Namespace to route requests to. Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"` // Nexus task queue to route requests to. TaskQueue string `protobuf:"bytes,2,opt,name=task_queue,json=taskQueue,proto3" json:"task_queue,omitempty"` // contains filtered or unexported fields }
Target a worker polling on a Nexus task queue in a specific namespace.
func (*EndpointTarget_Worker) Descriptor
deprecated
added in
v4.13.0
func (*EndpointTarget_Worker) Descriptor() ([]byte, []int)
Deprecated: Use EndpointTarget_Worker.ProtoReflect.Descriptor instead.
func (*EndpointTarget_Worker) GetNamespace ¶ added in v4.13.0
func (x *EndpointTarget_Worker) GetNamespace() string
func (*EndpointTarget_Worker) GetTaskQueue ¶ added in v4.13.0
func (x *EndpointTarget_Worker) GetTaskQueue() string
func (*EndpointTarget_Worker) ProtoMessage ¶ added in v4.13.0
func (*EndpointTarget_Worker) ProtoMessage()
func (*EndpointTarget_Worker) ProtoReflect ¶ added in v4.13.0
func (x *EndpointTarget_Worker) ProtoReflect() protoreflect.Message
func (*EndpointTarget_Worker) Reset ¶ added in v4.13.0
func (x *EndpointTarget_Worker) Reset()
func (*EndpointTarget_Worker) String ¶ added in v4.13.0
func (x *EndpointTarget_Worker) String() string
type EndpointTarget_Worker_ ¶ added in v4.13.0
type EndpointTarget_Worker_ struct {
Worker *EndpointTarget_Worker `protobuf:"bytes,1,opt,name=worker,proto3,oneof"`
}
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 []byte `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) GetDetails ¶
func (*Failure) GetMessage ¶
func (*Failure) GetMetadata ¶
func (*Failure) ProtoMessage ¶
func (*Failure) ProtoMessage()
func (*Failure) ProtoReflect ¶
func (x *Failure) ProtoReflect() protoreflect.Message
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 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 */ // The timestamp when the request was scheduled in the frontend. // (-- api-linter: core::0142::time-field-names=disabled // // aip.dev/not-precedent: Not following linter rules. --) ScheduledTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=scheduled_time,json=scheduledTime,proto3" json:"scheduled_time,omitempty"` // 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) GetCancelOperation ¶
func (x *Request) GetCancelOperation() *CancelOperationRequest
func (*Request) GetScheduledTime ¶ added in v4.13.0
func (x *Request) GetScheduledTime() *timestamppb.Timestamp
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
type Request_CancelOperation ¶
type Request_CancelOperation struct {
CancelOperation *CancelOperationRequest `protobuf:"bytes,4,opt,name=cancel_operation,json=cancelOperation,proto3,oneof"`
}
type Request_StartOperation ¶
type Request_StartOperation struct {
StartOperation *StartOperationRequest `protobuf:"bytes,3,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) 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
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 { // Name of service to start the operation in. Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"` // Type of operation to start. Operation string `protobuf:"bytes,2,opt,name=operation,proto3" json:"operation,omitempty"` // A request ID that can be used as an idempotentency key. RequestId string `protobuf:"bytes,3,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,4,opt,name=callback,proto3" json:"callback,omitempty"` // Full request body from the incoming HTTP request. Payload *v1.Payload `protobuf:"bytes,5,opt,name=payload,proto3" json:"payload,omitempty"` // Header that is expected to be attached to the callback request when the operation completes. CallbackHeader map[string]string `` /* 191-byte string literal not displayed */ // 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) GetCallbackHeader ¶ added in v4.13.0
func (x *StartOperationRequest) GetCallbackHeader() map[string]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) GetService ¶ added in v4.13.0
func (x *StartOperationRequest) GetService() 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 (x *StartOperationResponse) GetAsyncSuccess() *StartOperationResponse_Async
func (*StartOperationResponse) GetOperationError ¶
func (x *StartOperationResponse) GetOperationError() *UnsuccessfulOperationError
func (*StartOperationResponse) GetSyncSuccess ¶
func (x *StartOperationResponse) GetSyncSuccess() *StartOperationResponse_Sync
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 (x *StartOperationResponse_Async) ProtoReflect() protoreflect.Message
func (*StartOperationResponse_Async) Reset ¶
func (x *StartOperationResponse_Async) Reset()
func (*StartOperationResponse_Async) String ¶
func (x *StartOperationResponse_Async) String() 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 (x *StartOperationResponse_Sync) ProtoReflect() protoreflect.Message
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 (x *UnsuccessfulOperationError) ProtoReflect() protoreflect.Message
func (*UnsuccessfulOperationError) Reset ¶
func (x *UnsuccessfulOperationError) Reset()
func (*UnsuccessfulOperationError) String ¶
func (x *UnsuccessfulOperationError) String() string