Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterOverseerStudioServiceServer(s grpc.ServiceRegistrar, srv OverseerStudioServiceServer)
- type AddProcessStepRequest
- func (*AddProcessStepRequest) Descriptor() ([]byte, []int)deprecated
- func (x *AddProcessStepRequest) GetActionType() string
- func (x *AddProcessStepRequest) GetConfigJson() string
- func (x *AddProcessStepRequest) GetProcessId() int64
- func (x *AddProcessStepRequest) GetStepName() string
- func (x *AddProcessStepRequest) GetStepNumber() int32
- func (*AddProcessStepRequest) ProtoMessage()
- func (x *AddProcessStepRequest) ProtoReflect() protoreflect.Message
- func (x *AddProcessStepRequest) Reset()
- func (x *AddProcessStepRequest) String() string
- type CreateBusinessProcessRequest
- func (*CreateBusinessProcessRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateBusinessProcessRequest) GetDescription() string
- func (x *CreateBusinessProcessRequest) GetName() string
- func (*CreateBusinessProcessRequest) ProtoMessage()
- func (x *CreateBusinessProcessRequest) ProtoReflect() protoreflect.Message
- func (x *CreateBusinessProcessRequest) Reset()
- func (x *CreateBusinessProcessRequest) String() string
- type CreateBusinessProcessResponse
- func (*CreateBusinessProcessResponse) Descriptor() ([]byte, []int)deprecated
- func (x *CreateBusinessProcessResponse) GetProcessId() int64
- func (*CreateBusinessProcessResponse) ProtoMessage()
- func (x *CreateBusinessProcessResponse) ProtoReflect() protoreflect.Message
- func (x *CreateBusinessProcessResponse) Reset()
- func (x *CreateBusinessProcessResponse) String() string
- type GetProcessDefinitionRequest
- func (*GetProcessDefinitionRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetProcessDefinitionRequest) GetProcessId() int64
- func (*GetProcessDefinitionRequest) ProtoMessage()
- func (x *GetProcessDefinitionRequest) ProtoReflect() protoreflect.Message
- func (x *GetProcessDefinitionRequest) Reset()
- func (x *GetProcessDefinitionRequest) String() string
- type GetProcessDefinitionResponse
- func (*GetProcessDefinitionResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetProcessDefinitionResponse) GetDescription() string
- func (x *GetProcessDefinitionResponse) GetName() string
- func (x *GetProcessDefinitionResponse) GetProcessId() int64
- func (x *GetProcessDefinitionResponse) GetSteps() []*ProcessStep
- func (*GetProcessDefinitionResponse) ProtoMessage()
- func (x *GetProcessDefinitionResponse) ProtoReflect() protoreflect.Message
- func (x *GetProcessDefinitionResponse) Reset()
- func (x *GetProcessDefinitionResponse) String() string
- type OverseerStudioServiceClient
- type OverseerStudioServiceServer
- type ProcessStep
- func (*ProcessStep) Descriptor() ([]byte, []int)deprecated
- func (x *ProcessStep) GetActionType() string
- func (x *ProcessStep) GetConfigJson() string
- func (x *ProcessStep) GetStepName() string
- func (x *ProcessStep) GetStepNumber() int32
- func (*ProcessStep) ProtoMessage()
- func (x *ProcessStep) ProtoReflect() protoreflect.Message
- func (x *ProcessStep) Reset()
- func (x *ProcessStep) String() string
- type UnimplementedOverseerStudioServiceServer
- func (UnimplementedOverseerStudioServiceServer) AddProcessStep(context.Context, *AddProcessStepRequest) (*emptypb.Empty, error)
- func (UnimplementedOverseerStudioServiceServer) CreateBusinessProcess(context.Context, *CreateBusinessProcessRequest) (*CreateBusinessProcessResponse, error)
- func (UnimplementedOverseerStudioServiceServer) GetProcessDefinition(context.Context, *GetProcessDefinitionRequest) (*GetProcessDefinitionResponse, error)
- type UnsafeOverseerStudioServiceServer
Constants ¶
const ( OverseerStudioService_CreateBusinessProcess_FullMethodName = "/gov.v1.OverseerStudioService/CreateBusinessProcess" OverseerStudioService_AddProcessStep_FullMethodName = "/gov.v1.OverseerStudioService/AddProcessStep" OverseerStudioService_GetProcessDefinition_FullMethodName = "/gov.v1.OverseerStudioService/GetProcessDefinition" )
Variables ¶
var File_api_proto_overseer_v1_overseer_proto protoreflect.FileDescriptor
var OverseerStudioService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "gov.v1.OverseerStudioService", HandlerType: (*OverseerStudioServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "CreateBusinessProcess", Handler: _OverseerStudioService_CreateBusinessProcess_Handler, }, { MethodName: "AddProcessStep", Handler: _OverseerStudioService_AddProcessStep_Handler, }, { MethodName: "GetProcessDefinition", Handler: _OverseerStudioService_GetProcessDefinition_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "api/proto/gov/v1/gov.proto", }
OverseerStudioService_ServiceDesc is the grpc.ServiceDesc for OverseerStudioService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterOverseerStudioServiceServer ¶
func RegisterOverseerStudioServiceServer(s grpc.ServiceRegistrar, srv OverseerStudioServiceServer)
Types ¶
type AddProcessStepRequest ¶
type AddProcessStepRequest struct {
ProcessId int64 `protobuf:"varint,1,opt,name=process_id,json=processId,proto3" json:"process_id,omitempty"`
StepNumber int32 `protobuf:"varint,2,opt,name=step_number,json=stepNumber,proto3" json:"step_number,omitempty"`
StepName string `protobuf:"bytes,3,opt,name=step_name,json=stepName,proto3" json:"step_name,omitempty"`
ActionType string `protobuf:"bytes,4,opt,name=action_type,json=actionType,proto3" json:"action_type,omitempty"` // e.g., "STAGE_DATA", "POST_TO_LEDGER"
ConfigJson string `protobuf:"bytes,5,opt,name=config_json,json=configJson,proto3" json:"config_json,omitempty"` // JSON string for the 'config' field
// contains filtered or unexported fields
}
func (*AddProcessStepRequest) Descriptor
deprecated
func (*AddProcessStepRequest) Descriptor() ([]byte, []int)
Deprecated: Use AddProcessStepRequest.ProtoReflect.Descriptor instead.
func (*AddProcessStepRequest) GetActionType ¶
func (x *AddProcessStepRequest) GetActionType() string
func (*AddProcessStepRequest) GetConfigJson ¶
func (x *AddProcessStepRequest) GetConfigJson() string
func (*AddProcessStepRequest) GetProcessId ¶
func (x *AddProcessStepRequest) GetProcessId() int64
func (*AddProcessStepRequest) GetStepName ¶
func (x *AddProcessStepRequest) GetStepName() string
func (*AddProcessStepRequest) GetStepNumber ¶
func (x *AddProcessStepRequest) GetStepNumber() int32
func (*AddProcessStepRequest) ProtoMessage ¶
func (*AddProcessStepRequest) ProtoMessage()
func (*AddProcessStepRequest) ProtoReflect ¶
func (x *AddProcessStepRequest) ProtoReflect() protoreflect.Message
func (*AddProcessStepRequest) Reset ¶
func (x *AddProcessStepRequest) Reset()
func (*AddProcessStepRequest) String ¶
func (x *AddProcessStepRequest) String() string
type CreateBusinessProcessRequest ¶
type CreateBusinessProcessRequest struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
func (*CreateBusinessProcessRequest) Descriptor
deprecated
func (*CreateBusinessProcessRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateBusinessProcessRequest.ProtoReflect.Descriptor instead.
func (*CreateBusinessProcessRequest) GetDescription ¶
func (x *CreateBusinessProcessRequest) GetDescription() string
func (*CreateBusinessProcessRequest) GetName ¶
func (x *CreateBusinessProcessRequest) GetName() string
func (*CreateBusinessProcessRequest) ProtoMessage ¶
func (*CreateBusinessProcessRequest) ProtoMessage()
func (*CreateBusinessProcessRequest) ProtoReflect ¶
func (x *CreateBusinessProcessRequest) ProtoReflect() protoreflect.Message
func (*CreateBusinessProcessRequest) Reset ¶
func (x *CreateBusinessProcessRequest) Reset()
func (*CreateBusinessProcessRequest) String ¶
func (x *CreateBusinessProcessRequest) String() string
type CreateBusinessProcessResponse ¶
type CreateBusinessProcessResponse struct {
ProcessId int64 `protobuf:"varint,1,opt,name=process_id,json=processId,proto3" json:"process_id,omitempty"`
// contains filtered or unexported fields
}
func (*CreateBusinessProcessResponse) Descriptor
deprecated
func (*CreateBusinessProcessResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateBusinessProcessResponse.ProtoReflect.Descriptor instead.
func (*CreateBusinessProcessResponse) GetProcessId ¶
func (x *CreateBusinessProcessResponse) GetProcessId() int64
func (*CreateBusinessProcessResponse) ProtoMessage ¶
func (*CreateBusinessProcessResponse) ProtoMessage()
func (*CreateBusinessProcessResponse) ProtoReflect ¶
func (x *CreateBusinessProcessResponse) ProtoReflect() protoreflect.Message
func (*CreateBusinessProcessResponse) Reset ¶
func (x *CreateBusinessProcessResponse) Reset()
func (*CreateBusinessProcessResponse) String ¶
func (x *CreateBusinessProcessResponse) String() string
type GetProcessDefinitionRequest ¶
type GetProcessDefinitionRequest struct {
ProcessId int64 `protobuf:"varint,1,opt,name=process_id,json=processId,proto3" json:"process_id,omitempty"`
// contains filtered or unexported fields
}
func (*GetProcessDefinitionRequest) Descriptor
deprecated
func (*GetProcessDefinitionRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetProcessDefinitionRequest.ProtoReflect.Descriptor instead.
func (*GetProcessDefinitionRequest) GetProcessId ¶
func (x *GetProcessDefinitionRequest) GetProcessId() int64
func (*GetProcessDefinitionRequest) ProtoMessage ¶
func (*GetProcessDefinitionRequest) ProtoMessage()
func (*GetProcessDefinitionRequest) ProtoReflect ¶
func (x *GetProcessDefinitionRequest) ProtoReflect() protoreflect.Message
func (*GetProcessDefinitionRequest) Reset ¶
func (x *GetProcessDefinitionRequest) Reset()
func (*GetProcessDefinitionRequest) String ¶
func (x *GetProcessDefinitionRequest) String() string
type GetProcessDefinitionResponse ¶
type GetProcessDefinitionResponse struct {
ProcessId int64 `protobuf:"varint,1,opt,name=process_id,json=processId,proto3" json:"process_id,omitempty"`
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
Steps []*ProcessStep `protobuf:"bytes,4,rep,name=steps,proto3" json:"steps,omitempty"`
// contains filtered or unexported fields
}
func (*GetProcessDefinitionResponse) Descriptor
deprecated
func (*GetProcessDefinitionResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetProcessDefinitionResponse.ProtoReflect.Descriptor instead.
func (*GetProcessDefinitionResponse) GetDescription ¶
func (x *GetProcessDefinitionResponse) GetDescription() string
func (*GetProcessDefinitionResponse) GetName ¶
func (x *GetProcessDefinitionResponse) GetName() string
func (*GetProcessDefinitionResponse) GetProcessId ¶
func (x *GetProcessDefinitionResponse) GetProcessId() int64
func (*GetProcessDefinitionResponse) GetSteps ¶
func (x *GetProcessDefinitionResponse) GetSteps() []*ProcessStep
func (*GetProcessDefinitionResponse) ProtoMessage ¶
func (*GetProcessDefinitionResponse) ProtoMessage()
func (*GetProcessDefinitionResponse) ProtoReflect ¶
func (x *GetProcessDefinitionResponse) ProtoReflect() protoreflect.Message
func (*GetProcessDefinitionResponse) Reset ¶
func (x *GetProcessDefinitionResponse) Reset()
func (*GetProcessDefinitionResponse) String ¶
func (x *GetProcessDefinitionResponse) String() string
type OverseerStudioServiceClient ¶
type OverseerStudioServiceClient interface {
// Creates a new high-level business process definition.
CreateBusinessProcess(ctx context.Context, in *CreateBusinessProcessRequest, opts ...grpc.CallOption) (*CreateBusinessProcessResponse, error)
// Adds a step (an "Atom") to an existing business process.
AddProcessStep(ctx context.Context, in *AddProcessStepRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Retrieves the full definition (all steps) for a given process.
GetProcessDefinition(ctx context.Context, in *GetProcessDefinitionRequest, opts ...grpc.CallOption) (*GetProcessDefinitionResponse, error)
}
OverseerStudioServiceClient is the client API for OverseerStudioService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
The service definition for the Business Process Design Studio backend.
func NewOverseerStudioServiceClient ¶
func NewOverseerStudioServiceClient(cc grpc.ClientConnInterface) OverseerStudioServiceClient
type OverseerStudioServiceServer ¶
type OverseerStudioServiceServer interface {
// Creates a new high-level business process definition.
CreateBusinessProcess(context.Context, *CreateBusinessProcessRequest) (*CreateBusinessProcessResponse, error)
// Adds a step (an "Atom") to an existing business process.
AddProcessStep(context.Context, *AddProcessStepRequest) (*emptypb.Empty, error)
// Retrieves the full definition (all steps) for a given process.
GetProcessDefinition(context.Context, *GetProcessDefinitionRequest) (*GetProcessDefinitionResponse, error)
// contains filtered or unexported methods
}
OverseerStudioServiceServer is the server API for OverseerStudioService service. All implementations must embed UnimplementedOverseerStudioServiceServer for forward compatibility.
The service definition for the Business Process Design Studio backend.
type ProcessStep ¶
type ProcessStep struct {
StepNumber int32 `protobuf:"varint,1,opt,name=step_number,json=stepNumber,proto3" json:"step_number,omitempty"`
StepName string `protobuf:"bytes,2,opt,name=step_name,json=stepName,proto3" json:"step_name,omitempty"`
ActionType string `protobuf:"bytes,3,opt,name=action_type,json=actionType,proto3" json:"action_type,omitempty"`
ConfigJson string `protobuf:"bytes,4,opt,name=config_json,json=configJson,proto3" json:"config_json,omitempty"`
// contains filtered or unexported fields
}
func (*ProcessStep) Descriptor
deprecated
func (*ProcessStep) Descriptor() ([]byte, []int)
Deprecated: Use ProcessStep.ProtoReflect.Descriptor instead.
func (*ProcessStep) GetActionType ¶
func (x *ProcessStep) GetActionType() string
func (*ProcessStep) GetConfigJson ¶
func (x *ProcessStep) GetConfigJson() string
func (*ProcessStep) GetStepName ¶
func (x *ProcessStep) GetStepName() string
func (*ProcessStep) GetStepNumber ¶
func (x *ProcessStep) GetStepNumber() int32
func (*ProcessStep) ProtoMessage ¶
func (*ProcessStep) ProtoMessage()
func (*ProcessStep) ProtoReflect ¶
func (x *ProcessStep) ProtoReflect() protoreflect.Message
func (*ProcessStep) Reset ¶
func (x *ProcessStep) Reset()
func (*ProcessStep) String ¶
func (x *ProcessStep) String() string
type UnimplementedOverseerStudioServiceServer ¶
type UnimplementedOverseerStudioServiceServer struct{}
UnimplementedOverseerStudioServiceServer must be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedOverseerStudioServiceServer) AddProcessStep ¶
func (UnimplementedOverseerStudioServiceServer) AddProcessStep(context.Context, *AddProcessStepRequest) (*emptypb.Empty, error)
func (UnimplementedOverseerStudioServiceServer) CreateBusinessProcess ¶
func (UnimplementedOverseerStudioServiceServer) CreateBusinessProcess(context.Context, *CreateBusinessProcessRequest) (*CreateBusinessProcessResponse, error)
func (UnimplementedOverseerStudioServiceServer) GetProcessDefinition ¶
func (UnimplementedOverseerStudioServiceServer) GetProcessDefinition(context.Context, *GetProcessDefinitionRequest) (*GetProcessDefinitionResponse, error)
type UnsafeOverseerStudioServiceServer ¶
type UnsafeOverseerStudioServiceServer interface {
// contains filtered or unexported methods
}
UnsafeOverseerStudioServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to OverseerStudioServiceServer will result in compilation errors.