pb

package
v8.4.13 Latest Latest
Warning

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

 Go to latest Published: Nov 5, 2024 License: Apache-2.0 Imports: 8 Imported by: 9

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Partition_PartitionBrokerRole_name = map[int32]string{
		0: "LEADER",
		1: "FOLLOWER",
		2: "INACTIVE",
	}
	Partition_PartitionBrokerRole_value = map[string]int32{
		"LEADER":   0,
		"FOLLOWER": 1,
		"INACTIVE": 2,
	}
)

Enum value maps for Partition_PartitionBrokerRole.

View Source 
var (
	Partition_PartitionBrokerHealth_name = map[int32]string{
		0: "HEALTHY",
		1: "UNHEALTHY",
		2: "DEAD",
	}
	Partition_PartitionBrokerHealth_value = map[string]int32{
		"HEALTHY":   0,
		"UNHEALTHY": 1,
		"DEAD":      2,
	}
)

Enum value maps for Partition_PartitionBrokerHealth.

View Source 
var File_gateway_proto protoreflect.FileDescriptor

Functions

func RegisterGatewayServer 

func RegisterGatewayServer(s *grpc.Server, srv GatewayServer)

Types

type ActivateJobsRequest 

type ActivateJobsRequest struct {

	// the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
	// type="payment-service" />)
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// the name of the worker activating the jobs, mostly used for logging purposes
	Worker string `protobuf:"bytes,2,opt,name=worker,proto3" json:"worker,omitempty"`
	// a job returned after this call will not be activated by another call until the
	// timeout (in ms) has been reached
	Timeout int64 `protobuf:"varint,3,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// the maximum jobs to activate by this request
	MaxJobsToActivate int32 `protobuf:"varint,4,opt,name=maxJobsToActivate,proto3" json:"maxJobsToActivate,omitempty"`
	// a list of variables to fetch as the job variables; if empty, all visible variables at
	// the time of activation for the scope of the job will be returned
	FetchVariable []string `protobuf:"bytes,5,rep,name=fetchVariable,proto3" json:"fetchVariable,omitempty"`
	// The request will be completed when at least one job is activated or after the requestTimeout (in ms).
	// if the requestTimeout = 0, a default timeout is used.
	// if the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated.
	RequestTimeout int64 `protobuf:"varint,6,opt,name=requestTimeout,proto3" json:"requestTimeout,omitempty"`
	// a list of IDs of tenants for which to activate jobs
	TenantIds []string `protobuf:"bytes,7,rep,name=tenantIds,proto3" json:"tenantIds,omitempty"`
	// contains filtered or unexported fields
}

func (*ActivateJobsRequest) Descriptor deprecated 

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

Deprecated: Use ActivateJobsRequest.ProtoReflect.Descriptor instead.

func (*ActivateJobsRequest) GetFetchVariable 

func (x *ActivateJobsRequest) GetFetchVariable() []string

func (*ActivateJobsRequest) GetMaxJobsToActivate 

func (x *ActivateJobsRequest) GetMaxJobsToActivate() int32

func (*ActivateJobsRequest) GetRequestTimeout 

func (x *ActivateJobsRequest) GetRequestTimeout() int64

func (*ActivateJobsRequest) GetTenantIds added in v8.4.0 

func (x *ActivateJobsRequest) GetTenantIds() []string

func (*ActivateJobsRequest) GetTimeout 

func (x *ActivateJobsRequest) GetTimeout() int64

func (*ActivateJobsRequest) GetType 

func (x *ActivateJobsRequest) GetType() string

func (*ActivateJobsRequest) GetWorker 

func (x *ActivateJobsRequest) GetWorker() string

func (*ActivateJobsRequest) ProtoMessage 

func (*ActivateJobsRequest) ProtoMessage()

func (*ActivateJobsRequest) ProtoReflect 

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

func (*ActivateJobsRequest) Reset 

func (x *ActivateJobsRequest) Reset()

func (*ActivateJobsRequest) String 

func (x *ActivateJobsRequest) String() string

type ActivateJobsResponse 

type ActivateJobsResponse struct {

	// list of activated jobs
	Jobs []*ActivatedJob `protobuf:"bytes,1,rep,name=jobs,proto3" json:"jobs,omitempty"`
	// contains filtered or unexported fields
}

func (*ActivateJobsResponse) Descriptor deprecated 

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

Deprecated: Use ActivateJobsResponse.ProtoReflect.Descriptor instead.

func (*ActivateJobsResponse) GetJobs 

func (x *ActivateJobsResponse) GetJobs() []*ActivatedJob

func (*ActivateJobsResponse) ProtoMessage 

func (*ActivateJobsResponse) ProtoMessage()

func (*ActivateJobsResponse) ProtoReflect 

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

func (*ActivateJobsResponse) Reset 

func (x *ActivateJobsResponse) Reset()

func (*ActivateJobsResponse) String 

func (x *ActivateJobsResponse) String() string

type ActivatedJob 

type ActivatedJob struct {

	// the key, a unique identifier for the job
	Key int64 `protobuf:"varint,1,opt,name=key,proto3" json:"key,omitempty"`
	// the type of the job (should match what was requested)
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// the job's process instance key
	ProcessInstanceKey int64 `protobuf:"varint,3,opt,name=processInstanceKey,proto3" json:"processInstanceKey,omitempty"`
	// the bpmn process ID of the job process definition
	BpmnProcessId string `protobuf:"bytes,4,opt,name=bpmnProcessId,proto3" json:"bpmnProcessId,omitempty"`
	// the version of the job process definition
	ProcessDefinitionVersion int32 `protobuf:"varint,5,opt,name=processDefinitionVersion,proto3" json:"processDefinitionVersion,omitempty"`
	// the key of the job process definition
	ProcessDefinitionKey int64 `protobuf:"varint,6,opt,name=processDefinitionKey,proto3" json:"processDefinitionKey,omitempty"`
	// the associated task element ID
	ElementId string `protobuf:"bytes,7,opt,name=elementId,proto3" json:"elementId,omitempty"`
	// the unique key identifying the associated task, unique within the scope of the
	// process instance
	ElementInstanceKey int64 `protobuf:"varint,8,opt,name=elementInstanceKey,proto3" json:"elementInstanceKey,omitempty"`
	// a set of custom headers defined during modelling; returned as a serialized
	// JSON document
	CustomHeaders string `protobuf:"bytes,9,opt,name=customHeaders,proto3" json:"customHeaders,omitempty"`
	// the name of the worker which activated this job
	Worker string `protobuf:"bytes,10,opt,name=worker,proto3" json:"worker,omitempty"`
	// the amount of retries left to this job (should always be positive)
	Retries int32 `protobuf:"varint,11,opt,name=retries,proto3" json:"retries,omitempty"`
	// when the job can be activated again, sent as a UNIX epoch timestamp
	Deadline int64 `protobuf:"varint,12,opt,name=deadline,proto3" json:"deadline,omitempty"`
	// JSON document, computed at activation time, consisting of all visible variables to
	// the task scope
	Variables string `protobuf:"bytes,13,opt,name=variables,proto3" json:"variables,omitempty"`
	// the id of the tenant that owns the job
	TenantId string `protobuf:"bytes,14,opt,name=tenantId,proto3" json:"tenantId,omitempty"`
	// contains filtered or unexported fields
}

func (*ActivatedJob) Descriptor deprecated 

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

Deprecated: Use ActivatedJob.ProtoReflect.Descriptor instead.

func (*ActivatedJob) GetBpmnProcessId 

func (x *ActivatedJob) GetBpmnProcessId() string

func (*ActivatedJob) GetCustomHeaders 

func (x *ActivatedJob) GetCustomHeaders() string

func (*ActivatedJob) GetDeadline 

func (x *ActivatedJob) GetDeadline() int64

func (*ActivatedJob) GetElementId 

func (x *ActivatedJob) GetElementId() string

func (*ActivatedJob) GetElementInstanceKey 

func (x *ActivatedJob) GetElementInstanceKey() int64

func (*ActivatedJob) GetKey 

func (x *ActivatedJob) GetKey() int64

func (*ActivatedJob) GetProcessDefinitionKey 

func (x *ActivatedJob) GetProcessDefinitionKey() int64

func (*ActivatedJob) GetProcessDefinitionVersion 

func (x *ActivatedJob) GetProcessDefinitionVersion() int32

func (*ActivatedJob) GetProcessInstanceKey 

func (x *ActivatedJob) GetProcessInstanceKey() int64

func (*ActivatedJob) GetRetries 

func (x *ActivatedJob) GetRetries() int32

func (*ActivatedJob) GetTenantId added in v8.4.0 

func (x *ActivatedJob) GetTenantId() string

func (*ActivatedJob) GetType 

func (x *ActivatedJob) GetType() string

func (*ActivatedJob) GetVariables 

func (x *ActivatedJob) GetVariables() string

func (*ActivatedJob) GetWorker 

func (x *ActivatedJob) GetWorker() string

func (*ActivatedJob) ProtoMessage 

func (*ActivatedJob) ProtoMessage()

func (*ActivatedJob) ProtoReflect 

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

func (*ActivatedJob) Reset 

func (x *ActivatedJob) Reset()

func (*ActivatedJob) String 

func (x *ActivatedJob) String() string

type BroadcastSignalRequest added in v8.2.0 

type BroadcastSignalRequest struct {

	// The name of the signal
	SignalName string `protobuf:"bytes,1,opt,name=signalName,proto3" json:"signalName,omitempty"`
	// the signal variables as a JSON document; to be valid, the root of the document must be an
	// object, e.g. { "a": "foo" }. [ "foo" ] would not be valid.
	Variables string `protobuf:"bytes,2,opt,name=variables,proto3" json:"variables,omitempty"`
	// the id of the tenant that owns the signal.
	TenantId string `protobuf:"bytes,3,opt,name=tenantId,proto3" json:"tenantId,omitempty"`
	// contains filtered or unexported fields
}

func (*BroadcastSignalRequest) Descriptor deprecated added in v8.2.0 

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

Deprecated: Use BroadcastSignalRequest.ProtoReflect.Descriptor instead.

func (*BroadcastSignalRequest) GetSignalName added in v8.2.0 

func (x *BroadcastSignalRequest) GetSignalName() string

func (*BroadcastSignalRequest) GetTenantId added in v8.4.0 

func (x *BroadcastSignalRequest) GetTenantId() string

func (*BroadcastSignalRequest) GetVariables added in v8.2.0 

func (x *BroadcastSignalRequest) GetVariables() string

func (*BroadcastSignalRequest) ProtoMessage added in v8.2.0 

func (*BroadcastSignalRequest) ProtoMessage()

func (*BroadcastSignalRequest) ProtoReflect added in v8.2.0 

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

func (*BroadcastSignalRequest) Reset added in v8.2.0 

func (x *BroadcastSignalRequest) Reset()

func (*BroadcastSignalRequest) String added in v8.2.0 

func (x *BroadcastSignalRequest) String() string

type BroadcastSignalResponse added in v8.2.0 

type BroadcastSignalResponse struct {

	// the unique ID of the signal that was broadcasted.
	Key int64 `protobuf:"varint,1,opt,name=key,proto3" json:"key,omitempty"`
	// the tenant id of the signal that was broadcasted.
	TenantId string `protobuf:"bytes,2,opt,name=tenantId,proto3" json:"tenantId,omitempty"`
	// contains filtered or unexported fields
}

func (*BroadcastSignalResponse) Descriptor deprecated added in v8.2.0 

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

Deprecated: Use BroadcastSignalResponse.ProtoReflect.Descriptor instead.

func (*BroadcastSignalResponse) GetKey added in v8.2.0 

func (x *BroadcastSignalResponse) GetKey() int64

func (*BroadcastSignalResponse) GetTenantId added in v8.4.0 

func (x *BroadcastSignalResponse) GetTenantId() string

func (*BroadcastSignalResponse) ProtoMessage added in v8.2.0 

func (*BroadcastSignalResponse) ProtoMessage()

func (*BroadcastSignalResponse) ProtoReflect added in v8.2.0 

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

func (*BroadcastSignalResponse) Reset added in v8.2.0 

func (x *BroadcastSignalResponse) Reset()

func (*BroadcastSignalResponse) String added in v8.2.0 

func (x *BroadcastSignalResponse) String() string

type BrokerInfo 

type BrokerInfo struct {

	// unique (within a cluster) node ID for the broker
	NodeId int32 `protobuf:"varint,1,opt,name=nodeId,proto3" json:"nodeId,omitempty"`
	// hostname of the broker
	Host string `protobuf:"bytes,2,opt,name=host,proto3" json:"host,omitempty"`
	// port for the broker
	Port int32 `protobuf:"varint,3,opt,name=port,proto3" json:"port,omitempty"`
	// list of partitions managed or replicated on this broker
	Partitions []*Partition `protobuf:"bytes,4,rep,name=partitions,proto3" json:"partitions,omitempty"`
	// broker version
	Version string `protobuf:"bytes,5,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

func (*BrokerInfo) Descriptor deprecated 

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

Deprecated: Use BrokerInfo.ProtoReflect.Descriptor instead.

func (*BrokerInfo) GetHost 

func (x *BrokerInfo) GetHost() string

func (*BrokerInfo) GetNodeId 

func (x *BrokerInfo) GetNodeId() int32

func (*BrokerInfo) GetPartitions 

func (x *BrokerInfo) GetPartitions() []*Partition

func (*BrokerInfo) GetPort 

func (x *BrokerInfo) GetPort() int32

func (*BrokerInfo) GetVersion 

func (x *BrokerInfo) GetVersion() string

func (*BrokerInfo) ProtoMessage 

func (*BrokerInfo) ProtoMessage()

func (*BrokerInfo) ProtoReflect 

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

func (*BrokerInfo) Reset 

func (x *BrokerInfo) Reset()

func (*BrokerInfo) String 

func (x *BrokerInfo) String() string

type CancelProcessInstanceRequest 

type CancelProcessInstanceRequest struct {

	// the process instance key (as, for example, obtained from
	// CreateProcessInstanceResponse)
	ProcessInstanceKey int64 `protobuf:"varint,1,opt,name=processInstanceKey,proto3" json:"processInstanceKey,omitempty"`
	// contains filtered or unexported fields
}

func (*CancelProcessInstanceRequest) Descriptor deprecated 

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

Deprecated: Use CancelProcessInstanceRequest.ProtoReflect.Descriptor instead.

func (*CancelProcessInstanceRequest) GetProcessInstanceKey 

func (x *CancelProcessInstanceRequest) GetProcessInstanceKey() int64

func (*CancelProcessInstanceRequest) ProtoMessage 

func (*CancelProcessInstanceRequest) ProtoMessage()

func (*CancelProcessInstanceRequest) ProtoReflect 

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

func (*CancelProcessInstanceRequest) Reset 

func (x *CancelProcessInstanceRequest) Reset()

func (*CancelProcessInstanceRequest) String 

func (x *CancelProcessInstanceRequest) String() string

type CancelProcessInstanceResponse 

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

func (*CancelProcessInstanceResponse) Descriptor deprecated 

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

Deprecated: Use CancelProcessInstanceResponse.ProtoReflect.Descriptor instead.

func (*CancelProcessInstanceResponse) ProtoMessage 

func (*CancelProcessInstanceResponse) ProtoMessage()

func (*CancelProcessInstanceResponse) ProtoReflect 

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

func (*CancelProcessInstanceResponse) Reset 

func (x *CancelProcessInstanceResponse) Reset()

func (*CancelProcessInstanceResponse) String 

func (x *CancelProcessInstanceResponse) String() string

type CompleteJobRequest 

type CompleteJobRequest struct {

	// the unique job identifier, as obtained from ActivateJobsResponse
	JobKey int64 `protobuf:"varint,1,opt,name=jobKey,proto3" json:"jobKey,omitempty"`
	// a JSON document representing the variables in the current task scope
	Variables string `protobuf:"bytes,2,opt,name=variables,proto3" json:"variables,omitempty"`
	// contains filtered or unexported fields
}

func (*CompleteJobRequest) Descriptor deprecated 

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

Deprecated: Use CompleteJobRequest.ProtoReflect.Descriptor instead.

func (*CompleteJobRequest) GetJobKey 

func (x *CompleteJobRequest) GetJobKey() int64

func (*CompleteJobRequest) GetVariables 

func (x *CompleteJobRequest) GetVariables() string

func (*CompleteJobRequest) ProtoMessage 

func (*CompleteJobRequest) ProtoMessage()

func (*CompleteJobRequest) ProtoReflect 

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

func (*CompleteJobRequest) Reset 

func (x *CompleteJobRequest) Reset()

func (*CompleteJobRequest) String 

func (x *CompleteJobRequest) String() string

type CompleteJobResponse 

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

func (*CompleteJobResponse) Descriptor deprecated 

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

Deprecated: Use CompleteJobResponse.ProtoReflect.Descriptor instead.

func (*CompleteJobResponse) ProtoMessage 

func (*CompleteJobResponse) ProtoMessage()

func (*CompleteJobResponse) ProtoReflect 

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

func (*CompleteJobResponse) Reset 

func (x *CompleteJobResponse) Reset()

func (*CompleteJobResponse) String 

func (x *CompleteJobResponse) String() string

type CreateProcessInstanceRequest 

type CreateProcessInstanceRequest struct {

	// the unique key identifying the process definition (e.g. returned from a process
	// in the DeployProcessResponse message)
	ProcessDefinitionKey int64 `protobuf:"varint,1,opt,name=processDefinitionKey,proto3" json:"processDefinitionKey,omitempty"`
	// the BPMN process ID of the process definition
	BpmnProcessId string `protobuf:"bytes,2,opt,name=bpmnProcessId,proto3" json:"bpmnProcessId,omitempty"`
	// the version of the process; set to -1 to use the latest version
	Version int32 `protobuf:"varint,3,opt,name=version,proto3" json:"version,omitempty"`
	// JSON document that will instantiate the variables for the root variable scope of the
	// process instance; it must be a JSON object, as variables will be mapped in a
	// key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
	// "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
	// valid argument, as the root of the JSON document is an array and not an object.
	Variables string `protobuf:"bytes,4,opt,name=variables,proto3" json:"variables,omitempty"`
	// List of start instructions. If empty (default) the process instance
	// will start at the start event. If non-empty the process instance will apply start
	// instructions after it has been created
	StartInstructions []*ProcessInstanceCreationStartInstruction `protobuf:"bytes,5,rep,name=startInstructions,proto3" json:"startInstructions,omitempty"`
	// the tenant id of the process definition
	TenantId string `protobuf:"bytes,6,opt,name=tenantId,proto3" json:"tenantId,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateProcessInstanceRequest) Descriptor deprecated 

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

Deprecated: Use CreateProcessInstanceRequest.ProtoReflect.Descriptor instead.

func (*CreateProcessInstanceRequest) GetBpmnProcessId 

func (x *CreateProcessInstanceRequest) GetBpmnProcessId() string

func (*CreateProcessInstanceRequest) GetProcessDefinitionKey 

func (x *CreateProcessInstanceRequest) GetProcessDefinitionKey() int64

func (*CreateProcessInstanceRequest) GetStartInstructions added in v8.0.15 

func (x *CreateProcessInstanceRequest) GetStartInstructions() []*ProcessInstanceCreationStartInstruction

func (*CreateProcessInstanceRequest) GetTenantId added in v8.4.0 

func (x *CreateProcessInstanceRequest) GetTenantId() string

func (*CreateProcessInstanceRequest) GetVariables 

func (x *CreateProcessInstanceRequest) GetVariables() string

func (*CreateProcessInstanceRequest) GetVersion 

func (x *CreateProcessInstanceRequest) GetVersion() int32

func (*CreateProcessInstanceRequest) ProtoMessage 

func (*CreateProcessInstanceRequest) ProtoMessage()

func (*CreateProcessInstanceRequest) ProtoReflect 

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

func (*CreateProcessInstanceRequest) Reset 

func (x *CreateProcessInstanceRequest) Reset()

func (*CreateProcessInstanceRequest) String 

func (x *CreateProcessInstanceRequest) String() string

type CreateProcessInstanceResponse 

type CreateProcessInstanceResponse struct {

	// the key of the process definition which was used to create the process instance
	ProcessDefinitionKey int64 `protobuf:"varint,1,opt,name=processDefinitionKey,proto3" json:"processDefinitionKey,omitempty"`
	// the BPMN process ID of the process definition which was used to create the process
	// instance
	BpmnProcessId string `protobuf:"bytes,2,opt,name=bpmnProcessId,proto3" json:"bpmnProcessId,omitempty"`
	// the version of the process definition which was used to create the process instance
	Version int32 `protobuf:"varint,3,opt,name=version,proto3" json:"version,omitempty"`
	// the unique identifier of the created process instance; to be used wherever a request
	// needs a process instance key (e.g. CancelProcessInstanceRequest)
	ProcessInstanceKey int64 `protobuf:"varint,4,opt,name=processInstanceKey,proto3" json:"processInstanceKey,omitempty"`
	// the tenant identifier of the created process instance
	TenantId string `protobuf:"bytes,5,opt,name=tenantId,proto3" json:"tenantId,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateProcessInstanceResponse) Descriptor deprecated 

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

Deprecated: Use CreateProcessInstanceResponse.ProtoReflect.Descriptor instead.

func (*CreateProcessInstanceResponse) GetBpmnProcessId 

func (x *CreateProcessInstanceResponse) GetBpmnProcessId() string

func (*CreateProcessInstanceResponse) GetProcessDefinitionKey 

func (x *CreateProcessInstanceResponse) GetProcessDefinitionKey() int64

func (*CreateProcessInstanceResponse) GetProcessInstanceKey 

func (x *CreateProcessInstanceResponse) GetProcessInstanceKey() int64

func (*CreateProcessInstanceResponse) GetTenantId added in v8.4.0 

func (x *CreateProcessInstanceResponse) GetTenantId() string

func (*CreateProcessInstanceResponse) GetVersion 

func (x *CreateProcessInstanceResponse) GetVersion() int32

func (*CreateProcessInstanceResponse) ProtoMessage 

func (*CreateProcessInstanceResponse) ProtoMessage()

func (*CreateProcessInstanceResponse) ProtoReflect 

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

func (*CreateProcessInstanceResponse) Reset 

func (x *CreateProcessInstanceResponse) Reset()

func (*CreateProcessInstanceResponse) String 

func (x *CreateProcessInstanceResponse) String() string

type CreateProcessInstanceWithResultRequest 

type CreateProcessInstanceWithResultRequest struct {
	Request *CreateProcessInstanceRequest `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"`
	// timeout (in ms). the request will be closed if the process is not completed
	// before the requestTimeout.
	// if requestTimeout = 0, uses the generic requestTimeout configured in the gateway.
	RequestTimeout int64 `protobuf:"varint,2,opt,name=requestTimeout,proto3" json:"requestTimeout,omitempty"`
	// list of names of variables to be included in `CreateProcessInstanceWithResultResponse.variables`
	// if empty, all visible variables in the root scope will be returned.
	FetchVariables []string `protobuf:"bytes,3,rep,name=fetchVariables,proto3" json:"fetchVariables,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateProcessInstanceWithResultRequest) Descriptor deprecated 

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

Deprecated: Use CreateProcessInstanceWithResultRequest.ProtoReflect.Descriptor instead.

func (*CreateProcessInstanceWithResultRequest) GetFetchVariables 

func (x *CreateProcessInstanceWithResultRequest) GetFetchVariables() []string

func (*CreateProcessInstanceWithResultRequest) GetRequest 

func (x *CreateProcessInstanceWithResultRequest) GetRequest() *CreateProcessInstanceRequest

func (*CreateProcessInstanceWithResultRequest) GetRequestTimeout 

func (x *CreateProcessInstanceWithResultRequest) GetRequestTimeout() int64

func (*CreateProcessInstanceWithResultRequest) ProtoMessage 

func (*CreateProcessInstanceWithResultRequest) ProtoMessage()

func (*CreateProcessInstanceWithResultRequest) ProtoReflect 

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

func (*CreateProcessInstanceWithResultRequest) Reset 

func (x *CreateProcessInstanceWithResultRequest) Reset()

func (*CreateProcessInstanceWithResultRequest) String 

func (x *CreateProcessInstanceWithResultRequest) String() string

type CreateProcessInstanceWithResultResponse 

type CreateProcessInstanceWithResultResponse struct {

	// the key of the process definition which was used to create the process instance
	ProcessDefinitionKey int64 `protobuf:"varint,1,opt,name=processDefinitionKey,proto3" json:"processDefinitionKey,omitempty"`
	// the BPMN process ID of the process definition which was used to create the process
	// instance
	BpmnProcessId string `protobuf:"bytes,2,opt,name=bpmnProcessId,proto3" json:"bpmnProcessId,omitempty"`
	// the version of the process definition which was used to create the process instance
	Version int32 `protobuf:"varint,3,opt,name=version,proto3" json:"version,omitempty"`
	// the unique identifier of the created process instance; to be used wherever a request
	// needs a process instance key (e.g. CancelProcessInstanceRequest)
	ProcessInstanceKey int64 `protobuf:"varint,4,opt,name=processInstanceKey,proto3" json:"processInstanceKey,omitempty"`
	// JSON document
	// consists of visible variables in the root scope
	Variables string `protobuf:"bytes,5,opt,name=variables,proto3" json:"variables,omitempty"`
	// the tenant identifier of the process definition
	TenantId string `protobuf:"bytes,6,opt,name=tenantId,proto3" json:"tenantId,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateProcessInstanceWithResultResponse) Descriptor deprecated 

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

Deprecated: Use CreateProcessInstanceWithResultResponse.ProtoReflect.Descriptor instead.

func (*CreateProcessInstanceWithResultResponse) GetBpmnProcessId 

func (x *CreateProcessInstanceWithResultResponse) GetBpmnProcessId() string

func (*CreateProcessInstanceWithResultResponse) GetProcessDefinitionKey 

func (x *CreateProcessInstanceWithResultResponse) GetProcessDefinitionKey() int64

func (*CreateProcessInstanceWithResultResponse) GetProcessInstanceKey 

func (x *CreateProcessInstanceWithResultResponse) GetProcessInstanceKey() int64

func (*CreateProcessInstanceWithResultResponse) GetTenantId added in v8.4.0 

func (x *CreateProcessInstanceWithResultResponse) GetTenantId() string

func (*CreateProcessInstanceWithResultResponse) GetVariables 

func (x *CreateProcessInstanceWithResultResponse) GetVariables() string

func (*CreateProcessInstanceWithResultResponse) GetVersion 

func (x *CreateProcessInstanceWithResultResponse) GetVersion() int32

func (*CreateProcessInstanceWithResultResponse) ProtoMessage 

func (*CreateProcessInstanceWithResultResponse) ProtoMessage()

func (*CreateProcessInstanceWithResultResponse) ProtoReflect 

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

func (*CreateProcessInstanceWithResultResponse) Reset 

func (x *CreateProcessInstanceWithResultResponse) Reset()

func (*CreateProcessInstanceWithResultResponse) String 

func (x *CreateProcessInstanceWithResultResponse) String() string

type DecisionMetadata 

type DecisionMetadata struct {

	// the dmn decision ID, as parsed during deployment; together with the
	// versions forms a unique identifier for a specific decision
	DmnDecisionId string `protobuf:"bytes,1,opt,name=dmnDecisionId,proto3" json:"dmnDecisionId,omitempty"`
	// the dmn name of the decision, as parsed during deployment
	DmnDecisionName string `protobuf:"bytes,2,opt,name=dmnDecisionName,proto3" json:"dmnDecisionName,omitempty"`
	// the assigned decision version
	Version int32 `protobuf:"varint,3,opt,name=version,proto3" json:"version,omitempty"`
	// the assigned decision key, which acts as a unique identifier for this
	// decision
	DecisionKey int64 `protobuf:"varint,4,opt,name=decisionKey,proto3" json:"decisionKey,omitempty"`
	// the dmn ID of the decision requirements graph that this decision is part
	// of, as parsed during deployment
	DmnDecisionRequirementsId string `protobuf:"bytes,5,opt,name=dmnDecisionRequirementsId,proto3" json:"dmnDecisionRequirementsId,omitempty"`
	// the assigned key of the decision requirements graph that this decision is
	// part of
	DecisionRequirementsKey int64 `protobuf:"varint,6,opt,name=decisionRequirementsKey,proto3" json:"decisionRequirementsKey,omitempty"`
	// the tenant id of the deployed decision
	TenantId string `protobuf:"bytes,7,opt,name=tenantId,proto3" json:"tenantId,omitempty"`
	// contains filtered or unexported fields
}

func (*DecisionMetadata) Descriptor deprecated 

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

Deprecated: Use DecisionMetadata.ProtoReflect.Descriptor instead.

func (*DecisionMetadata) GetDecisionKey 

func (x *DecisionMetadata) GetDecisionKey() int64

func (*DecisionMetadata) GetDecisionRequirementsKey 

func (x *DecisionMetadata) GetDecisionRequirementsKey() int64

func (*DecisionMetadata) GetDmnDecisionId 

func (x *DecisionMetadata) GetDmnDecisionId() string

func (*DecisionMetadata) GetDmnDecisionName 

func (x *DecisionMetadata) GetDmnDecisionName() string

func (*DecisionMetadata) GetDmnDecisionRequirementsId 

func (x *DecisionMetadata) GetDmnDecisionRequirementsId() string

func (*DecisionMetadata) GetTenantId added in v8.4.0 

func (x *DecisionMetadata) GetTenantId() string

func (*DecisionMetadata) GetVersion 

func (x *DecisionMetadata) GetVersion() int32

func (*DecisionMetadata) ProtoMessage 

func (*DecisionMetadata) ProtoMessage()

func (*DecisionMetadata) ProtoReflect 

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

func (*DecisionMetadata) Reset 

func (x *DecisionMetadata) Reset()

func (*DecisionMetadata) String 

func (x *DecisionMetadata) String() string

type DecisionRequirementsMetadata 

type DecisionRequirementsMetadata struct {

	// the dmn decision requirements ID, as parsed during deployment; together
	// with the versions forms a unique identifier for a specific decision
	DmnDecisionRequirementsId string `protobuf:"bytes,1,opt,name=dmnDecisionRequirementsId,proto3" json:"dmnDecisionRequirementsId,omitempty"`
	// the dmn name of the decision requirements, as parsed during deployment
	DmnDecisionRequirementsName string `protobuf:"bytes,2,opt,name=dmnDecisionRequirementsName,proto3" json:"dmnDecisionRequirementsName,omitempty"`
	// the assigned decision requirements version
	Version int32 `protobuf:"varint,3,opt,name=version,proto3" json:"version,omitempty"`
	// the assigned decision requirements key, which acts as a unique identifier
	// for this decision requirements
	DecisionRequirementsKey int64 `protobuf:"varint,4,opt,name=decisionRequirementsKey,proto3" json:"decisionRequirementsKey,omitempty"`
	// the resource name (see: Resource.name) from which this decision
	// requirements was parsed
	ResourceName string `protobuf:"bytes,5,opt,name=resourceName,proto3" json:"resourceName,omitempty"`
	// the tenant id of the deployed decision requirements
	TenantId string `protobuf:"bytes,6,opt,name=tenantId,proto3" json:"tenantId,omitempty"`
	// contains filtered or unexported fields
}

func (*DecisionRequirementsMetadata) Descriptor deprecated 

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

Deprecated: Use DecisionRequirementsMetadata.ProtoReflect.Descriptor instead.

func (*DecisionRequirementsMetadata) GetDecisionRequirementsKey 

func (x *DecisionRequirementsMetadata) GetDecisionRequirementsKey() int64

func (*DecisionRequirementsMetadata) GetDmnDecisionRequirementsId 

func (x *DecisionRequirementsMetadata) GetDmnDecisionRequirementsId() string

func (*DecisionRequirementsMetadata) GetDmnDecisionRequirementsName 

func (x *DecisionRequirementsMetadata) GetDmnDecisionRequirementsName() string

func (*DecisionRequirementsMetadata) GetResourceName 

func (x *DecisionRequirementsMetadata) GetResourceName() string

func (*DecisionRequirementsMetadata) GetTenantId added in v8.4.0 

func (x *DecisionRequirementsMetadata) GetTenantId() string

func (*DecisionRequirementsMetadata) GetVersion 

func (x *DecisionRequirementsMetadata) GetVersion() int32

func (*DecisionRequirementsMetadata) ProtoMessage 

func (*DecisionRequirementsMetadata) ProtoMessage()

func (*DecisionRequirementsMetadata) ProtoReflect 

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

func (*DecisionRequirementsMetadata) Reset 

func (x *DecisionRequirementsMetadata) Reset()

func (*DecisionRequirementsMetadata) String 

func (x *DecisionRequirementsMetadata) String() string

type DeleteResourceRequest added in v8.2.0 

type DeleteResourceRequest struct {

	// The key of the resource that should be deleted. This can either be the key
	// of a process definition, the key of a decision requirements definition or the key of a form.
	ResourceKey int64 `protobuf:"varint,1,opt,name=resourceKey,proto3" json:"resourceKey,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteResourceRequest) Descriptor deprecated added in v8.2.0 

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

Deprecated: Use DeleteResourceRequest.ProtoReflect.Descriptor instead.

func (*DeleteResourceRequest) GetResourceKey added in v8.2.0 

func (x *DeleteResourceRequest) GetResourceKey() int64

func (*DeleteResourceRequest) ProtoMessage added in v8.2.0 

func (*DeleteResourceRequest) ProtoMessage()

func (*DeleteResourceRequest) ProtoReflect added in v8.2.0 

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

func (*DeleteResourceRequest) Reset added in v8.2.0 

func (x *DeleteResourceRequest) Reset()

func (*DeleteResourceRequest) String added in v8.2.0 

func (x *DeleteResourceRequest) String() string

type DeleteResourceResponse added in v8.2.0 

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

func (*DeleteResourceResponse) Descriptor deprecated added in v8.2.0 

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

Deprecated: Use DeleteResourceResponse.ProtoReflect.Descriptor instead.

func (*DeleteResourceResponse) ProtoMessage added in v8.2.0 

func (*DeleteResourceResponse) ProtoMessage()

func (*DeleteResourceResponse) ProtoReflect added in v8.2.0 

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

func (*DeleteResourceResponse) Reset added in v8.2.0 

func (x *DeleteResourceResponse) Reset()

func (*DeleteResourceResponse) String added in v8.2.0 

func (x *DeleteResourceResponse) String() string

type DeployProcessRequest deprecated 

type DeployProcessRequest struct {

	// List of process resources to deploy
	Processes []*ProcessRequestObject `protobuf:"bytes,1,rep,name=processes,proto3" json:"processes,omitempty"`
	// contains filtered or unexported fields
}

Deprecated: Do not use.

func (*DeployProcessRequest) Descriptor deprecated 

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

Deprecated: Use DeployProcessRequest.ProtoReflect.Descriptor instead.

func (*DeployProcessRequest) GetProcesses 

func (x *DeployProcessRequest) GetProcesses() []*ProcessRequestObject

func (*DeployProcessRequest) ProtoMessage 

func (*DeployProcessRequest) ProtoMessage()

func (*DeployProcessRequest) ProtoReflect 

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

func (*DeployProcessRequest) Reset 

func (x *DeployProcessRequest) Reset()

func (*DeployProcessRequest) String 

func (x *DeployProcessRequest) String() string

type DeployProcessResponse deprecated 

type DeployProcessResponse struct {

	// the unique key identifying the deployment
	Key int64 `protobuf:"varint,1,opt,name=key,proto3" json:"key,omitempty"`
	// a list of deployed processes
	Processes []*ProcessMetadata `protobuf:"bytes,2,rep,name=processes,proto3" json:"processes,omitempty"`
	// contains filtered or unexported fields
}

Deprecated: Do not use.

func (*DeployProcessResponse) Descriptor deprecated 

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

Deprecated: Use DeployProcessResponse.ProtoReflect.Descriptor instead.

func (*DeployProcessResponse) GetKey 

func (x *DeployProcessResponse) GetKey() int64

func (*DeployProcessResponse) GetProcesses 

func (x *DeployProcessResponse) GetProcesses() []*ProcessMetadata

func (*DeployProcessResponse) ProtoMessage 

func (*DeployProcessResponse) ProtoMessage()

func (*DeployProcessResponse) ProtoReflect 

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

func (*DeployProcessResponse) Reset 

func (x *DeployProcessResponse) Reset()

func (*DeployProcessResponse) String 

func (x *DeployProcessResponse) String() string

type DeployResourceRequest 

type DeployResourceRequest struct {

	// list of resources to deploy
	Resources []*Resource `protobuf:"bytes,1,rep,name=resources,proto3" json:"resources,omitempty"`
	// the tenant id of the resources to deploy
	TenantId string `protobuf:"bytes,2,opt,name=tenantId,proto3" json:"tenantId,omitempty"`
	// contains filtered or unexported fields
}

func (*DeployResourceRequest) Descriptor deprecated 

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

Deprecated: Use DeployResourceRequest.ProtoReflect.Descriptor instead.

func (*DeployResourceRequest) GetResources 

func (x *DeployResourceRequest) GetResources() []*Resource

func (*DeployResourceRequest) GetTenantId added in v8.4.0 

func (x *DeployResourceRequest) GetTenantId() string

func (*DeployResourceRequest) ProtoMessage 

func (*DeployResourceRequest) ProtoMessage()

func (*DeployResourceRequest) ProtoReflect 

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

func (*DeployResourceRequest) Reset 

func (x *DeployResourceRequest) Reset()

func (*DeployResourceRequest) String 

func (x *DeployResourceRequest) String() string

type DeployResourceResponse 

type DeployResourceResponse struct {

	// the unique key identifying the deployment
	Key int64 `protobuf:"varint,1,opt,name=key,proto3" json:"key,omitempty"`
	// a list of deployed resources, e.g. processes
	Deployments []*Deployment `protobuf:"bytes,2,rep,name=deployments,proto3" json:"deployments,omitempty"`
	// the tenant id of the deployed resources
	TenantId string `protobuf:"bytes,3,opt,name=tenantId,proto3" json:"tenantId,omitempty"`
	// contains filtered or unexported fields
}

func (*DeployResourceResponse) Descriptor deprecated 

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

Deprecated: Use DeployResourceResponse.ProtoReflect.Descriptor instead.

func (*DeployResourceResponse) GetDeployments 

func (x *DeployResourceResponse) GetDeployments() []*Deployment

func (*DeployResourceResponse) GetKey 

func (x *DeployResourceResponse) GetKey() int64

func (*DeployResourceResponse) GetTenantId added in v8.4.0 

func (x *DeployResourceResponse) GetTenantId() string

func (*DeployResourceResponse) ProtoMessage 

func (*DeployResourceResponse) ProtoMessage()

func (*DeployResourceResponse) ProtoReflect 

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

func (*DeployResourceResponse) Reset 

func (x *DeployResourceResponse) Reset()

func (*DeployResourceResponse) String 

func (x *DeployResourceResponse) String() string

type Deployment 

type Deployment struct {

	// each deployment has only one metadata
	//
	// Types that are assignable to Metadata:
	//
	//	*Deployment_Process
	//	*Deployment_Decision
	//	*Deployment_DecisionRequirements
	//	*Deployment_Form
	Metadata isDeployment_Metadata `protobuf_oneof:"Metadata"`
	// contains filtered or unexported fields
}

func (*Deployment) Descriptor deprecated 

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

Deprecated: Use Deployment.ProtoReflect.Descriptor instead.

func (*Deployment) GetDecision 

func (x *Deployment) GetDecision() *DecisionMetadata

func (*Deployment) GetDecisionRequirements 

func (x *Deployment) GetDecisionRequirements() *DecisionRequirementsMetadata

func (*Deployment) GetForm added in v8.4.0 

func (x *Deployment) GetForm() *FormMetadata

func (*Deployment) GetMetadata 

func (m *Deployment) GetMetadata() isDeployment_Metadata

func (*Deployment) GetProcess 

func (x *Deployment) GetProcess() *ProcessMetadata

func (*Deployment) ProtoMessage 

func (*Deployment) ProtoMessage()

func (*Deployment) ProtoReflect 

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

func (*Deployment) Reset 

func (x *Deployment) Reset()

func (*Deployment) String 

func (x *Deployment) String() string

type Deployment_Decision 

type Deployment_Decision struct {
	// metadata of a deployed decision
	Decision *DecisionMetadata `protobuf:"bytes,2,opt,name=decision,proto3,oneof"`
}

type Deployment_DecisionRequirements 

type Deployment_DecisionRequirements struct {
	// metadata of a deployed decision requirements
	DecisionRequirements *DecisionRequirementsMetadata `protobuf:"bytes,3,opt,name=decisionRequirements,proto3,oneof"`
}

type Deployment_Form added in v8.4.0 

type Deployment_Form struct {
	// metadata of a deployed form
	Form *FormMetadata `protobuf:"bytes,4,opt,name=form,proto3,oneof"`
}

type Deployment_Process 

type Deployment_Process struct {
	// metadata of a deployed process
	Process *ProcessMetadata `protobuf:"bytes,1,opt,name=process,proto3,oneof"`
}

type EvaluateDecisionRequest added in v8.2.0 

type EvaluateDecisionRequest struct {

	// the unique key identifying the decision to be evaluated (e.g. returned
	// from a decision in the DeployResourceResponse message)
	DecisionKey int64 `protobuf:"varint,1,opt,name=decisionKey,proto3" json:"decisionKey,omitempty"`
	// the ID of the decision to be evaluated
	DecisionId string `protobuf:"bytes,2,opt,name=decisionId,proto3" json:"decisionId,omitempty"`
	// JSON document that will instantiate the variables for the decision to be
	// evaluated; it must be a JSON object, as variables will be mapped in a
	// key-value fashion, e.g. { "a": 1, "b": 2 } will create two variables,
	// named "a" and "b" respectively, with their associated values.
	// [{ "a": 1, "b": 2 }] would not be a valid argument, as the root of the
	// JSON document is an array and not an object.
	Variables string `protobuf:"bytes,3,opt,name=variables,proto3" json:"variables,omitempty"`
	// the tenant identifier of the decision
	TenantId string `protobuf:"bytes,4,opt,name=tenantId,proto3" json:"tenantId,omitempty"`
	// contains filtered or unexported fields
}

func (*EvaluateDecisionRequest) Descriptor deprecated added in v8.2.0 

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

Deprecated: Use EvaluateDecisionRequest.ProtoReflect.Descriptor instead.

func (*EvaluateDecisionRequest) GetDecisionId added in v8.2.0 

func (x *EvaluateDecisionRequest) GetDecisionId() string

func (*EvaluateDecisionRequest) GetDecisionKey added in v8.2.0 

func (x *EvaluateDecisionRequest) GetDecisionKey() int64

func (*EvaluateDecisionRequest) GetTenantId added in v8.4.0 

func (x *EvaluateDecisionRequest) GetTenantId() string

func (*EvaluateDecisionRequest) GetVariables added in v8.2.0 

func (x *EvaluateDecisionRequest) GetVariables() string

func (*EvaluateDecisionRequest) ProtoMessage added in v8.2.0 

func (*EvaluateDecisionRequest) ProtoMessage()

func (*EvaluateDecisionRequest) ProtoReflect added in v8.2.0 

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

func (*EvaluateDecisionRequest) Reset added in v8.2.0 

func (x *EvaluateDecisionRequest) Reset()

func (*EvaluateDecisionRequest) String added in v8.2.0 

func (x *EvaluateDecisionRequest) String() string

type EvaluateDecisionResponse added in v8.2.0 

type EvaluateDecisionResponse struct {

	// the unique key identifying the decision which was evaluated (e.g. returned
	// from a decision in the DeployResourceResponse message)
	DecisionKey int64 `protobuf:"varint,1,opt,name=decisionKey,proto3" json:"decisionKey,omitempty"`
	// the ID of the decision which was evaluated
	DecisionId string `protobuf:"bytes,2,opt,name=decisionId,proto3" json:"decisionId,omitempty"`
	// the name of the decision which was evaluated
	DecisionName string `protobuf:"bytes,3,opt,name=decisionName,proto3" json:"decisionName,omitempty"`
	// the version of the decision which was evaluated
	DecisionVersion int32 `protobuf:"varint,4,opt,name=decisionVersion,proto3" json:"decisionVersion,omitempty"`
	// the ID of the decision requirements graph that the decision which was
	// evaluated is part of.
	DecisionRequirementsId string `protobuf:"bytes,5,opt,name=decisionRequirementsId,proto3" json:"decisionRequirementsId,omitempty"`
	// the unique key identifying the decision requirements graph that the
	// decision which was evaluated is part of.
	DecisionRequirementsKey int64 `protobuf:"varint,6,opt,name=decisionRequirementsKey,proto3" json:"decisionRequirementsKey,omitempty"`
	// JSON document that will instantiate the result of the decision which was
	// evaluated; it will be a JSON object, as the result output will be mapped
	// in a key-value fashion, e.g. { "a": 1 }.
	DecisionOutput string `protobuf:"bytes,7,opt,name=decisionOutput,proto3" json:"decisionOutput,omitempty"`
	// a list of decisions that were evaluated within the requested decision evaluation
	EvaluatedDecisions []*EvaluatedDecision `protobuf:"bytes,8,rep,name=evaluatedDecisions,proto3" json:"evaluatedDecisions,omitempty"`
	// an optional string indicating the ID of the decision which
	// failed during evaluation
	FailedDecisionId string `protobuf:"bytes,9,opt,name=failedDecisionId,proto3" json:"failedDecisionId,omitempty"`
	// an optional message describing why the decision which was evaluated failed
	FailureMessage string `protobuf:"bytes,10,opt,name=failureMessage,proto3" json:"failureMessage,omitempty"`
	// the tenant identifier of the evaluated decision
	TenantId string `protobuf:"bytes,11,opt,name=tenantId,proto3" json:"tenantId,omitempty"`
	// contains filtered or unexported fields
}

func (*EvaluateDecisionResponse) Descriptor deprecated added in v8.2.0 

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

Deprecated: Use EvaluateDecisionResponse.ProtoReflect.Descriptor instead.

func (*EvaluateDecisionResponse) GetDecisionId added in v8.2.0 

func (x *EvaluateDecisionResponse) GetDecisionId() string

func (*EvaluateDecisionResponse) GetDecisionKey added in v8.2.0 

func (x *EvaluateDecisionResponse) GetDecisionKey() int64

func (*EvaluateDecisionResponse) GetDecisionName added in v8.2.0 

func (x *EvaluateDecisionResponse) GetDecisionName() string

func (*EvaluateDecisionResponse) GetDecisionOutput added in v8.2.0 

func (x *EvaluateDecisionResponse) GetDecisionOutput() string

func (*EvaluateDecisionResponse) GetDecisionRequirementsId added in v8.2.0 

func (x *EvaluateDecisionResponse) GetDecisionRequirementsId() string

func (*EvaluateDecisionResponse) GetDecisionRequirementsKey added in v8.2.0 

func (x *EvaluateDecisionResponse) GetDecisionRequirementsKey() int64

func (*EvaluateDecisionResponse) GetDecisionVersion added in v8.2.0 

func (x *EvaluateDecisionResponse) GetDecisionVersion() int32

func (*EvaluateDecisionResponse) GetEvaluatedDecisions added in v8.2.0 

func (x *EvaluateDecisionResponse) GetEvaluatedDecisions() []*EvaluatedDecision

func (*EvaluateDecisionResponse) GetFailedDecisionId added in v8.2.0 

func (x *EvaluateDecisionResponse) GetFailedDecisionId() string

func (*EvaluateDecisionResponse) GetFailureMessage added in v8.2.0 

func (x *EvaluateDecisionResponse) GetFailureMessage() string

func (*EvaluateDecisionResponse) GetTenantId added in v8.4.0 

func (x *EvaluateDecisionResponse) GetTenantId() string

func (*EvaluateDecisionResponse) ProtoMessage added in v8.2.0 

func (*EvaluateDecisionResponse) ProtoMessage()

func (*EvaluateDecisionResponse) ProtoReflect added in v8.2.0 

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

func (*EvaluateDecisionResponse) Reset added in v8.2.0 

func (x *EvaluateDecisionResponse) Reset()

func (*EvaluateDecisionResponse) String added in v8.2.0 

func (x *EvaluateDecisionResponse) String() string

type EvaluatedDecision added in v8.2.0 

type EvaluatedDecision struct {

	// the unique key identifying the decision which was evaluated (e.g. returned
	// from a decision in the DeployResourceResponse message)
	DecisionKey int64 `protobuf:"varint,1,opt,name=decisionKey,proto3" json:"decisionKey,omitempty"`
	// the ID of the decision which was evaluated
	DecisionId string `protobuf:"bytes,2,opt,name=decisionId,proto3" json:"decisionId,omitempty"`
	// the name of the decision which was evaluated
	DecisionName string `protobuf:"bytes,3,opt,name=decisionName,proto3" json:"decisionName,omitempty"`
	// the version of the decision which was evaluated
	DecisionVersion int32 `protobuf:"varint,4,opt,name=decisionVersion,proto3" json:"decisionVersion,omitempty"`
	// the type of the decision which was evaluated
	DecisionType string `protobuf:"bytes,5,opt,name=decisionType,proto3" json:"decisionType,omitempty"`
	// JSON document that will instantiate the result of the decision which was
	// evaluated; it will be a JSON object, as the result output will be mapped
	// in a key-value fashion, e.g. { "a": 1 }.
	DecisionOutput string `protobuf:"bytes,6,opt,name=decisionOutput,proto3" json:"decisionOutput,omitempty"`
	// the decision rules that matched within this decision evaluation
	MatchedRules []*MatchedDecisionRule `protobuf:"bytes,7,rep,name=matchedRules,proto3" json:"matchedRules,omitempty"`
	// the decision inputs that were evaluated within this decision evaluation
	EvaluatedInputs []*EvaluatedDecisionInput `protobuf:"bytes,8,rep,name=evaluatedInputs,proto3" json:"evaluatedInputs,omitempty"`
	// the tenant identifier of the evaluated decision
	TenantId string `protobuf:"bytes,9,opt,name=tenantId,proto3" json:"tenantId,omitempty"`
	// contains filtered or unexported fields
}

func (*EvaluatedDecision) Descriptor deprecated added in v8.2.0 

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

Deprecated: Use EvaluatedDecision.ProtoReflect.Descriptor instead.

func (*EvaluatedDecision) GetDecisionId added in v8.2.0 

func (x *EvaluatedDecision) GetDecisionId() string

func (*EvaluatedDecision) GetDecisionKey added in v8.2.0 

func (x *EvaluatedDecision) GetDecisionKey() int64

func (*EvaluatedDecision) GetDecisionName added in v8.2.0 

func (x *EvaluatedDecision) GetDecisionName() string

func (*EvaluatedDecision) GetDecisionOutput added in v8.2.0 

func (x *EvaluatedDecision) GetDecisionOutput() string

func (*EvaluatedDecision) GetDecisionType added in v8.2.0 

func (x *EvaluatedDecision) GetDecisionType() string

func (*EvaluatedDecision) GetDecisionVersion added in v8.2.0 

func (x *EvaluatedDecision) GetDecisionVersion() int32

func (*EvaluatedDecision) GetEvaluatedInputs added in v8.2.0 

func (x *EvaluatedDecision) GetEvaluatedInputs() []*EvaluatedDecisionInput

func (*EvaluatedDecision) GetMatchedRules added in v8.2.0 

func (x *EvaluatedDecision) GetMatchedRules() []*MatchedDecisionRule

func (*EvaluatedDecision) GetTenantId added in v8.4.0 

func (x *EvaluatedDecision) GetTenantId() string

func (*EvaluatedDecision) ProtoMessage added in v8.2.0 

func (*EvaluatedDecision) ProtoMessage()

func (*EvaluatedDecision) ProtoReflect added in v8.2.0 

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

func (*EvaluatedDecision) Reset added in v8.2.0 

func (x *EvaluatedDecision) Reset()

func (*EvaluatedDecision) String added in v8.2.0 

func (x *EvaluatedDecision) String() string

type EvaluatedDecisionInput added in v8.2.0 

type EvaluatedDecisionInput struct {

	// the id of the evaluated decision input
	InputId string `protobuf:"bytes,1,opt,name=inputId,proto3" json:"inputId,omitempty"`
	// the name of the evaluated decision input
	InputName string `protobuf:"bytes,2,opt,name=inputName,proto3" json:"inputName,omitempty"`
	// the value of the evaluated decision input
	InputValue string `protobuf:"bytes,3,opt,name=inputValue,proto3" json:"inputValue,omitempty"`
	// contains filtered or unexported fields
}

func (*EvaluatedDecisionInput) Descriptor deprecated added in v8.2.0 

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

Deprecated: Use EvaluatedDecisionInput.ProtoReflect.Descriptor instead.

func (*EvaluatedDecisionInput) GetInputId added in v8.2.0 

func (x *EvaluatedDecisionInput) GetInputId() string

func (*EvaluatedDecisionInput) GetInputName added in v8.2.0 

func (x *EvaluatedDecisionInput) GetInputName() string

func (*EvaluatedDecisionInput) GetInputValue added in v8.2.0 

func (x *EvaluatedDecisionInput) GetInputValue() string

func (*EvaluatedDecisionInput) ProtoMessage added in v8.2.0 

func (*EvaluatedDecisionInput) ProtoMessage()

func (*EvaluatedDecisionInput) ProtoReflect added in v8.2.0 

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

func (*EvaluatedDecisionInput) Reset added in v8.2.0 

func (x *EvaluatedDecisionInput) Reset()

func (*EvaluatedDecisionInput) String added in v8.2.0 

func (x *EvaluatedDecisionInput) String() string

type EvaluatedDecisionOutput added in v8.2.0 

type EvaluatedDecisionOutput struct {

	// the id of the evaluated decision output
	OutputId string `protobuf:"bytes,1,opt,name=outputId,proto3" json:"outputId,omitempty"`
	// the name of the evaluated decision output
	OutputName string `protobuf:"bytes,2,opt,name=outputName,proto3" json:"outputName,omitempty"`
	// the value of the evaluated decision output
	OutputValue string `protobuf:"bytes,3,opt,name=outputValue,proto3" json:"outputValue,omitempty"`
	// contains filtered or unexported fields
}

func (*EvaluatedDecisionOutput) Descriptor deprecated added in v8.2.0 

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

Deprecated: Use EvaluatedDecisionOutput.ProtoReflect.Descriptor instead.

func (*EvaluatedDecisionOutput) GetOutputId added in v8.2.0 

func (x *EvaluatedDecisionOutput) GetOutputId() string

func (*EvaluatedDecisionOutput) GetOutputName added in v8.2.0 

func (x *EvaluatedDecisionOutput) GetOutputName() string

func (*EvaluatedDecisionOutput) GetOutputValue added in v8.2.0 

func (x *EvaluatedDecisionOutput) GetOutputValue() string

func (*EvaluatedDecisionOutput) ProtoMessage added in v8.2.0 

func (*EvaluatedDecisionOutput) ProtoMessage()

func (*EvaluatedDecisionOutput) ProtoReflect added in v8.2.0 

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

func (*EvaluatedDecisionOutput) Reset added in v8.2.0 

func (x *EvaluatedDecisionOutput) Reset()

func (*EvaluatedDecisionOutput) String added in v8.2.0 

func (x *EvaluatedDecisionOutput) String() string

type FailJobRequest 

type FailJobRequest struct {

	// the unique job identifier, as obtained when activating the job
	JobKey int64 `protobuf:"varint,1,opt,name=jobKey,proto3" json:"jobKey,omitempty"`
	// the amount of retries the job should have left
	Retries int32 `protobuf:"varint,2,opt,name=retries,proto3" json:"retries,omitempty"`
	// an optional message describing why the job failed
	// this is particularly useful if a job runs out of retries and an incident is raised,
	// as it this message can help explain why an incident was raised
	ErrorMessage string `protobuf:"bytes,3,opt,name=errorMessage,proto3" json:"errorMessage,omitempty"`
	// the backoff timeout (in ms) for the next retry
	RetryBackOff int64 `protobuf:"varint,4,opt,name=retryBackOff,proto3" json:"retryBackOff,omitempty"`
	// JSON document that will instantiate the variables at the local scope of the
	// job's associated task; it must be a JSON object, as variables will be mapped in a
	// key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
	// "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
	// valid argument, as the root of the JSON document is an array and not an object.
	Variables string `protobuf:"bytes,5,opt,name=variables,proto3" json:"variables,omitempty"`
	// contains filtered or unexported fields
}

func (*FailJobRequest) Descriptor deprecated 

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

Deprecated: Use FailJobRequest.ProtoReflect.Descriptor instead.

func (*FailJobRequest) GetErrorMessage 

func (x *FailJobRequest) GetErrorMessage() string

func (*FailJobRequest) GetJobKey 

func (x *FailJobRequest) GetJobKey() int64

func (*FailJobRequest) GetRetries 

func (x *FailJobRequest) GetRetries() int32

func (*FailJobRequest) GetRetryBackOff 

func (x *FailJobRequest) GetRetryBackOff() int64

func (*FailJobRequest) GetVariables added in v8.2.0 

func (x *FailJobRequest) GetVariables() string

func (*FailJobRequest) ProtoMessage 

func (*FailJobRequest) ProtoMessage()

func (*FailJobRequest) ProtoReflect 

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

func (*FailJobRequest) Reset 

func (x *FailJobRequest) Reset()

func (*FailJobRequest) String 

func (x *FailJobRequest) String() string

type FailJobResponse 

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

func (*FailJobResponse) Descriptor deprecated 

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

Deprecated: Use FailJobResponse.ProtoReflect.Descriptor instead.

func (*FailJobResponse) ProtoMessage 

func (*FailJobResponse) ProtoMessage()

func (*FailJobResponse) ProtoReflect 

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

func (*FailJobResponse) Reset 

func (x *FailJobResponse) Reset()

func (*FailJobResponse) String 

func (x *FailJobResponse) String() string

type FormMetadata added in v8.4.0 

type FormMetadata struct {

	// the form ID, as parsed during deployment; together with the
	// versions forms a unique identifier for a specific form
	FormId string `protobuf:"bytes,1,opt,name=formId,proto3" json:"formId,omitempty"`
	// the assigned form version
	Version int32 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	// the assigned key, which acts as a unique identifier for this form
	FormKey int64 `protobuf:"varint,3,opt,name=formKey,proto3" json:"formKey,omitempty"`
	// the resource name
	ResourceName string `protobuf:"bytes,4,opt,name=resourceName,proto3" json:"resourceName,omitempty"`
	// the tenant id of the deployed form
	TenantId string `protobuf:"bytes,5,opt,name=tenantId,proto3" json:"tenantId,omitempty"`
	// contains filtered or unexported fields
}

func (*FormMetadata) Descriptor deprecated added in v8.4.0 

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

Deprecated: Use FormMetadata.ProtoReflect.Descriptor instead.

func (*FormMetadata) GetFormId added in v8.4.0 

func (x *FormMetadata) GetFormId() string

func (*FormMetadata) GetFormKey added in v8.4.0 

func (x *FormMetadata) GetFormKey() int64

func (*FormMetadata) GetResourceName added in v8.4.0 

func (x *FormMetadata) GetResourceName() string

func (*FormMetadata) GetTenantId added in v8.4.0 

func (x *FormMetadata) GetTenantId() string

func (*FormMetadata) GetVersion added in v8.4.0 

func (x *FormMetadata) GetVersion() int32

func (*FormMetadata) ProtoMessage added in v8.4.0 

func (*FormMetadata) ProtoMessage()

func (*FormMetadata) ProtoReflect added in v8.4.0 

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

func (*FormMetadata) Reset added in v8.4.0 

func (x *FormMetadata) Reset()

func (*FormMetadata) String added in v8.4.0 

func (x *FormMetadata) String() string

type GatewayClient 

type GatewayClient interface {
	// Iterates through all known partitions round-robin and activates up to the requested
	// maximum and streams them back to the client as they are activated.
	//
	// Errors:
	// INVALID_ARGUMENT:
	// - type is blank (empty string, null)
	// - worker is blank (empty string, null)
	// - timeout less than 1
	// - maxJobsToActivate is less than 1
	ActivateJobs(ctx context.Context, in *ActivateJobsRequest, opts ...grpc.CallOption) (Gateway_ActivateJobsClient, error)
	// Registers client to a job stream that will stream jobs back to the client as
	// they become activatable.
	//
	// Errors:
	// INVALID_ARGUMENT:
	// - type is blank (empty string, null)
	// - timeout less than 1
	StreamActivatedJobs(ctx context.Context, in *StreamActivatedJobsRequest, opts ...grpc.CallOption) (Gateway_StreamActivatedJobsClient, error)
	// Cancels a running process instance
	//
	// Errors:
	// NOT_FOUND:
	// - no process instance exists with the given key
	CancelProcessInstance(ctx context.Context, in *CancelProcessInstanceRequest, opts ...grpc.CallOption) (*CancelProcessInstanceResponse, error)
	// Completes a job with the given variables, which allows completing the associated service task.
	//
	// Errors:
	// NOT_FOUND:
	// - no job exists with the given job key. Note that since jobs are removed once completed,
	// it could be that this job did exist at some point.
	//
	// FAILED_PRECONDITION:
	// - the job was marked as failed. In that case, the related incident must be resolved before
	// the job can be activated again and completed.
	CompleteJob(ctx context.Context, in *CompleteJobRequest, opts ...grpc.CallOption) (*CompleteJobResponse, error)
	// Creates and starts an instance of the specified process. The process definition to use to
	// create the instance can be specified either using its unique key (as returned by
	// DeployProcess), or using the BPMN process ID and a version. Pass -1 as the version to use the
	// latest deployed version. Note that only processes with none start events can be started through
	// this command.
	//
	// Errors:
	// NOT_FOUND:
	// - no process with the given key exists (if processDefinitionKey was given)
	// - no process with the given process ID exists (if bpmnProcessId was given but version was -1)
	// - no process with the given process ID and version exists (if both bpmnProcessId and version were given)
	//
	// FAILED_PRECONDITION:
	// - the process definition does not contain a none start event; only processes with none
	// start event can be started manually.
	//
	// INVALID_ARGUMENT:
	// - the given variables argument is not a valid JSON document; it is expected to be a valid
	// JSON document where the root node is an object.
	CreateProcessInstance(ctx context.Context, in *CreateProcessInstanceRequest, opts ...grpc.CallOption) (*CreateProcessInstanceResponse, error)
	// Behaves similarly to `rpc CreateProcessInstance`, except that a successful response is received when the process completes successfully.
	CreateProcessInstanceWithResult(ctx context.Context, in *CreateProcessInstanceWithResultRequest, opts ...grpc.CallOption) (*CreateProcessInstanceWithResultResponse, error)
	// Evaluates a decision. The decision to evaluate can be specified either by
	// using its unique key (as returned by DeployResource), or using the decision
	// ID. When using the decision ID, the latest deployed version of the decision
	// is used.
	//
	// Errors:
	// INVALID_ARGUMENT:
	// - no decision with the given key exists (if decisionKey was given)
	// - no decision with the given decision ID exists (if decisionId was given)
	// - both decision ID and decision KEY were provided, or are missing
	EvaluateDecision(ctx context.Context, in *EvaluateDecisionRequest, opts ...grpc.CallOption) (*EvaluateDecisionResponse, error)
	// Deprecated: Do not use.
	//
	// Deploys one or more processes to Zeebe. Note that this is an atomic call,
	// i.e. either all processes are deployed, or none of them are.
	//
	// Errors:
	// INVALID_ARGUMENT:
	// - no resources given.
	// - if at least one resource is invalid. A resource is considered invalid if:
	// - the resource data is not deserializable (e.g. detected as BPMN, but it's broken XML)
	// - the process is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
	DeployProcess(ctx context.Context, in *DeployProcessRequest, opts ...grpc.CallOption) (*DeployProcessResponse, error)
	// Deploys one or more resources (e.g. processes or decision models) to Zeebe.
	// Note that this is an atomic call, i.e. either all resources are deployed, or none of them are.
	//
	// Errors:
	// PERMISSION_DENIED:
	// - if a deployment to an unauthorized tenant is performed
	// INVALID_ARGUMENT:
	// - no resources given.
	// - if at least one resource is invalid. A resource is considered invalid if:
	// - the content is not deserializable (e.g. detected as BPMN, but it's broken XML)
	// - the content is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
	// - if multi-tenancy is enabled, and:
	// - a tenant id is not provided
	// - a tenant id with an invalid format is provided
	// - if multi-tenancy is disabled and a tenant id is provided
	DeployResource(ctx context.Context, in *DeployResourceRequest, opts ...grpc.CallOption) (*DeployResourceResponse, error)
	// Marks the job as failed; if the retries argument is positive, then the job will be immediately
	// activatable again, and a worker could try again to process it. If it is zero or negative however,
	// an incident will be raised, tagged with the given errorMessage, and the job will not be
	// activatable until the incident is resolved.
	//
	// Errors:
	// NOT_FOUND:
	// - no job was found with the given key
	//
	// FAILED_PRECONDITION:
	// - the job was not activated
	// - the job is already in a failed state, i.e. ran out of retries
	FailJob(ctx context.Context, in *FailJobRequest, opts ...grpc.CallOption) (*FailJobResponse, error)
	// Reports a business error (i.e. non-technical) that occurs while processing a job. The error is handled in the process by an error catch event. If there is no error catch event with the specified errorCode then an incident will be raised instead.
	//
	// Errors:
	// NOT_FOUND:
	// - no job was found with the given key
	//
	// FAILED_PRECONDITION:
	// - the job is not in an activated state
	ThrowError(ctx context.Context, in *ThrowErrorRequest, opts ...grpc.CallOption) (*ThrowErrorResponse, error)
	// Publishes a single message. Messages are published to specific partitions computed from their
	// correlation keys.
	//
	// Errors:
	// ALREADY_EXISTS:
	// - a message with the same ID was previously published (and is still alive)
	PublishMessage(ctx context.Context, in *PublishMessageRequest, opts ...grpc.CallOption) (*PublishMessageResponse, error)
	// Resolves a given incident. This simply marks the incident as resolved; most likely a call to
	// UpdateJobRetries or SetVariables will be necessary to actually resolve the
	// problem, following by this call.
	//
	// Errors:
	// NOT_FOUND:
	// - no incident with the given key exists
	ResolveIncident(ctx context.Context, in *ResolveIncidentRequest, opts ...grpc.CallOption) (*ResolveIncidentResponse, error)
	// Updates all the variables of a particular scope (e.g. process instance, flow element instance)
	// from the given JSON document.
	//
	// Errors:
	// NOT_FOUND:
	// - no element with the given elementInstanceKey exists
	// INVALID_ARGUMENT:
	// - the given variables document is not a valid JSON document; valid documents are expected to
	// be JSON documents where the root node is an object.
	SetVariables(ctx context.Context, in *SetVariablesRequest, opts ...grpc.CallOption) (*SetVariablesResponse, error)
	// Obtains the current topology of the cluster the gateway is part of.
	Topology(ctx context.Context, in *TopologyRequest, opts ...grpc.CallOption) (*TopologyResponse, error)
	// Updates the number of retries a job has left. This is mostly useful for jobs that have run out of
	// retries, should the underlying problem be solved.
	//
	// Errors:
	// NOT_FOUND:
	// - no job exists with the given key
	//
	// INVALID_ARGUMENT:
	// - retries is not greater than 0
	UpdateJobRetries(ctx context.Context, in *UpdateJobRetriesRequest, opts ...grpc.CallOption) (*UpdateJobRetriesResponse, error)
	// Modifies the process instance. This is done by activating and/or terminating specific elements of the instance.
	//
	// Errors:
	// NOT_FOUND:
	// - no process instance exists with the given key
	//
	// FAILED_PRECONDITION:
	// - trying to activate element inside of a multi-instance
	//
	// INVALID_ARGUMENT:
	// - activating or terminating unknown element
	// - ancestor of element for activation doesn't exist
	// - scope of variable is unknown
	ModifyProcessInstance(ctx context.Context, in *ModifyProcessInstanceRequest, opts ...grpc.CallOption) (*ModifyProcessInstanceResponse, error)
	// Migrates the process instance to the specified process definition.
	// In simple terms, this is handled by updating the active element's process.
	//
	// Errors:
	// NOT_FOUND:
	// - the process instance referenced by `processInstanceKey` is not active
	//
	// FAILED_PRECONDITION:
	// - not all active elements in the source process instance are mapped to the elements in the target process
	// - a mapping instruction changes the type of an element or event
	// - a mapping instruction refers to an unsupported element (i.e. some elements will be supported later on)
	// - a mapping instruction refers to element in unsupported scenarios.
	// (i.e. migrating active elements with event subscriptions will be supported later on)
	//
	// INVALID_ARGUMENT:
	// - the source element id does not refer to an element in the source process definition
	// - a source element id is mapped by multiple mapping instructions.
	// For example, the engine cannot determine how to migrate a process instance when the instructions are: [A->B, A->C].
	MigrateProcessInstance(ctx context.Context, in *MigrateProcessInstanceRequest, opts ...grpc.CallOption) (*MigrateProcessInstanceResponse, error)
	// Updates the deadline of a job using the timeout (in ms) provided. This can be used
	// for extending or shortening the job deadline.
	//
	// Errors:
	// NOT_FOUND:
	// - no job exists with the given key
	//
	// INVALID_STATE:
	// - no deadline exists for the given job key
	UpdateJobTimeout(ctx context.Context, in *UpdateJobTimeoutRequest, opts ...grpc.CallOption) (*UpdateJobTimeoutResponse, error)
	// Deletes a resource from the state. Once a resource has been deleted it cannot
	// be recovered. If the resource needs to be available again, a new deployment
	// of the resource is required.
	//
	// Deleting a process will cancel any running instances of this process
	// definition. New instances of a deleted process are created using
	// the lastest version that hasn't been deleted. Creating a new
	// process instance is impossible when all versions have been
	// deleted.
	//
	// Deleting a decision requirement definitions could cause incidents in process
	// instances referencing these decisions in a business rule task. A decision
	// will be evaluated with the latest version that hasn't been deleted. If all
	// versions of a decision have been deleted the evaluation is rejected.
	//
	// Errors:
	// NOT_FOUND:
	// - No resource exists with the given key
	DeleteResource(ctx context.Context, in *DeleteResourceRequest, opts ...grpc.CallOption) (*DeleteResourceResponse, error)
	// Broadcasts a signal.
	BroadcastSignal(ctx context.Context, in *BroadcastSignalRequest, opts ...grpc.CallOption) (*BroadcastSignalResponse, error)
}

GatewayClient is the client API for Gateway service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewGatewayClient 

func NewGatewayClient(cc grpc.ClientConnInterface) GatewayClient

type GatewayServer 

type GatewayServer interface {
	// Iterates through all known partitions round-robin and activates up to the requested
	// maximum and streams them back to the client as they are activated.
	//
	// Errors:
	// INVALID_ARGUMENT:
	// - type is blank (empty string, null)
	// - worker is blank (empty string, null)
	// - timeout less than 1
	// - maxJobsToActivate is less than 1
	ActivateJobs(*ActivateJobsRequest, Gateway_ActivateJobsServer) error
	// Registers client to a job stream that will stream jobs back to the client as
	// they become activatable.
	//
	// Errors:
	// INVALID_ARGUMENT:
	// - type is blank (empty string, null)
	// - timeout less than 1
	StreamActivatedJobs(*StreamActivatedJobsRequest, Gateway_StreamActivatedJobsServer) error
	// Cancels a running process instance
	//
	// Errors:
	// NOT_FOUND:
	// - no process instance exists with the given key
	CancelProcessInstance(context.Context, *CancelProcessInstanceRequest) (*CancelProcessInstanceResponse, error)
	// Completes a job with the given variables, which allows completing the associated service task.
	//
	// Errors:
	// NOT_FOUND:
	// - no job exists with the given job key. Note that since jobs are removed once completed,
	// it could be that this job did exist at some point.
	//
	// FAILED_PRECONDITION:
	// - the job was marked as failed. In that case, the related incident must be resolved before
	// the job can be activated again and completed.
	CompleteJob(context.Context, *CompleteJobRequest) (*CompleteJobResponse, error)
	// Creates and starts an instance of the specified process. The process definition to use to
	// create the instance can be specified either using its unique key (as returned by
	// DeployProcess), or using the BPMN process ID and a version. Pass -1 as the version to use the
	// latest deployed version. Note that only processes with none start events can be started through
	// this command.
	//
	// Errors:
	// NOT_FOUND:
	// - no process with the given key exists (if processDefinitionKey was given)
	// - no process with the given process ID exists (if bpmnProcessId was given but version was -1)
	// - no process with the given process ID and version exists (if both bpmnProcessId and version were given)
	//
	// FAILED_PRECONDITION:
	// - the process definition does not contain a none start event; only processes with none
	// start event can be started manually.
	//
	// INVALID_ARGUMENT:
	// - the given variables argument is not a valid JSON document; it is expected to be a valid
	// JSON document where the root node is an object.
	CreateProcessInstance(context.Context, *CreateProcessInstanceRequest) (*CreateProcessInstanceResponse, error)
	// Behaves similarly to `rpc CreateProcessInstance`, except that a successful response is received when the process completes successfully.
	CreateProcessInstanceWithResult(context.Context, *CreateProcessInstanceWithResultRequest) (*CreateProcessInstanceWithResultResponse, error)
	// Evaluates a decision. The decision to evaluate can be specified either by
	// using its unique key (as returned by DeployResource), or using the decision
	// ID. When using the decision ID, the latest deployed version of the decision
	// is used.
	//
	// Errors:
	// INVALID_ARGUMENT:
	// - no decision with the given key exists (if decisionKey was given)
	// - no decision with the given decision ID exists (if decisionId was given)
	// - both decision ID and decision KEY were provided, or are missing
	EvaluateDecision(context.Context, *EvaluateDecisionRequest) (*EvaluateDecisionResponse, error)
	// Deprecated: Do not use.
	//
	// Deploys one or more processes to Zeebe. Note that this is an atomic call,
	// i.e. either all processes are deployed, or none of them are.
	//
	// Errors:
	// INVALID_ARGUMENT:
	// - no resources given.
	// - if at least one resource is invalid. A resource is considered invalid if:
	// - the resource data is not deserializable (e.g. detected as BPMN, but it's broken XML)
	// - the process is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
	DeployProcess(context.Context, *DeployProcessRequest) (*DeployProcessResponse, error)
	// Deploys one or more resources (e.g. processes or decision models) to Zeebe.
	// Note that this is an atomic call, i.e. either all resources are deployed, or none of them are.
	//
	// Errors:
	// PERMISSION_DENIED:
	// - if a deployment to an unauthorized tenant is performed
	// INVALID_ARGUMENT:
	// - no resources given.
	// - if at least one resource is invalid. A resource is considered invalid if:
	// - the content is not deserializable (e.g. detected as BPMN, but it's broken XML)
	// - the content is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)
	// - if multi-tenancy is enabled, and:
	// - a tenant id is not provided
	// - a tenant id with an invalid format is provided
	// - if multi-tenancy is disabled and a tenant id is provided
	DeployResource(context.Context, *DeployResourceRequest) (*DeployResourceResponse, error)
	// Marks the job as failed; if the retries argument is positive, then the job will be immediately
	// activatable again, and a worker could try again to process it. If it is zero or negative however,
	// an incident will be raised, tagged with the given errorMessage, and the job will not be
	// activatable until the incident is resolved.
	//
	// Errors:
	// NOT_FOUND:
	// - no job was found with the given key
	//
	// FAILED_PRECONDITION:
	// - the job was not activated
	// - the job is already in a failed state, i.e. ran out of retries
	FailJob(context.Context, *FailJobRequest) (*FailJobResponse, error)
	// Reports a business error (i.e. non-technical) that occurs while processing a job. The error is handled in the process by an error catch event. If there is no error catch event with the specified errorCode then an incident will be raised instead.
	//
	// Errors:
	// NOT_FOUND:
	// - no job was found with the given key
	//
	// FAILED_PRECONDITION:
	// - the job is not in an activated state
	ThrowError(context.Context, *ThrowErrorRequest) (*ThrowErrorResponse, error)
	// Publishes a single message. Messages are published to specific partitions computed from their
	// correlation keys.
	//
	// Errors:
	// ALREADY_EXISTS:
	// - a message with the same ID was previously published (and is still alive)
	PublishMessage(context.Context, *PublishMessageRequest) (*PublishMessageResponse, error)
	// Resolves a given incident. This simply marks the incident as resolved; most likely a call to
	// UpdateJobRetries or SetVariables will be necessary to actually resolve the
	// problem, following by this call.
	//
	// Errors:
	// NOT_FOUND:
	// - no incident with the given key exists
	ResolveIncident(context.Context, *ResolveIncidentRequest) (*ResolveIncidentResponse, error)
	// Updates all the variables of a particular scope (e.g. process instance, flow element instance)
	// from the given JSON document.
	//
	// Errors:
	// NOT_FOUND:
	// - no element with the given elementInstanceKey exists
	// INVALID_ARGUMENT:
	// - the given variables document is not a valid JSON document; valid documents are expected to
	// be JSON documents where the root node is an object.
	SetVariables(context.Context, *SetVariablesRequest) (*SetVariablesResponse, error)
	// Obtains the current topology of the cluster the gateway is part of.
	Topology(context.Context, *TopologyRequest) (*TopologyResponse, error)
	// Updates the number of retries a job has left. This is mostly useful for jobs that have run out of
	// retries, should the underlying problem be solved.
	//
	// Errors:
	// NOT_FOUND:
	// - no job exists with the given key
	//
	// INVALID_ARGUMENT:
	// - retries is not greater than 0
	UpdateJobRetries(context.Context, *UpdateJobRetriesRequest) (*UpdateJobRetriesResponse, error)
	// Modifies the process instance. This is done by activating and/or terminating specific elements of the instance.
	//
	// Errors:
	// NOT_FOUND:
	// - no process instance exists with the given key
	//
	// FAILED_PRECONDITION:
	// - trying to activate element inside of a multi-instance
	//
	// INVALID_ARGUMENT:
	// - activating or terminating unknown element
	// - ancestor of element for activation doesn't exist
	// - scope of variable is unknown
	ModifyProcessInstance(context.Context, *ModifyProcessInstanceRequest) (*ModifyProcessInstanceResponse, error)
	// Migrates the process instance to the specified process definition.
	// In simple terms, this is handled by updating the active element's process.
	//
	// Errors:
	// NOT_FOUND:
	// - the process instance referenced by `processInstanceKey` is not active
	//
	// FAILED_PRECONDITION:
	// - not all active elements in the source process instance are mapped to the elements in the target process
	// - a mapping instruction changes the type of an element or event
	// - a mapping instruction refers to an unsupported element (i.e. some elements will be supported later on)
	// - a mapping instruction refers to element in unsupported scenarios.
	// (i.e. migrating active elements with event subscriptions will be supported later on)
	//
	// INVALID_ARGUMENT:
	// - the source element id does not refer to an element in the source process definition
	// - a source element id is mapped by multiple mapping instructions.
	// For example, the engine cannot determine how to migrate a process instance when the instructions are: [A->B, A->C].
	MigrateProcessInstance(context.Context, *MigrateProcessInstanceRequest) (*MigrateProcessInstanceResponse, error)
	// Updates the deadline of a job using the timeout (in ms) provided. This can be used
	// for extending or shortening the job deadline.
	//
	// Errors:
	// NOT_FOUND:
	// - no job exists with the given key
	//
	// INVALID_STATE:
	// - no deadline exists for the given job key
	UpdateJobTimeout(context.Context, *UpdateJobTimeoutRequest) (*UpdateJobTimeoutResponse, error)
	// Deletes a resource from the state. Once a resource has been deleted it cannot
	// be recovered. If the resource needs to be available again, a new deployment
	// of the resource is required.
	//
	// Deleting a process will cancel any running instances of this process
	// definition. New instances of a deleted process are created using
	// the lastest version that hasn't been deleted. Creating a new
	// process instance is impossible when all versions have been
	// deleted.
	//
	// Deleting a decision requirement definitions could cause incidents in process
	// instances referencing these decisions in a business rule task. A decision
	// will be evaluated with the latest version that hasn't been deleted. If all
	// versions of a decision have been deleted the evaluation is rejected.
	//
	// Errors:
	// NOT_FOUND:
	// - No resource exists with the given key
	DeleteResource(context.Context, *DeleteResourceRequest) (*DeleteResourceResponse, error)
	// Broadcasts a signal.
	BroadcastSignal(context.Context, *BroadcastSignalRequest) (*BroadcastSignalResponse, error)
}

GatewayServer is the server API for Gateway service.

type Gateway_ActivateJobsClient 

type Gateway_ActivateJobsClient interface {
	Recv() (*ActivateJobsResponse, error)
	grpc.ClientStream
}

type Gateway_ActivateJobsServer 

type Gateway_ActivateJobsServer interface {
	Send(*ActivateJobsResponse) error
	grpc.ServerStream
}

type Gateway_StreamActivatedJobsClient added in v8.4.0 

type Gateway_StreamActivatedJobsClient interface {
	Recv() (*ActivatedJob, error)
	grpc.ClientStream
}

type Gateway_StreamActivatedJobsServer added in v8.4.0 

type Gateway_StreamActivatedJobsServer interface {
	Send(*ActivatedJob) error
	grpc.ServerStream
}

type MatchedDecisionRule added in v8.2.0 

type MatchedDecisionRule struct {

	// the id of the matched rule
	RuleId string `protobuf:"bytes,1,opt,name=ruleId,proto3" json:"ruleId,omitempty"`
	// the index of the matched rule
	RuleIndex int32 `protobuf:"varint,2,opt,name=ruleIndex,proto3" json:"ruleIndex,omitempty"`
	// the evaluated decision outputs
	EvaluatedOutputs []*EvaluatedDecisionOutput `protobuf:"bytes,3,rep,name=evaluatedOutputs,proto3" json:"evaluatedOutputs,omitempty"`
	// contains filtered or unexported fields
}

func (*MatchedDecisionRule) Descriptor deprecated added in v8.2.0 

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

Deprecated: Use MatchedDecisionRule.ProtoReflect.Descriptor instead.

func (*MatchedDecisionRule) GetEvaluatedOutputs added in v8.2.0 

func (x *MatchedDecisionRule) GetEvaluatedOutputs() []*EvaluatedDecisionOutput

func (*MatchedDecisionRule) GetRuleId added in v8.2.0 

func (x *MatchedDecisionRule) GetRuleId() string

func (*MatchedDecisionRule) GetRuleIndex added in v8.2.0 

func (x *MatchedDecisionRule) GetRuleIndex() int32

func (*MatchedDecisionRule) ProtoMessage added in v8.2.0 

func (*MatchedDecisionRule) ProtoMessage()

func (*MatchedDecisionRule) ProtoReflect added in v8.2.0 

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

func (*MatchedDecisionRule) Reset added in v8.2.0 

func (x *MatchedDecisionRule) Reset()

func (*MatchedDecisionRule) String added in v8.2.0 

func (x *MatchedDecisionRule) String() string

type MigrateProcessInstanceRequest added in v8.4.0 

type MigrateProcessInstanceRequest struct {

	// key of the process instance to migrate
	ProcessInstanceKey int64 `protobuf:"varint,1,opt,name=processInstanceKey,proto3" json:"processInstanceKey,omitempty"`
	// the migration plan that defines target process and element mappings
	MigrationPlan *MigrateProcessInstanceRequest_MigrationPlan `protobuf:"bytes,2,opt,name=migrationPlan,proto3" json:"migrationPlan,omitempty"`
	// contains filtered or unexported fields
}

func (*MigrateProcessInstanceRequest) Descriptor deprecated added in v8.4.0 

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

Deprecated: Use MigrateProcessInstanceRequest.ProtoReflect.Descriptor instead.

func (*MigrateProcessInstanceRequest) GetMigrationPlan added in v8.4.0 

func (x *MigrateProcessInstanceRequest) GetMigrationPlan() *MigrateProcessInstanceRequest_MigrationPlan

func (*MigrateProcessInstanceRequest) GetProcessInstanceKey added in v8.4.0 

func (x *MigrateProcessInstanceRequest) GetProcessInstanceKey() int64

func (*MigrateProcessInstanceRequest) ProtoMessage added in v8.4.0 

func (*MigrateProcessInstanceRequest) ProtoMessage()

func (*MigrateProcessInstanceRequest) ProtoReflect added in v8.4.0 

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

func (*MigrateProcessInstanceRequest) Reset added in v8.4.0 

func (x *MigrateProcessInstanceRequest) Reset()

func (*MigrateProcessInstanceRequest) String added in v8.4.0 

func (x *MigrateProcessInstanceRequest) String() string

type MigrateProcessInstanceRequest_MappingInstruction added in v8.4.0 

type MigrateProcessInstanceRequest_MappingInstruction struct {

	// the element id to migrate from
	SourceElementId string `protobuf:"bytes,1,opt,name=sourceElementId,proto3" json:"sourceElementId,omitempty"`
	// the element id to migrate into
	TargetElementId string `protobuf:"bytes,2,opt,name=targetElementId,proto3" json:"targetElementId,omitempty"`
	// contains filtered or unexported fields
}

func (*MigrateProcessInstanceRequest_MappingInstruction) Descriptor deprecated added in v8.4.0 

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

Deprecated: Use MigrateProcessInstanceRequest_MappingInstruction.ProtoReflect.Descriptor instead.

func (*MigrateProcessInstanceRequest_MappingInstruction) GetSourceElementId added in v8.4.0 

func (x *MigrateProcessInstanceRequest_MappingInstruction) GetSourceElementId() string

func (*MigrateProcessInstanceRequest_MappingInstruction) GetTargetElementId added in v8.4.0 

func (x *MigrateProcessInstanceRequest_MappingInstruction) GetTargetElementId() string

func (*MigrateProcessInstanceRequest_MappingInstruction) ProtoMessage added in v8.4.0 

func (*MigrateProcessInstanceRequest_MappingInstruction) ProtoMessage()

func (*MigrateProcessInstanceRequest_MappingInstruction) ProtoReflect added in v8.4.0 

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

func (*MigrateProcessInstanceRequest_MappingInstruction) Reset added in v8.4.0 

func (x *MigrateProcessInstanceRequest_MappingInstruction) Reset()

func (*MigrateProcessInstanceRequest_MappingInstruction) String added in v8.4.0 

func (x *MigrateProcessInstanceRequest_MappingInstruction) String() string

type MigrateProcessInstanceRequest_MigrationPlan added in v8.4.0 

type MigrateProcessInstanceRequest_MigrationPlan struct {

	// the key of process definition to migrate the process instance to
	TargetProcessDefinitionKey int64 `protobuf:"varint,1,opt,name=targetProcessDefinitionKey,proto3" json:"targetProcessDefinitionKey,omitempty"`
	// the mapping instructions describe how to map elements from the source process definition to the target process definition
	MappingInstructions []*MigrateProcessInstanceRequest_MappingInstruction `protobuf:"bytes,2,rep,name=mappingInstructions,proto3" json:"mappingInstructions,omitempty"`
	// contains filtered or unexported fields
}

func (*MigrateProcessInstanceRequest_MigrationPlan) Descriptor deprecated added in v8.4.0 

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

Deprecated: Use MigrateProcessInstanceRequest_MigrationPlan.ProtoReflect.Descriptor instead.

func (*MigrateProcessInstanceRequest_MigrationPlan) GetMappingInstructions added in v8.4.0 

func (x *MigrateProcessInstanceRequest_MigrationPlan) GetMappingInstructions() []*MigrateProcessInstanceRequest_MappingInstruction

func (*MigrateProcessInstanceRequest_MigrationPlan) GetTargetProcessDefinitionKey added in v8.4.0 

func (x *MigrateProcessInstanceRequest_MigrationPlan) GetTargetProcessDefinitionKey() int64

func (*MigrateProcessInstanceRequest_MigrationPlan) ProtoMessage added in v8.4.0 

func (*MigrateProcessInstanceRequest_MigrationPlan) ProtoMessage()

func (*MigrateProcessInstanceRequest_MigrationPlan) ProtoReflect added in v8.4.0 

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

func (*MigrateProcessInstanceRequest_MigrationPlan) Reset added in v8.4.0 

func (x *MigrateProcessInstanceRequest_MigrationPlan) Reset()

func (*MigrateProcessInstanceRequest_MigrationPlan) String added in v8.4.0 

func (x *MigrateProcessInstanceRequest_MigrationPlan) String() string

type MigrateProcessInstanceResponse added in v8.4.0 

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

func (*MigrateProcessInstanceResponse) Descriptor deprecated added in v8.4.0 

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

Deprecated: Use MigrateProcessInstanceResponse.ProtoReflect.Descriptor instead.

func (*MigrateProcessInstanceResponse) ProtoMessage added in v8.4.0 

func (*MigrateProcessInstanceResponse) ProtoMessage()

func (*MigrateProcessInstanceResponse) ProtoReflect added in v8.4.0 

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

func (*MigrateProcessInstanceResponse) Reset added in v8.4.0 

func (x *MigrateProcessInstanceResponse) Reset()

func (*MigrateProcessInstanceResponse) String added in v8.4.0 

func (x *MigrateProcessInstanceResponse) String() string

type ModifyProcessInstanceRequest added in v8.2.0 

type ModifyProcessInstanceRequest struct {

	// the key of the process instance that should be modified
	ProcessInstanceKey int64 `protobuf:"varint,1,opt,name=processInstanceKey,proto3" json:"processInstanceKey,omitempty"`
	// instructions describing which elements should be activated in which scopes,
	// and which variables should be created
	ActivateInstructions []*ModifyProcessInstanceRequest_ActivateInstruction `protobuf:"bytes,2,rep,name=activateInstructions,proto3" json:"activateInstructions,omitempty"`
	// instructions describing which elements should be terminated
	TerminateInstructions []*ModifyProcessInstanceRequest_TerminateInstruction `protobuf:"bytes,3,rep,name=terminateInstructions,proto3" json:"terminateInstructions,omitempty"`
	// contains filtered or unexported fields
}

func (*ModifyProcessInstanceRequest) Descriptor deprecated added in v8.2.0 

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

Deprecated: Use ModifyProcessInstanceRequest.ProtoReflect.Descriptor instead.

func (*ModifyProcessInstanceRequest) GetActivateInstructions added in v8.2.0 

func (x *ModifyProcessInstanceRequest) GetActivateInstructions() []*ModifyProcessInstanceRequest_ActivateInstruction

func (*ModifyProcessInstanceRequest) GetProcessInstanceKey added in v8.2.0 

func (x *ModifyProcessInstanceRequest) GetProcessInstanceKey() int64

func (*ModifyProcessInstanceRequest) GetTerminateInstructions added in v8.2.0 

func (x *ModifyProcessInstanceRequest) GetTerminateInstructions() []*ModifyProcessInstanceRequest_TerminateInstruction

func (*ModifyProcessInstanceRequest) ProtoMessage added in v8.2.0 

func (*ModifyProcessInstanceRequest) ProtoMessage()

func (*ModifyProcessInstanceRequest) ProtoReflect added in v8.2.0 

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

func (*ModifyProcessInstanceRequest) Reset added in v8.2.0 

func (x *ModifyProcessInstanceRequest) Reset()

func (*ModifyProcessInstanceRequest) String added in v8.2.0 

func (x *ModifyProcessInstanceRequest) String() string

type ModifyProcessInstanceRequest_ActivateInstruction added in v8.2.0 

type ModifyProcessInstanceRequest_ActivateInstruction struct {

	// the id of the element that should be activated
	ElementId string `protobuf:"bytes,1,opt,name=elementId,proto3" json:"elementId,omitempty"`
	// the key of the ancestor scope the element instance should be created in;
	// set to -1 to create the new element instance within an existing element
	// instance of the flow scope
	AncestorElementInstanceKey int64 `protobuf:"varint,2,opt,name=ancestorElementInstanceKey,proto3" json:"ancestorElementInstanceKey,omitempty"`
	// instructions describing which variables should be created
	VariableInstructions []*ModifyProcessInstanceRequest_VariableInstruction `protobuf:"bytes,3,rep,name=variableInstructions,proto3" json:"variableInstructions,omitempty"`
	// contains filtered or unexported fields
}

func (*ModifyProcessInstanceRequest_ActivateInstruction) Descriptor deprecated added in v8.2.0 

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

Deprecated: Use ModifyProcessInstanceRequest_ActivateInstruction.ProtoReflect.Descriptor instead.

func (*ModifyProcessInstanceRequest_ActivateInstruction) GetAncestorElementInstanceKey added in v8.2.0 

func (x *ModifyProcessInstanceRequest_ActivateInstruction) GetAncestorElementInstanceKey() int64

func (*ModifyProcessInstanceRequest_ActivateInstruction) GetElementId added in v8.2.0 

func (x *ModifyProcessInstanceRequest_ActivateInstruction) GetElementId() string

func (*ModifyProcessInstanceRequest_ActivateInstruction) GetVariableInstructions added in v8.2.0 

func (x *ModifyProcessInstanceRequest_ActivateInstruction) GetVariableInstructions() []*ModifyProcessInstanceRequest_VariableInstruction

func (*ModifyProcessInstanceRequest_ActivateInstruction) ProtoMessage added in v8.2.0 

func (*ModifyProcessInstanceRequest_ActivateInstruction) ProtoMessage()

func (*ModifyProcessInstanceRequest_ActivateInstruction) ProtoReflect added in v8.2.0 

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

func (*ModifyProcessInstanceRequest_ActivateInstruction) Reset added in v8.2.0 

func (x *ModifyProcessInstanceRequest_ActivateInstruction) Reset()

func (*ModifyProcessInstanceRequest_ActivateInstruction) String added in v8.2.0 

func (x *ModifyProcessInstanceRequest_ActivateInstruction) String() string

type ModifyProcessInstanceRequest_TerminateInstruction added in v8.2.0 

type ModifyProcessInstanceRequest_TerminateInstruction struct {

	// the id of the element that should be terminated
	ElementInstanceKey int64 `protobuf:"varint,1,opt,name=elementInstanceKey,proto3" json:"elementInstanceKey,omitempty"`
	// contains filtered or unexported fields
}

func (*ModifyProcessInstanceRequest_TerminateInstruction) Descriptor deprecated added in v8.2.0 

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

Deprecated: Use ModifyProcessInstanceRequest_TerminateInstruction.ProtoReflect.Descriptor instead.

func (*ModifyProcessInstanceRequest_TerminateInstruction) GetElementInstanceKey added in v8.2.0 

func (x *ModifyProcessInstanceRequest_TerminateInstruction) GetElementInstanceKey() int64

func (*ModifyProcessInstanceRequest_TerminateInstruction) ProtoMessage added in v8.2.0 

func (*ModifyProcessInstanceRequest_TerminateInstruction) ProtoMessage()

func (*ModifyProcessInstanceRequest_TerminateInstruction) ProtoReflect added in v8.2.0 

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

func (*ModifyProcessInstanceRequest_TerminateInstruction) Reset added in v8.2.0 

func (x *ModifyProcessInstanceRequest_TerminateInstruction) Reset()

func (*ModifyProcessInstanceRequest_TerminateInstruction) String added in v8.2.0 

func (x *ModifyProcessInstanceRequest_TerminateInstruction) String() string

type ModifyProcessInstanceRequest_VariableInstruction added in v8.2.0 

type ModifyProcessInstanceRequest_VariableInstruction struct {

	// JSON document that will instantiate the variables for the root variable scope of the
	// process instance; it must be a JSON object, as variables will be mapped in a
	// key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
	// "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
	// valid argument, as the root of the JSON document is an array and not an object.
	Variables string `protobuf:"bytes,1,opt,name=variables,proto3" json:"variables,omitempty"`
	// the id of the element in which scope the variables should be created;
	// leave empty to create the variables in the global scope of the process instance
	ScopeId string `protobuf:"bytes,2,opt,name=scopeId,proto3" json:"scopeId,omitempty"`
	// contains filtered or unexported fields
}

func (*ModifyProcessInstanceRequest_VariableInstruction) Descriptor deprecated added in v8.2.0 

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

Deprecated: Use ModifyProcessInstanceRequest_VariableInstruction.ProtoReflect.Descriptor instead.

func (*ModifyProcessInstanceRequest_VariableInstruction) GetScopeId added in v8.2.0 

func (x *ModifyProcessInstanceRequest_VariableInstruction) GetScopeId() string

func (*ModifyProcessInstanceRequest_VariableInstruction) GetVariables added in v8.2.0 

func (x *ModifyProcessInstanceRequest_VariableInstruction) GetVariables() string

func (*ModifyProcessInstanceRequest_VariableInstruction) ProtoMessage added in v8.2.0 

func (*ModifyProcessInstanceRequest_VariableInstruction) ProtoMessage()

func (*ModifyProcessInstanceRequest_VariableInstruction) ProtoReflect added in v8.2.0 

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

func (*ModifyProcessInstanceRequest_VariableInstruction) Reset added in v8.2.0 

func (x *ModifyProcessInstanceRequest_VariableInstruction) Reset()

func (*ModifyProcessInstanceRequest_VariableInstruction) String added in v8.2.0 

func (x *ModifyProcessInstanceRequest_VariableInstruction) String() string

type ModifyProcessInstanceResponse added in v8.2.0 

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

func (*ModifyProcessInstanceResponse) Descriptor deprecated added in v8.2.0 

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

Deprecated: Use ModifyProcessInstanceResponse.ProtoReflect.Descriptor instead.

func (*ModifyProcessInstanceResponse) ProtoMessage added in v8.2.0 

func (*ModifyProcessInstanceResponse) ProtoMessage()

func (*ModifyProcessInstanceResponse) ProtoReflect added in v8.2.0 

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

func (*ModifyProcessInstanceResponse) Reset added in v8.2.0 

func (x *ModifyProcessInstanceResponse) Reset()

func (*ModifyProcessInstanceResponse) String added in v8.2.0 

func (x *ModifyProcessInstanceResponse) String() string

type Partition 

type Partition struct {

	// the unique ID of this partition
	PartitionId int32 `protobuf:"varint,1,opt,name=partitionId,proto3" json:"partitionId,omitempty"`
	// the role of the broker for this partition
	Role Partition_PartitionBrokerRole `protobuf:"varint,2,opt,name=role,proto3,enum=gateway_protocol.Partition_PartitionBrokerRole" json:"role,omitempty"`
	// the health of this partition
	Health Partition_PartitionBrokerHealth `protobuf:"varint,3,opt,name=health,proto3,enum=gateway_protocol.Partition_PartitionBrokerHealth" json:"health,omitempty"`
	// contains filtered or unexported fields
}

func (*Partition) Descriptor deprecated 

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

Deprecated: Use Partition.ProtoReflect.Descriptor instead.

func (*Partition) GetHealth 

func (x *Partition) GetHealth() Partition_PartitionBrokerHealth

func (*Partition) GetPartitionId 

func (x *Partition) GetPartitionId() int32

func (*Partition) GetRole 

func (x *Partition) GetRole() Partition_PartitionBrokerRole

func (*Partition) ProtoMessage 

func (*Partition) ProtoMessage()

func (*Partition) ProtoReflect 

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

func (*Partition) Reset 

func (x *Partition) Reset()

func (*Partition) String 

func (x *Partition) String() string

type Partition_PartitionBrokerHealth 

type Partition_PartitionBrokerHealth int32

Describes the current health of the partition 

const (
	Partition_HEALTHY   Partition_PartitionBrokerHealth = 0
	Partition_UNHEALTHY Partition_PartitionBrokerHealth = 1
	Partition_DEAD      Partition_PartitionBrokerHealth = 2
)

func (Partition_PartitionBrokerHealth) Descriptor 

func (Partition_PartitionBrokerHealth) Descriptor() protoreflect.EnumDescriptor

func (Partition_PartitionBrokerHealth) Enum 

func (x Partition_PartitionBrokerHealth) Enum() *Partition_PartitionBrokerHealth

func (Partition_PartitionBrokerHealth) EnumDescriptor deprecated 

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

Deprecated: Use Partition_PartitionBrokerHealth.Descriptor instead.

func (Partition_PartitionBrokerHealth) Number 

func (x Partition_PartitionBrokerHealth) Number() protoreflect.EnumNumber

func (Partition_PartitionBrokerHealth) String 

func (x Partition_PartitionBrokerHealth) String() string

func (Partition_PartitionBrokerHealth) Type 

func (Partition_PartitionBrokerHealth) Type() protoreflect.EnumType

type Partition_PartitionBrokerRole 

type Partition_PartitionBrokerRole int32

Describes the Raft role of the broker for a given partition 

const (
	Partition_LEADER   Partition_PartitionBrokerRole = 0
	Partition_FOLLOWER Partition_PartitionBrokerRole = 1
	Partition_INACTIVE Partition_PartitionBrokerRole = 2
)

func (Partition_PartitionBrokerRole) Descriptor 

func (Partition_PartitionBrokerRole) Descriptor() protoreflect.EnumDescriptor

func (Partition_PartitionBrokerRole) Enum 

func (x Partition_PartitionBrokerRole) Enum() *Partition_PartitionBrokerRole

func (Partition_PartitionBrokerRole) EnumDescriptor deprecated 

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

Deprecated: Use Partition_PartitionBrokerRole.Descriptor instead.

func (Partition_PartitionBrokerRole) Number 

func (x Partition_PartitionBrokerRole) Number() protoreflect.EnumNumber

func (Partition_PartitionBrokerRole) String 

func (x Partition_PartitionBrokerRole) String() string

func (Partition_PartitionBrokerRole) Type 

func (Partition_PartitionBrokerRole) Type() protoreflect.EnumType

type ProcessInstanceCreationStartInstruction added in v8.0.15 

type ProcessInstanceCreationStartInstruction struct {

	// element ID
	ElementId string `protobuf:"bytes,1,opt,name=elementId,proto3" json:"elementId,omitempty"`
	// contains filtered or unexported fields
}

func (*ProcessInstanceCreationStartInstruction) Descriptor deprecated added in v8.0.15 

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

Deprecated: Use ProcessInstanceCreationStartInstruction.ProtoReflect.Descriptor instead.

func (*ProcessInstanceCreationStartInstruction) GetElementId added in v8.0.15 

func (x *ProcessInstanceCreationStartInstruction) GetElementId() string

func (*ProcessInstanceCreationStartInstruction) ProtoMessage added in v8.0.15 

func (*ProcessInstanceCreationStartInstruction) ProtoMessage()

func (*ProcessInstanceCreationStartInstruction) ProtoReflect added in v8.0.15 

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

func (*ProcessInstanceCreationStartInstruction) Reset added in v8.0.15 

func (x *ProcessInstanceCreationStartInstruction) Reset()

func (*ProcessInstanceCreationStartInstruction) String added in v8.0.15 

func (x *ProcessInstanceCreationStartInstruction) String() string

type ProcessMetadata 

type ProcessMetadata struct {

	// the bpmn process ID, as parsed during deployment; together with the version forms a
	// unique identifier for a specific process definition
	BpmnProcessId string `protobuf:"bytes,1,opt,name=bpmnProcessId,proto3" json:"bpmnProcessId,omitempty"`
	// the assigned process version
	Version int32 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	// the assigned key, which acts as a unique identifier for this process
	ProcessDefinitionKey int64 `protobuf:"varint,3,opt,name=processDefinitionKey,proto3" json:"processDefinitionKey,omitempty"`
	// the resource name (see: ProcessRequestObject.name) from which this process was
	// parsed
	ResourceName string `protobuf:"bytes,4,opt,name=resourceName,proto3" json:"resourceName,omitempty"`
	// the tenant id of the deployed process
	TenantId string `protobuf:"bytes,5,opt,name=tenantId,proto3" json:"tenantId,omitempty"`
	// contains filtered or unexported fields
}

func (*ProcessMetadata) Descriptor deprecated 

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

Deprecated: Use ProcessMetadata.ProtoReflect.Descriptor instead.

func (*ProcessMetadata) GetBpmnProcessId 

func (x *ProcessMetadata) GetBpmnProcessId() string

func (*ProcessMetadata) GetProcessDefinitionKey 

func (x *ProcessMetadata) GetProcessDefinitionKey() int64

func (*ProcessMetadata) GetResourceName 

func (x *ProcessMetadata) GetResourceName() string

func (*ProcessMetadata) GetTenantId added in v8.4.0 

func (x *ProcessMetadata) GetTenantId() string

func (*ProcessMetadata) GetVersion 

func (x *ProcessMetadata) GetVersion() int32

func (*ProcessMetadata) ProtoMessage 

func (*ProcessMetadata) ProtoMessage()

func (*ProcessMetadata) ProtoReflect 

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

func (*ProcessMetadata) Reset 

func (x *ProcessMetadata) Reset()

func (*ProcessMetadata) String 

func (x *ProcessMetadata) String() string

type ProcessRequestObject deprecated 

type ProcessRequestObject struct {

	// the resource basename, e.g. myProcess.bpmn
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// the process definition as a UTF8-encoded string
	Definition []byte `protobuf:"bytes,2,opt,name=definition,proto3" json:"definition,omitempty"`
	// contains filtered or unexported fields
}

Deprecated: Do not use.

func (*ProcessRequestObject) Descriptor deprecated 

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

Deprecated: Use ProcessRequestObject.ProtoReflect.Descriptor instead.

func (*ProcessRequestObject) GetDefinition 

func (x *ProcessRequestObject) GetDefinition() []byte

func (*ProcessRequestObject) GetName 

func (x *ProcessRequestObject) GetName() string

func (*ProcessRequestObject) ProtoMessage 

func (*ProcessRequestObject) ProtoMessage()

func (*ProcessRequestObject) ProtoReflect 

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

func (*ProcessRequestObject) Reset 

func (x *ProcessRequestObject) Reset()

func (*ProcessRequestObject) String 

func (x *ProcessRequestObject) String() string

type PublishMessageRequest 

type PublishMessageRequest struct {

	// the name of the message
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// the correlation key of the message
	CorrelationKey string `protobuf:"bytes,2,opt,name=correlationKey,proto3" json:"correlationKey,omitempty"`
	// how long the message should be buffered on the broker, in milliseconds
	TimeToLive int64 `protobuf:"varint,3,opt,name=timeToLive,proto3" json:"timeToLive,omitempty"`
	// the unique ID of the message; can be omitted. only useful to ensure only one message
	// with the given ID will ever be published (during its lifetime)
	MessageId string `protobuf:"bytes,4,opt,name=messageId,proto3" json:"messageId,omitempty"`
	// the message variables as a JSON document; to be valid, the root of the document must be an
	// object, e.g. { "a": "foo" }. [ "foo" ] would not be valid.
	Variables string `protobuf:"bytes,5,opt,name=variables,proto3" json:"variables,omitempty"`
	// the tenant id of the message
	TenantId string `protobuf:"bytes,6,opt,name=tenantId,proto3" json:"tenantId,omitempty"`
	// contains filtered or unexported fields
}

func (*PublishMessageRequest) Descriptor deprecated 

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

Deprecated: Use PublishMessageRequest.ProtoReflect.Descriptor instead.

func (*PublishMessageRequest) GetCorrelationKey 

func (x *PublishMessageRequest) GetCorrelationKey() string

func (*PublishMessageRequest) GetMessageId 

func (x *PublishMessageRequest) GetMessageId() string

func (*PublishMessageRequest) GetName 

func (x *PublishMessageRequest) GetName() string

func (*PublishMessageRequest) GetTenantId added in v8.4.0 

func (x *PublishMessageRequest) GetTenantId() string

func (*PublishMessageRequest) GetTimeToLive 

func (x *PublishMessageRequest) GetTimeToLive() int64

func (*PublishMessageRequest) GetVariables 

func (x *PublishMessageRequest) GetVariables() string

func (*PublishMessageRequest) ProtoMessage 

func (*PublishMessageRequest) ProtoMessage()

func (*PublishMessageRequest) ProtoReflect 

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

func (*PublishMessageRequest) Reset 

func (x *PublishMessageRequest) Reset()

func (*PublishMessageRequest) String 

func (x *PublishMessageRequest) String() string

type PublishMessageResponse 

type PublishMessageResponse struct {

	// the unique ID of the message that was published
	Key int64 `protobuf:"varint,1,opt,name=key,proto3" json:"key,omitempty"`
	// the tenant id of the message
	TenantId string `protobuf:"bytes,2,opt,name=tenantId,proto3" json:"tenantId,omitempty"`
	// contains filtered or unexported fields
}

func (*PublishMessageResponse) Descriptor deprecated 

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

Deprecated: Use PublishMessageResponse.ProtoReflect.Descriptor instead.

func (*PublishMessageResponse) GetKey 

func (x *PublishMessageResponse) GetKey() int64

func (*PublishMessageResponse) GetTenantId added in v8.4.0 

func (x *PublishMessageResponse) GetTenantId() string

func (*PublishMessageResponse) ProtoMessage 

func (*PublishMessageResponse) ProtoMessage()

func (*PublishMessageResponse) ProtoReflect 

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

func (*PublishMessageResponse) Reset 

func (x *PublishMessageResponse) Reset()

func (*PublishMessageResponse) String 

func (x *PublishMessageResponse) String() string

type ResolveIncidentRequest 

type ResolveIncidentRequest struct {

	// the unique ID of the incident to resolve
	IncidentKey int64 `protobuf:"varint,1,opt,name=incidentKey,proto3" json:"incidentKey,omitempty"`
	// contains filtered or unexported fields
}

func (*ResolveIncidentRequest) Descriptor deprecated 

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

Deprecated: Use ResolveIncidentRequest.ProtoReflect.Descriptor instead.

func (*ResolveIncidentRequest) GetIncidentKey 

func (x *ResolveIncidentRequest) GetIncidentKey() int64

func (*ResolveIncidentRequest) ProtoMessage 

func (*ResolveIncidentRequest) ProtoMessage()

func (*ResolveIncidentRequest) ProtoReflect 

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

func (*ResolveIncidentRequest) Reset 

func (x *ResolveIncidentRequest) Reset()

func (*ResolveIncidentRequest) String 

func (x *ResolveIncidentRequest) String() string

type ResolveIncidentResponse 

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

func (*ResolveIncidentResponse) Descriptor deprecated 

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

Deprecated: Use ResolveIncidentResponse.ProtoReflect.Descriptor instead.

func (*ResolveIncidentResponse) ProtoMessage 

func (*ResolveIncidentResponse) ProtoMessage()

func (*ResolveIncidentResponse) ProtoReflect 

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

func (*ResolveIncidentResponse) Reset 

func (x *ResolveIncidentResponse) Reset()

func (*ResolveIncidentResponse) String 

func (x *ResolveIncidentResponse) String() string

type Resource 

type Resource struct {

	// the resource name, e.g. myProcess.bpmn or myDecision.dmn
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// the file content as a UTF8-encoded string
	Content []byte `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

func (*Resource) Descriptor deprecated 

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

Deprecated: Use Resource.ProtoReflect.Descriptor instead.

func (*Resource) GetContent 

func (x *Resource) GetContent() []byte

func (*Resource) GetName 

func (x *Resource) GetName() string

func (*Resource) ProtoMessage 

func (*Resource) ProtoMessage()

func (*Resource) ProtoReflect 

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

func (*Resource) Reset 

func (x *Resource) Reset()

func (*Resource) String 

func (x *Resource) String() string

type SetVariablesRequest 

type SetVariablesRequest struct {

	// the unique identifier of a particular element; can be the process instance key (as
	// obtained during instance creation), or a given element, such as a service task (see
	// elementInstanceKey on the job message)
	ElementInstanceKey int64 `protobuf:"varint,1,opt,name=elementInstanceKey,proto3" json:"elementInstanceKey,omitempty"`
	// a JSON serialized document describing variables as key value pairs; the root of the document
	// must be an object
	Variables string `protobuf:"bytes,2,opt,name=variables,proto3" json:"variables,omitempty"`
	// if true, the variables will be merged strictly into the local scope (as indicated by
	// elementInstanceKey); this means the variables is not propagated to upper scopes.
	// for example, let's say we have two scopes, '1' and '2', with each having effective variables as:
	// 1 => `{ "foo" : 2 }`, and 2 => `{ "bar" : 1 }`. if we send an update request with
	// elementInstanceKey = 2, variables `{ "foo" : 5 }`, and local is true, then scope 1 will
	// be unchanged, and scope 2 will now be `{ "bar" : 1, "foo" 5 }`. if local was false, however,
	// then scope 1 would be `{ "foo": 5 }`, and scope 2 would be `{ "bar" : 1 }`.
	Local bool `protobuf:"varint,3,opt,name=local,proto3" json:"local,omitempty"`
	// contains filtered or unexported fields
}

func (*SetVariablesRequest) Descriptor deprecated 

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

Deprecated: Use SetVariablesRequest.ProtoReflect.Descriptor instead.

func (*SetVariablesRequest) GetElementInstanceKey 

func (x *SetVariablesRequest) GetElementInstanceKey() int64

func (*SetVariablesRequest) GetLocal 

func (x *SetVariablesRequest) GetLocal() bool

func (*SetVariablesRequest) GetVariables 

func (x *SetVariablesRequest) GetVariables() string

func (*SetVariablesRequest) ProtoMessage 

func (*SetVariablesRequest) ProtoMessage()

func (*SetVariablesRequest) ProtoReflect 

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

func (*SetVariablesRequest) Reset 

func (x *SetVariablesRequest) Reset()

func (*SetVariablesRequest) String 

func (x *SetVariablesRequest) String() string

type SetVariablesResponse 

type SetVariablesResponse struct {

	// the unique key of the set variables command
	Key int64 `protobuf:"varint,1,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

func (*SetVariablesResponse) Descriptor deprecated 

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

Deprecated: Use SetVariablesResponse.ProtoReflect.Descriptor instead.

func (*SetVariablesResponse) GetKey 

func (x *SetVariablesResponse) GetKey() int64

func (*SetVariablesResponse) ProtoMessage 

func (*SetVariablesResponse) ProtoMessage()

func (*SetVariablesResponse) ProtoReflect 

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

func (*SetVariablesResponse) Reset 

func (x *SetVariablesResponse) Reset()

func (*SetVariablesResponse) String 

func (x *SetVariablesResponse) String() string

type StreamActivatedJobsRequest added in v8.4.0 

type StreamActivatedJobsRequest struct {

	// the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition
	// type="payment-service" />)
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// the name of the worker activating the jobs, mostly used for logging purposes
	Worker string `protobuf:"bytes,2,opt,name=worker,proto3" json:"worker,omitempty"`
	// a job returned after this call will not be activated by another call until the
	// timeout (in ms) has been reached
	Timeout int64 `protobuf:"varint,3,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// a list of variables to fetch as the job variables; if empty, all visible variables at
	// the time of activation for the scope of the job will be returned
	FetchVariable []string `protobuf:"bytes,5,rep,name=fetchVariable,proto3" json:"fetchVariable,omitempty"`
	// a list of identifiers of tenants for which to stream jobs
	TenantIds []string `protobuf:"bytes,6,rep,name=tenantIds,proto3" json:"tenantIds,omitempty"`
	// contains filtered or unexported fields
}

func (*StreamActivatedJobsRequest) Descriptor deprecated added in v8.4.0 

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

Deprecated: Use StreamActivatedJobsRequest.ProtoReflect.Descriptor instead.

func (*StreamActivatedJobsRequest) GetFetchVariable added in v8.4.0 

func (x *StreamActivatedJobsRequest) GetFetchVariable() []string

func (*StreamActivatedJobsRequest) GetTenantIds added in v8.4.0 

func (x *StreamActivatedJobsRequest) GetTenantIds() []string

func (*StreamActivatedJobsRequest) GetTimeout added in v8.4.0 

func (x *StreamActivatedJobsRequest) GetTimeout() int64

func (*StreamActivatedJobsRequest) GetType added in v8.4.0 

func (x *StreamActivatedJobsRequest) GetType() string

func (*StreamActivatedJobsRequest) GetWorker added in v8.4.0 

func (x *StreamActivatedJobsRequest) GetWorker() string

func (*StreamActivatedJobsRequest) ProtoMessage added in v8.4.0 

func (*StreamActivatedJobsRequest) ProtoMessage()

func (*StreamActivatedJobsRequest) ProtoReflect added in v8.4.0 

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

func (*StreamActivatedJobsRequest) Reset added in v8.4.0 

func (x *StreamActivatedJobsRequest) Reset()

func (*StreamActivatedJobsRequest) String added in v8.4.0 

func (x *StreamActivatedJobsRequest) String() string

type ThrowErrorRequest 

type ThrowErrorRequest struct {

	// the unique job identifier, as obtained when activating the job
	JobKey int64 `protobuf:"varint,1,opt,name=jobKey,proto3" json:"jobKey,omitempty"`
	// the error code that will be matched with an error catch event
	ErrorCode string `protobuf:"bytes,2,opt,name=errorCode,proto3" json:"errorCode,omitempty"`
	// an optional error message that provides additional context
	ErrorMessage string `protobuf:"bytes,3,opt,name=errorMessage,proto3" json:"errorMessage,omitempty"`
	// JSON document that will instantiate the variables at the local scope of the
	// error catch event that catches the thrown error; it must be a JSON object, as variables will be mapped in a
	// key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and
	// "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a
	// valid argument, as the root of the JSON document is an array and not an object.
	Variables string `protobuf:"bytes,4,opt,name=variables,proto3" json:"variables,omitempty"`
	// contains filtered or unexported fields
}

func (*ThrowErrorRequest) Descriptor deprecated 

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

Deprecated: Use ThrowErrorRequest.ProtoReflect.Descriptor instead.

func (*ThrowErrorRequest) GetErrorCode 

func (x *ThrowErrorRequest) GetErrorCode() string

func (*ThrowErrorRequest) GetErrorMessage 

func (x *ThrowErrorRequest) GetErrorMessage() string

func (*ThrowErrorRequest) GetJobKey 

func (x *ThrowErrorRequest) GetJobKey() int64

func (*ThrowErrorRequest) GetVariables added in v8.2.0 

func (x *ThrowErrorRequest) GetVariables() string

func (*ThrowErrorRequest) ProtoMessage 

func (*ThrowErrorRequest) ProtoMessage()

func (*ThrowErrorRequest) ProtoReflect 

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

func (*ThrowErrorRequest) Reset 

func (x *ThrowErrorRequest) Reset()

func (*ThrowErrorRequest) String 

func (x *ThrowErrorRequest) String() string

type ThrowErrorResponse 

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

func (*ThrowErrorResponse) Descriptor deprecated 

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

Deprecated: Use ThrowErrorResponse.ProtoReflect.Descriptor instead.

func (*ThrowErrorResponse) ProtoMessage 

func (*ThrowErrorResponse) ProtoMessage()

func (*ThrowErrorResponse) ProtoReflect 

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

func (*ThrowErrorResponse) Reset 

func (x *ThrowErrorResponse) Reset()

func (*ThrowErrorResponse) String 

func (x *ThrowErrorResponse) String() string

type TopologyRequest 

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

func (*TopologyRequest) Descriptor deprecated 

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

Deprecated: Use TopologyRequest.ProtoReflect.Descriptor instead.

func (*TopologyRequest) ProtoMessage 

func (*TopologyRequest) ProtoMessage()

func (*TopologyRequest) ProtoReflect 

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

func (*TopologyRequest) Reset 

func (x *TopologyRequest) Reset()

func (*TopologyRequest) String 

func (x *TopologyRequest) String() string

type TopologyResponse 

type TopologyResponse struct {

	// list of brokers part of this cluster
	Brokers []*BrokerInfo `protobuf:"bytes,1,rep,name=brokers,proto3" json:"brokers,omitempty"`
	// how many nodes are in the cluster
	ClusterSize int32 `protobuf:"varint,2,opt,name=clusterSize,proto3" json:"clusterSize,omitempty"`
	// how many partitions are spread across the cluster
	PartitionsCount int32 `protobuf:"varint,3,opt,name=partitionsCount,proto3" json:"partitionsCount,omitempty"`
	// configured replication factor for this cluster
	ReplicationFactor int32 `protobuf:"varint,4,opt,name=replicationFactor,proto3" json:"replicationFactor,omitempty"`
	// gateway version
	GatewayVersion string `protobuf:"bytes,5,opt,name=gatewayVersion,proto3" json:"gatewayVersion,omitempty"`
	// contains filtered or unexported fields
}

func (*TopologyResponse) Descriptor deprecated 

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

Deprecated: Use TopologyResponse.ProtoReflect.Descriptor instead.

func (*TopologyResponse) GetBrokers 

func (x *TopologyResponse) GetBrokers() []*BrokerInfo

func (*TopologyResponse) GetClusterSize 

func (x *TopologyResponse) GetClusterSize() int32

func (*TopologyResponse) GetGatewayVersion 

func (x *TopologyResponse) GetGatewayVersion() string

func (*TopologyResponse) GetPartitionsCount 

func (x *TopologyResponse) GetPartitionsCount() int32

func (*TopologyResponse) GetReplicationFactor 

func (x *TopologyResponse) GetReplicationFactor() int32

func (*TopologyResponse) ProtoMessage 

func (*TopologyResponse) ProtoMessage()

func (*TopologyResponse) ProtoReflect 

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

func (*TopologyResponse) Reset 

func (x *TopologyResponse) Reset()

func (*TopologyResponse) String 

func (x *TopologyResponse) String() string

type UnimplementedGatewayServer 

type UnimplementedGatewayServer struct {
}

UnimplementedGatewayServer can be embedded to have forward compatible implementations.

func (*UnimplementedGatewayServer) ActivateJobs 

func (*UnimplementedGatewayServer) ActivateJobs(*ActivateJobsRequest, Gateway_ActivateJobsServer) error

func (*UnimplementedGatewayServer) BroadcastSignal added in v8.2.0 

func (*UnimplementedGatewayServer) BroadcastSignal(context.Context, *BroadcastSignalRequest) (*BroadcastSignalResponse, error)

func (*UnimplementedGatewayServer) CancelProcessInstance 

func (*UnimplementedGatewayServer) CancelProcessInstance(context.Context, *CancelProcessInstanceRequest) (*CancelProcessInstanceResponse, error)

func (*UnimplementedGatewayServer) CompleteJob 

func (*UnimplementedGatewayServer) CompleteJob(context.Context, *CompleteJobRequest) (*CompleteJobResponse, error)

func (*UnimplementedGatewayServer) CreateProcessInstance 

func (*UnimplementedGatewayServer) CreateProcessInstance(context.Context, *CreateProcessInstanceRequest) (*CreateProcessInstanceResponse, error)

func (*UnimplementedGatewayServer) CreateProcessInstanceWithResult 

func (*UnimplementedGatewayServer) CreateProcessInstanceWithResult(context.Context, *CreateProcessInstanceWithResultRequest) (*CreateProcessInstanceWithResultResponse, error)

func (*UnimplementedGatewayServer) DeleteResource added in v8.2.0 

func (*UnimplementedGatewayServer) DeleteResource(context.Context, *DeleteResourceRequest) (*DeleteResourceResponse, error)

func (*UnimplementedGatewayServer) DeployProcess 

func (*UnimplementedGatewayServer) DeployProcess(context.Context, *DeployProcessRequest) (*DeployProcessResponse, error)

func (*UnimplementedGatewayServer) DeployResource 

func (*UnimplementedGatewayServer) DeployResource(context.Context, *DeployResourceRequest) (*DeployResourceResponse, error)

func (*UnimplementedGatewayServer) EvaluateDecision added in v8.2.0 

func (*UnimplementedGatewayServer) EvaluateDecision(context.Context, *EvaluateDecisionRequest) (*EvaluateDecisionResponse, error)

func (*UnimplementedGatewayServer) FailJob 

func (*UnimplementedGatewayServer) FailJob(context.Context, *FailJobRequest) (*FailJobResponse, error)

func (*UnimplementedGatewayServer) MigrateProcessInstance added in v8.4.0 

func (*UnimplementedGatewayServer) MigrateProcessInstance(context.Context, *MigrateProcessInstanceRequest) (*MigrateProcessInstanceResponse, error)

func (*UnimplementedGatewayServer) ModifyProcessInstance added in v8.2.0 

func (*UnimplementedGatewayServer) ModifyProcessInstance(context.Context, *ModifyProcessInstanceRequest) (*ModifyProcessInstanceResponse, error)

func (*UnimplementedGatewayServer) PublishMessage 

func (*UnimplementedGatewayServer) PublishMessage(context.Context, *PublishMessageRequest) (*PublishMessageResponse, error)

func (*UnimplementedGatewayServer) ResolveIncident 

func (*UnimplementedGatewayServer) ResolveIncident(context.Context, *ResolveIncidentRequest) (*ResolveIncidentResponse, error)

func (*UnimplementedGatewayServer) SetVariables 

func (*UnimplementedGatewayServer) SetVariables(context.Context, *SetVariablesRequest) (*SetVariablesResponse, error)

func (*UnimplementedGatewayServer) StreamActivatedJobs added in v8.4.0 

func (*UnimplementedGatewayServer) StreamActivatedJobs(*StreamActivatedJobsRequest, Gateway_StreamActivatedJobsServer) error

func (*UnimplementedGatewayServer) ThrowError 

func (*UnimplementedGatewayServer) ThrowError(context.Context, *ThrowErrorRequest) (*ThrowErrorResponse, error)

func (*UnimplementedGatewayServer) Topology 

func (*UnimplementedGatewayServer) Topology(context.Context, *TopologyRequest) (*TopologyResponse, error)

func (*UnimplementedGatewayServer) UpdateJobRetries 

func (*UnimplementedGatewayServer) UpdateJobRetries(context.Context, *UpdateJobRetriesRequest) (*UpdateJobRetriesResponse, error)

func (*UnimplementedGatewayServer) UpdateJobTimeout added in v8.4.0 

func (*UnimplementedGatewayServer) UpdateJobTimeout(context.Context, *UpdateJobTimeoutRequest) (*UpdateJobTimeoutResponse, error)

type UpdateJobRetriesRequest 

type UpdateJobRetriesRequest struct {

	// the unique job identifier, as obtained through ActivateJobs
	JobKey int64 `protobuf:"varint,1,opt,name=jobKey,proto3" json:"jobKey,omitempty"`
	// the new amount of retries for the job; must be positive
	Retries int32 `protobuf:"varint,2,opt,name=retries,proto3" json:"retries,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateJobRetriesRequest) Descriptor deprecated 

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

Deprecated: Use UpdateJobRetriesRequest.ProtoReflect.Descriptor instead.

func (*UpdateJobRetriesRequest) GetJobKey 

func (x *UpdateJobRetriesRequest) GetJobKey() int64

func (*UpdateJobRetriesRequest) GetRetries 

func (x *UpdateJobRetriesRequest) GetRetries() int32

func (*UpdateJobRetriesRequest) ProtoMessage 

func (*UpdateJobRetriesRequest) ProtoMessage()

func (*UpdateJobRetriesRequest) ProtoReflect 

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

func (*UpdateJobRetriesRequest) Reset 

func (x *UpdateJobRetriesRequest) Reset()

func (*UpdateJobRetriesRequest) String 

func (x *UpdateJobRetriesRequest) String() string

type UpdateJobRetriesResponse 

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

func (*UpdateJobRetriesResponse) Descriptor deprecated 

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

Deprecated: Use UpdateJobRetriesResponse.ProtoReflect.Descriptor instead.

func (*UpdateJobRetriesResponse) ProtoMessage 

func (*UpdateJobRetriesResponse) ProtoMessage()

func (*UpdateJobRetriesResponse) ProtoReflect 

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

func (*UpdateJobRetriesResponse) Reset 

func (x *UpdateJobRetriesResponse) Reset()

func (*UpdateJobRetriesResponse) String 

func (x *UpdateJobRetriesResponse) String() string

type UpdateJobTimeoutRequest added in v8.4.0 

type UpdateJobTimeoutRequest struct {

	// the unique job identifier, as obtained from ActivateJobsResponse
	JobKey int64 `protobuf:"varint,1,opt,name=jobKey,proto3" json:"jobKey,omitempty"`
	// the duration of the new timeout in ms, starting from the current moment
	Timeout int64 `protobuf:"varint,2,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateJobTimeoutRequest) Descriptor deprecated added in v8.4.0 

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

Deprecated: Use UpdateJobTimeoutRequest.ProtoReflect.Descriptor instead.

func (*UpdateJobTimeoutRequest) GetJobKey added in v8.4.0 

func (x *UpdateJobTimeoutRequest) GetJobKey() int64

func (*UpdateJobTimeoutRequest) GetTimeout added in v8.4.0 

func (x *UpdateJobTimeoutRequest) GetTimeout() int64

func (*UpdateJobTimeoutRequest) ProtoMessage added in v8.4.0 

func (*UpdateJobTimeoutRequest) ProtoMessage()

func (*UpdateJobTimeoutRequest) ProtoReflect added in v8.4.0 

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

func (*UpdateJobTimeoutRequest) Reset added in v8.4.0 

func (x *UpdateJobTimeoutRequest) Reset()

func (*UpdateJobTimeoutRequest) String added in v8.4.0 

func (x *UpdateJobTimeoutRequest) String() string

type UpdateJobTimeoutResponse added in v8.4.0 

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

func (*UpdateJobTimeoutResponse) Descriptor deprecated added in v8.4.0 

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

Deprecated: Use UpdateJobTimeoutResponse.ProtoReflect.Descriptor instead.

func (*UpdateJobTimeoutResponse) ProtoMessage added in v8.4.0 

func (*UpdateJobTimeoutResponse) ProtoMessage()

func (*UpdateJobTimeoutResponse) ProtoReflect added in v8.4.0 

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

func (*UpdateJobTimeoutResponse) Reset added in v8.4.0 

func (x *UpdateJobTimeoutResponse) Reset()

func (*UpdateJobTimeoutResponse) String added in v8.4.0 

func (x *UpdateJobTimeoutResponse) String() string

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.