pb

package
Version: v1.1.1 Latest Latest
Warning

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

Go to latest
Published: Jul 20, 2021 License: Apache-2.0 Imports: 8 Imported by: 1

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",
	}
	Partition_PartitionBrokerHealth_value = map[string]int32{
		"HEALTHY":   0,
		"UNHEALTHY": 1,
	}
)

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"`
	// contains filtered or unexported fields
}

func (*ActivateJobsRequest) Descriptor deprecated

This method has been 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) 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

This method has been 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"`
	// contains filtered or unexported fields
}

func (*ActivatedJob) Descriptor deprecated

This method has been 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) 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 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

This method has been 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

This method has been 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 (*CancelProcessInstanceRequest) Reset

func (x *CancelProcessInstanceRequest) Reset()

func (*CancelProcessInstanceRequest) String

type CancelProcessInstanceResponse

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

func (*CancelProcessInstanceResponse) Descriptor deprecated

This method has been deprecated.
func (*CancelProcessInstanceResponse) Descriptor() ([]byte, []int)

Deprecated: Use CancelProcessInstanceResponse.ProtoReflect.Descriptor instead.

func (*CancelProcessInstanceResponse) ProtoMessage

func (*CancelProcessInstanceResponse) ProtoMessage()

func (*CancelProcessInstanceResponse) ProtoReflect

func (*CancelProcessInstanceResponse) Reset

func (x *CancelProcessInstanceResponse) Reset()

func (*CancelProcessInstanceResponse) 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

This method has been 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

This method has been 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"`
	// contains filtered or unexported fields
}

func (*CreateProcessInstanceRequest) Descriptor deprecated

This method has been 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) GetVariables

func (x *CreateProcessInstanceRequest) GetVariables() string

func (*CreateProcessInstanceRequest) GetVersion

func (x *CreateProcessInstanceRequest) GetVersion() int32

func (*CreateProcessInstanceRequest) ProtoMessage

func (*CreateProcessInstanceRequest) ProtoMessage()

func (*CreateProcessInstanceRequest) ProtoReflect

func (*CreateProcessInstanceRequest) Reset

func (x *CreateProcessInstanceRequest) Reset()

func (*CreateProcessInstanceRequest) 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"`
	// contains filtered or unexported fields
}

func (*CreateProcessInstanceResponse) Descriptor deprecated

This method has been 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) GetVersion

func (x *CreateProcessInstanceResponse) GetVersion() int32

func (*CreateProcessInstanceResponse) ProtoMessage

func (*CreateProcessInstanceResponse) ProtoMessage()

func (*CreateProcessInstanceResponse) ProtoReflect

func (*CreateProcessInstanceResponse) Reset

func (x *CreateProcessInstanceResponse) Reset()

func (*CreateProcessInstanceResponse) 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

This method has been deprecated.
func (*CreateProcessInstanceWithResultRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateProcessInstanceWithResultRequest.ProtoReflect.Descriptor instead.

func (*CreateProcessInstanceWithResultRequest) GetFetchVariables

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

func (*CreateProcessInstanceWithResultRequest) GetRequest

func (*CreateProcessInstanceWithResultRequest) GetRequestTimeout

func (x *CreateProcessInstanceWithResultRequest) GetRequestTimeout() int64

func (*CreateProcessInstanceWithResultRequest) ProtoMessage

func (*CreateProcessInstanceWithResultRequest) ProtoReflect

func (*CreateProcessInstanceWithResultRequest) Reset

func (*CreateProcessInstanceWithResultRequest) 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"`
	// contains filtered or unexported fields
}

func (*CreateProcessInstanceWithResultResponse) Descriptor deprecated

This method has been 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) GetVariables

func (*CreateProcessInstanceWithResultResponse) GetVersion

func (*CreateProcessInstanceWithResultResponse) ProtoMessage

func (*CreateProcessInstanceWithResultResponse) ProtoReflect

func (*CreateProcessInstanceWithResultResponse) Reset

func (*CreateProcessInstanceWithResultResponse) String

type DeployProcessRequest

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
}

func (*DeployProcessRequest) Descriptor deprecated

This method has been 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

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
}

func (*DeployProcessResponse) Descriptor deprecated

This method has been 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 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"`
	// contains filtered or unexported fields
}

func (*FailJobRequest) Descriptor deprecated

This method has been 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) 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

This method has been 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 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)
	//
	//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)
	//
	//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)
	//
	//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)
}

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
	//
	//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)
	//
	//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)
	//
	//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)
}

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 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

This method has been deprecated.
func (*Partition) Descriptor() ([]byte, []int)

Deprecated: Use Partition.ProtoReflect.Descriptor instead.

func (*Partition) GetHealth

func (*Partition) GetPartitionId

func (x *Partition) GetPartitionId() int32

func (*Partition) GetRole

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
)

func (Partition_PartitionBrokerHealth) Descriptor

func (Partition_PartitionBrokerHealth) Enum

func (Partition_PartitionBrokerHealth) EnumDescriptor deprecated

This method has been deprecated.
func (Partition_PartitionBrokerHealth) EnumDescriptor() ([]byte, []int)

Deprecated: Use Partition_PartitionBrokerHealth.Descriptor instead.

func (Partition_PartitionBrokerHealth) Number

func (Partition_PartitionBrokerHealth) String

func (Partition_PartitionBrokerHealth) Type

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) Enum

func (Partition_PartitionBrokerRole) EnumDescriptor deprecated

This method has been deprecated.
func (Partition_PartitionBrokerRole) EnumDescriptor() ([]byte, []int)

Deprecated: Use Partition_PartitionBrokerRole.Descriptor instead.

func (Partition_PartitionBrokerRole) Number

func (Partition_PartitionBrokerRole) String

func (Partition_PartitionBrokerRole) Type

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"`
	// contains filtered or unexported fields
}

func (*ProcessMetadata) Descriptor deprecated

This method has been 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) 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

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
}

func (*ProcessRequestObject) Descriptor deprecated

This method has been 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"`
	// contains filtered or unexported fields
}

func (*PublishMessageRequest) Descriptor deprecated

This method has been 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) 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"`
	// contains filtered or unexported fields
}

func (*PublishMessageResponse) Descriptor deprecated

This method has been deprecated.
func (*PublishMessageResponse) Descriptor() ([]byte, []int)

Deprecated: Use PublishMessageResponse.ProtoReflect.Descriptor instead.

func (*PublishMessageResponse) GetKey

func (x *PublishMessageResponse) GetKey() int64

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

This method has been 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

This method has been 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 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

This method has been 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

This method has been 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 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"`
	// contains filtered or unexported fields
}

func (*ThrowErrorRequest) Descriptor deprecated

This method has been 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) 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

This method has been 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

This method has been 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

This method has been 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) CompleteJob

func (*UnimplementedGatewayServer) DeployProcess

func (*UnimplementedGatewayServer) FailJob

func (*UnimplementedGatewayServer) PublishMessage

func (*UnimplementedGatewayServer) ResolveIncident

func (*UnimplementedGatewayServer) SetVariables

func (*UnimplementedGatewayServer) ThrowError

func (*UnimplementedGatewayServer) Topology

func (*UnimplementedGatewayServer) UpdateJobRetries

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

This method has been 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

This method has been 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

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL