workflows

package
v1.9.9 Latest Latest
Warning

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

 Go to latest Published: Dec 17, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	WorkflowDefinitionPersistService_CreateWorkflowDefinition_FullMethodName   = "/api.v1alpha1.workflows.WorkflowDefinitionPersistService/CreateWorkflowDefinition"
	WorkflowDefinitionPersistService_GetWorkflowDefinition_FullMethodName      = "/api.v1alpha1.workflows.WorkflowDefinitionPersistService/GetWorkflowDefinition"
	WorkflowDefinitionPersistService_ListWorkflowDefinitions_FullMethodName    = "/api.v1alpha1.workflows.WorkflowDefinitionPersistService/ListWorkflowDefinitions"
	WorkflowDefinitionPersistService_UpdateWorkflowDefinition_FullMethodName   = "/api.v1alpha1.workflows.WorkflowDefinitionPersistService/UpdateWorkflowDefinition"
	WorkflowDefinitionPersistService_DeleteWorkflowDefinition_FullMethodName   = "/api.v1alpha1.workflows.WorkflowDefinitionPersistService/DeleteWorkflowDefinition"
	WorkflowDefinitionPersistService_ValidateWorkflowDefinition_FullMethodName = "/api.v1alpha1.workflows.WorkflowDefinitionPersistService/ValidateWorkflowDefinition"
)

Variables

View Source 
var File_api_v1alpha1_workflows_service_proto protoreflect.FileDescriptor
View Source 
var WorkflowDefinitionPersistService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.v1alpha1.workflows.WorkflowDefinitionPersistService",
	HandlerType: (*WorkflowDefinitionPersistServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateWorkflowDefinition",
			Handler:    _WorkflowDefinitionPersistService_CreateWorkflowDefinition_Handler,
		},
		{
			MethodName: "GetWorkflowDefinition",
			Handler:    _WorkflowDefinitionPersistService_GetWorkflowDefinition_Handler,
		},
		{
			MethodName: "UpdateWorkflowDefinition",
			Handler:    _WorkflowDefinitionPersistService_UpdateWorkflowDefinition_Handler,
		},
		{
			MethodName: "DeleteWorkflowDefinition",
			Handler:    _WorkflowDefinitionPersistService_DeleteWorkflowDefinition_Handler,
		},
		{
			MethodName: "ValidateWorkflowDefinition",
			Handler:    _WorkflowDefinitionPersistService_ValidateWorkflowDefinition_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "ListWorkflowDefinitions",
			Handler:       _WorkflowDefinitionPersistService_ListWorkflowDefinitions_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "api/v1alpha1/workflows/service.proto",
}

WorkflowDefinitionPersistService_ServiceDesc is the grpc.ServiceDesc for WorkflowDefinitionPersistService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterWorkflowDefinitionPersistServiceServer added in v1.7.38 

func RegisterWorkflowDefinitionPersistServiceServer(s grpc.ServiceRegistrar, srv WorkflowDefinitionPersistServiceServer)

Types

type CreateWorkflowDefinitionRequest added in v1.7.38 

type CreateWorkflowDefinitionRequest struct {

	// workflow definition is the flow definition object
	WorkflowDefinition *PersistedWorkflowDefinition `protobuf:"bytes,1,opt,name=workflow_definition,json=workflowDefinition,proto3" json:"workflow_definition,omitempty"`
	// contains filtered or unexported fields
}

CreateWorkflowDefinitionRequest is the request object for creating a flow definition

func (*CreateWorkflowDefinitionRequest) Descriptor deprecated added in v1.7.38 

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

Deprecated: Use CreateWorkflowDefinitionRequest.ProtoReflect.Descriptor instead.

func (*CreateWorkflowDefinitionRequest) GetWorkflowDefinition added in v1.7.38 

func (x *CreateWorkflowDefinitionRequest) GetWorkflowDefinition() *PersistedWorkflowDefinition

func (*CreateWorkflowDefinitionRequest) ProtoMessage added in v1.7.38 

func (*CreateWorkflowDefinitionRequest) ProtoMessage()

func (*CreateWorkflowDefinitionRequest) ProtoReflect added in v1.7.38 

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

func (*CreateWorkflowDefinitionRequest) Reset added in v1.7.38 

func (x *CreateWorkflowDefinitionRequest) Reset()

func (*CreateWorkflowDefinitionRequest) String added in v1.7.38 

func (x *CreateWorkflowDefinitionRequest) String() string

type CreateWorkflowDefinitionResponse added in v1.7.38 

type CreateWorkflowDefinitionResponse struct {

	// workflow_definition is the persisted flow definition object (with the flow_definition_id set)
	WorkflowDefinition *PersistedWorkflowDefinition `protobuf:"bytes,1,opt,name=workflow_definition,json=workflowDefinition,proto3" json:"workflow_definition,omitempty"`
	// contains filtered or unexported fields
}

CreateWorkflowDefinitionResponse is the response object for creating a flow definition

func (*CreateWorkflowDefinitionResponse) Descriptor deprecated added in v1.7.38 

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

Deprecated: Use CreateWorkflowDefinitionResponse.ProtoReflect.Descriptor instead.

func (*CreateWorkflowDefinitionResponse) GetWorkflowDefinition added in v1.7.38 

func (x *CreateWorkflowDefinitionResponse) GetWorkflowDefinition() *PersistedWorkflowDefinition

func (*CreateWorkflowDefinitionResponse) ProtoMessage added in v1.7.38 

func (*CreateWorkflowDefinitionResponse) ProtoMessage()

func (*CreateWorkflowDefinitionResponse) ProtoReflect added in v1.7.38 

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

func (*CreateWorkflowDefinitionResponse) Reset added in v1.7.38 

func (x *CreateWorkflowDefinitionResponse) Reset()

func (*CreateWorkflowDefinitionResponse) String added in v1.7.38 

func (x *CreateWorkflowDefinitionResponse) String() string

type DeleteWorkflowDefinitionRequest added in v1.7.59 

type DeleteWorkflowDefinitionRequest struct {

	// workflow_definition_id is the identifier for the flow definition to delete
	WorkflowDefinitionId string `protobuf:"bytes,1,opt,name=workflow_definition_id,json=workflowDefinitionId,proto3" json:"workflow_definition_id,omitempty"`
	// contains filtered or unexported fields
}

DeleteWorkflowDefinitionRequest is the request object for deleting a flow definition

func (*DeleteWorkflowDefinitionRequest) Descriptor deprecated added in v1.7.59 

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

Deprecated: Use DeleteWorkflowDefinitionRequest.ProtoReflect.Descriptor instead.

func (*DeleteWorkflowDefinitionRequest) GetWorkflowDefinitionId added in v1.7.59 

func (x *DeleteWorkflowDefinitionRequest) GetWorkflowDefinitionId() string

func (*DeleteWorkflowDefinitionRequest) ProtoMessage added in v1.7.59 

func (*DeleteWorkflowDefinitionRequest) ProtoMessage()

func (*DeleteWorkflowDefinitionRequest) ProtoReflect added in v1.7.59 

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

func (*DeleteWorkflowDefinitionRequest) Reset added in v1.7.59 

func (x *DeleteWorkflowDefinitionRequest) Reset()

func (*DeleteWorkflowDefinitionRequest) String added in v1.7.59 

func (x *DeleteWorkflowDefinitionRequest) String() string

type DeleteWorkflowDefinitionResponse added in v1.7.59 

type DeleteWorkflowDefinitionResponse struct {

	// workflow_definition is the deleted flow definition object
	WorkflowDefinition *PersistedWorkflowDefinition `protobuf:"bytes,1,opt,name=workflow_definition,json=workflowDefinition,proto3" json:"workflow_definition,omitempty"`
	// contains filtered or unexported fields
}

DeleteWorkflowDefinitionResponse is the response object for deleting a flow definition

func (*DeleteWorkflowDefinitionResponse) Descriptor deprecated added in v1.7.59 

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

Deprecated: Use DeleteWorkflowDefinitionResponse.ProtoReflect.Descriptor instead.

func (*DeleteWorkflowDefinitionResponse) GetWorkflowDefinition added in v1.7.59 

func (x *DeleteWorkflowDefinitionResponse) GetWorkflowDefinition() *PersistedWorkflowDefinition

func (*DeleteWorkflowDefinitionResponse) ProtoMessage added in v1.7.59 

func (*DeleteWorkflowDefinitionResponse) ProtoMessage()

func (*DeleteWorkflowDefinitionResponse) ProtoReflect added in v1.7.59 

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

func (*DeleteWorkflowDefinitionResponse) Reset added in v1.7.59 

func (x *DeleteWorkflowDefinitionResponse) Reset()

func (*DeleteWorkflowDefinitionResponse) String added in v1.7.59 

func (x *DeleteWorkflowDefinitionResponse) String() string

type GetWorkflowDefinitionRequest added in v1.7.38 

type GetWorkflowDefinitionRequest struct {

	// flow_definition_id is the identifier for the flow definition to retrieve
	WorkflowDefinitionId string `protobuf:"bytes,1,opt,name=workflow_definition_id,json=workflowDefinitionId,proto3" json:"workflow_definition_id,omitempty"`
	// contains filtered or unexported fields
}

GetWorkflowDefinitionRequest is the request object for retrieving a flow definition

func (*GetWorkflowDefinitionRequest) Descriptor deprecated added in v1.7.38 

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

Deprecated: Use GetWorkflowDefinitionRequest.ProtoReflect.Descriptor instead.

func (*GetWorkflowDefinitionRequest) GetWorkflowDefinitionId added in v1.7.38 

func (x *GetWorkflowDefinitionRequest) GetWorkflowDefinitionId() string

func (*GetWorkflowDefinitionRequest) ProtoMessage added in v1.7.38 

func (*GetWorkflowDefinitionRequest) ProtoMessage()

func (*GetWorkflowDefinitionRequest) ProtoReflect added in v1.7.38 

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

func (*GetWorkflowDefinitionRequest) Reset added in v1.7.38 

func (x *GetWorkflowDefinitionRequest) Reset()

func (*GetWorkflowDefinitionRequest) String added in v1.7.38 

func (x *GetWorkflowDefinitionRequest) String() string

type GetWorkflowDefinitionResponse added in v1.7.38 

type GetWorkflowDefinitionResponse struct {

	// workflow_1definition is the flow definition object
	WorkflowDefinition *PersistedWorkflowDefinition `protobuf:"bytes,1,opt,name=workflow_definition,json=workflowDefinition,proto3" json:"workflow_definition,omitempty"`
	// contains filtered or unexported fields
}

GetWorkflowDefinitionResponse is the response object for retrieving a flow definition

func (*GetWorkflowDefinitionResponse) Descriptor deprecated added in v1.7.38 

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

Deprecated: Use GetWorkflowDefinitionResponse.ProtoReflect.Descriptor instead.

func (*GetWorkflowDefinitionResponse) GetWorkflowDefinition added in v1.7.38 

func (x *GetWorkflowDefinitionResponse) GetWorkflowDefinition() *PersistedWorkflowDefinition

func (*GetWorkflowDefinitionResponse) ProtoMessage added in v1.7.38 

func (*GetWorkflowDefinitionResponse) ProtoMessage()

func (*GetWorkflowDefinitionResponse) ProtoReflect added in v1.7.38 

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

func (*GetWorkflowDefinitionResponse) Reset added in v1.7.38 

func (x *GetWorkflowDefinitionResponse) Reset()

func (*GetWorkflowDefinitionResponse) String added in v1.7.38 

func (x *GetWorkflowDefinitionResponse) String() string

type ListWorkflowDefinitionsRequest added in v1.7.38 

type ListWorkflowDefinitionsRequest struct {

	// org_id is the organization identifier to list flow definitions for
	OrgId string `protobuf:"bytes,1,opt,name=org_id,json=orgId,proto3" json:"org_id,omitempty"`
	// application is the application identifier to list flow definitions for. If this is specified, the output is filtered to only include flow definitions for the application
	Application string `protobuf:"bytes,2,opt,name=application,proto3" json:"application,omitempty"`
	// labels can be used to filter grouped/tagged flow definitions
	Labels []string `protobuf:"bytes,3,rep,name=labels,proto3" json:"labels,omitempty"`
	// contains filtered or unexported fields
}

ListWorkflowDefinitionsRequest is the request object for listing flow definitions

func (*ListWorkflowDefinitionsRequest) Descriptor deprecated added in v1.7.38 

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

Deprecated: Use ListWorkflowDefinitionsRequest.ProtoReflect.Descriptor instead.

func (*ListWorkflowDefinitionsRequest) GetApplication added in v1.7.38 

func (x *ListWorkflowDefinitionsRequest) GetApplication() string

func (*ListWorkflowDefinitionsRequest) GetLabels added in v1.7.60 

func (x *ListWorkflowDefinitionsRequest) GetLabels() []string

func (*ListWorkflowDefinitionsRequest) GetOrgId added in v1.7.38 

func (x *ListWorkflowDefinitionsRequest) GetOrgId() string

func (*ListWorkflowDefinitionsRequest) ProtoMessage added in v1.7.38 

func (*ListWorkflowDefinitionsRequest) ProtoMessage()

func (*ListWorkflowDefinitionsRequest) ProtoReflect added in v1.7.38 

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

func (*ListWorkflowDefinitionsRequest) Reset added in v1.7.38 

func (x *ListWorkflowDefinitionsRequest) Reset()

func (*ListWorkflowDefinitionsRequest) String added in v1.7.38 

func (x *ListWorkflowDefinitionsRequest) String() string

type ListWorkflowDefinitionsResponse added in v1.7.38 

type ListWorkflowDefinitionsResponse struct {

	// workflow_definition is the flow definition object
	WorkflowDefinition *PersistedWorkflowDefinition `protobuf:"bytes,1,opt,name=workflow_definition,json=workflowDefinition,proto3" json:"workflow_definition,omitempty"` // an array of
	// contains filtered or unexported fields
}

ListWorkflowDefinitionsResponse is the response object for listing flow definitions

func (*ListWorkflowDefinitionsResponse) Descriptor deprecated added in v1.7.38 

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

Deprecated: Use ListWorkflowDefinitionsResponse.ProtoReflect.Descriptor instead.

func (*ListWorkflowDefinitionsResponse) GetWorkflowDefinition added in v1.7.38 

func (x *ListWorkflowDefinitionsResponse) GetWorkflowDefinition() *PersistedWorkflowDefinition

func (*ListWorkflowDefinitionsResponse) ProtoMessage added in v1.7.38 

func (*ListWorkflowDefinitionsResponse) ProtoMessage()

func (*ListWorkflowDefinitionsResponse) ProtoReflect added in v1.7.38 

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

func (*ListWorkflowDefinitionsResponse) Reset added in v1.7.38 

func (x *ListWorkflowDefinitionsResponse) Reset()

func (*ListWorkflowDefinitionsResponse) String added in v1.7.38 

func (x *ListWorkflowDefinitionsResponse) String() string

type PersistedWorkflowDefinition added in v1.7.38 

type PersistedWorkflowDefinition struct {

	// flow_definition_id is the unique identifier for the flow definition. This is generated by the system, therefor its value is meaningless on create
	FlowDefinitionId string `protobuf:"bytes,1,opt,name=flow_definition_id,json=flowDefinitionId,proto3" json:"flow_definition_id,omitempty"`
	// org_id that owns this definition. Must match the org_id of the authenticated user
	OrgId string `protobuf:"bytes,2,opt,name=org_id,json=orgId,proto3" json:"org_id,omitempty"`
	// application that owns this definition
	Application string `protobuf:"bytes,3,opt,name=application,proto3" json:"application,omitempty"`
	// this definition name
	Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
	// labels can be used to group/tag flow definitions together into logical categories
	Labels []string `protobuf:"bytes,9,rep,name=labels,proto3" json:"labels,omitempty"`
	// this definition description
	Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
	// the JSON serialized form of the flow definition
	Definition string `protobuf:"bytes,6,opt,name=definition,proto3" json:"definition,omitempty"` // JSON serialized form of the proto definition
	// create_time is the time the flow definition was created. Not used for the update request
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// update_time is the time the flow definition was last updated. Not used for the create request
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// delete_time is the time the flow definition was soft-deleted. Not used for the create request
	DeleteTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
	// extra is a JSON serialized string that can be used to store extra data for the flow definition (e.g. UI positioning data)
	Extra string `protobuf:"bytes,100,opt,name=extra,proto3" json:"extra,omitempty"` //JSON serialized data for UI (e.g. nodes positioning)
	// contains filtered or unexported fields
}

PersistedWorkflowDefinition is the flow definition object

func (*PersistedWorkflowDefinition) Descriptor deprecated added in v1.7.38 

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

Deprecated: Use PersistedWorkflowDefinition.ProtoReflect.Descriptor instead.

func (*PersistedWorkflowDefinition) GetApplication added in v1.7.38 

func (x *PersistedWorkflowDefinition) GetApplication() string

func (*PersistedWorkflowDefinition) GetCreateTime added in v1.7.38 

func (x *PersistedWorkflowDefinition) GetCreateTime() *timestamppb.Timestamp

func (*PersistedWorkflowDefinition) GetDefinition added in v1.7.38 

func (x *PersistedWorkflowDefinition) GetDefinition() string

func (*PersistedWorkflowDefinition) GetDeleteTime added in v1.7.60 

func (x *PersistedWorkflowDefinition) GetDeleteTime() *timestamppb.Timestamp

func (*PersistedWorkflowDefinition) GetDescription added in v1.7.38 

func (x *PersistedWorkflowDefinition) GetDescription() string

func (*PersistedWorkflowDefinition) GetExtra added in v1.7.38 

func (x *PersistedWorkflowDefinition) GetExtra() string

func (*PersistedWorkflowDefinition) GetFlowDefinitionId added in v1.7.38 

func (x *PersistedWorkflowDefinition) GetFlowDefinitionId() string

func (*PersistedWorkflowDefinition) GetLabels added in v1.7.59 

func (x *PersistedWorkflowDefinition) GetLabels() []string

func (*PersistedWorkflowDefinition) GetName added in v1.7.38 

func (x *PersistedWorkflowDefinition) GetName() string

func (*PersistedWorkflowDefinition) GetOrgId added in v1.7.38 

func (x *PersistedWorkflowDefinition) GetOrgId() string

func (*PersistedWorkflowDefinition) GetUpdateTime added in v1.7.38 

func (x *PersistedWorkflowDefinition) GetUpdateTime() *timestamppb.Timestamp

func (*PersistedWorkflowDefinition) ProtoMessage added in v1.7.38 

func (*PersistedWorkflowDefinition) ProtoMessage()

func (*PersistedWorkflowDefinition) ProtoReflect added in v1.7.38 

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

func (*PersistedWorkflowDefinition) Reset added in v1.7.38 

func (x *PersistedWorkflowDefinition) Reset()

func (*PersistedWorkflowDefinition) String added in v1.7.38 

func (x *PersistedWorkflowDefinition) String() string

type UnimplementedWorkflowDefinitionPersistServiceServer added in v1.7.38 

type UnimplementedWorkflowDefinitionPersistServiceServer struct{}

UnimplementedWorkflowDefinitionPersistServiceServer 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 (UnimplementedWorkflowDefinitionPersistServiceServer) CreateWorkflowDefinition added in v1.7.38 

func (UnimplementedWorkflowDefinitionPersistServiceServer) CreateWorkflowDefinition(context.Context, *CreateWorkflowDefinitionRequest) (*CreateWorkflowDefinitionResponse, error)

func (UnimplementedWorkflowDefinitionPersistServiceServer) DeleteWorkflowDefinition added in v1.7.59 

func (UnimplementedWorkflowDefinitionPersistServiceServer) DeleteWorkflowDefinition(context.Context, *DeleteWorkflowDefinitionRequest) (*DeleteWorkflowDefinitionResponse, error)

func (UnimplementedWorkflowDefinitionPersistServiceServer) GetWorkflowDefinition added in v1.7.38 

func (UnimplementedWorkflowDefinitionPersistServiceServer) GetWorkflowDefinition(context.Context, *GetWorkflowDefinitionRequest) (*GetWorkflowDefinitionResponse, error)

func (UnimplementedWorkflowDefinitionPersistServiceServer) ListWorkflowDefinitions added in v1.7.38 

func (UnimplementedWorkflowDefinitionPersistServiceServer) ListWorkflowDefinitions(*ListWorkflowDefinitionsRequest, WorkflowDefinitionPersistService_ListWorkflowDefinitionsServer) error

func (UnimplementedWorkflowDefinitionPersistServiceServer) UpdateWorkflowDefinition added in v1.7.38 

func (UnimplementedWorkflowDefinitionPersistServiceServer) UpdateWorkflowDefinition(context.Context, *UpdateWorkflowDefinitionRequest) (*UpdateWorkflowDefinitionResponse, error)

func (UnimplementedWorkflowDefinitionPersistServiceServer) ValidateWorkflowDefinition added in v1.7.38 

func (UnimplementedWorkflowDefinitionPersistServiceServer) ValidateWorkflowDefinition(context.Context, *ValidateWorkflowDefinitionRequest) (*ValidateWorkflowDefinitionResponse, error)

type UnsafeWorkflowDefinitionPersistServiceServer added in v1.7.38 

type UnsafeWorkflowDefinitionPersistServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeWorkflowDefinitionPersistServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to WorkflowDefinitionPersistServiceServer will result in compilation errors.

type UpdateWorkflowDefinitionRequest added in v1.7.38 

type UpdateWorkflowDefinitionRequest struct {

	// flow_definition is the object to be updated. Only the name, description, definition graph and the extra information are updated
	WorkflowDefinition *PersistedWorkflowDefinition `protobuf:"bytes,1,opt,name=workflow_definition,json=workflowDefinition,proto3" json:"workflow_definition,omitempty"`
	// contains filtered or unexported fields
}

UpdateWorkflowDefinitionRequest is the request object for updating a flow definition

func (*UpdateWorkflowDefinitionRequest) Descriptor deprecated added in v1.7.38 

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

Deprecated: Use UpdateWorkflowDefinitionRequest.ProtoReflect.Descriptor instead.

func (*UpdateWorkflowDefinitionRequest) GetWorkflowDefinition added in v1.7.38 

func (x *UpdateWorkflowDefinitionRequest) GetWorkflowDefinition() *PersistedWorkflowDefinition

func (*UpdateWorkflowDefinitionRequest) ProtoMessage added in v1.7.38 

func (*UpdateWorkflowDefinitionRequest) ProtoMessage()

func (*UpdateWorkflowDefinitionRequest) ProtoReflect added in v1.7.38 

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

func (*UpdateWorkflowDefinitionRequest) Reset added in v1.7.38 

func (x *UpdateWorkflowDefinitionRequest) Reset()

func (*UpdateWorkflowDefinitionRequest) String added in v1.7.38 

func (x *UpdateWorkflowDefinitionRequest) String() string

type UpdateWorkflowDefinitionResponse added in v1.7.38 

type UpdateWorkflowDefinitionResponse struct {

	// flow_definition is the updated flow definition object
	WorkflowDefinition *PersistedWorkflowDefinition `protobuf:"bytes,1,opt,name=workflow_definition,json=workflowDefinition,proto3" json:"workflow_definition,omitempty"`
	// contains filtered or unexported fields
}

UpdateWorkflowDefinitionResponse is the response object for updating a flow definition

func (*UpdateWorkflowDefinitionResponse) Descriptor deprecated added in v1.7.38 

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

Deprecated: Use UpdateWorkflowDefinitionResponse.ProtoReflect.Descriptor instead.

func (*UpdateWorkflowDefinitionResponse) GetWorkflowDefinition added in v1.7.38 

func (x *UpdateWorkflowDefinitionResponse) GetWorkflowDefinition() *PersistedWorkflowDefinition

func (*UpdateWorkflowDefinitionResponse) ProtoMessage added in v1.7.38 

func (*UpdateWorkflowDefinitionResponse) ProtoMessage()

func (*UpdateWorkflowDefinitionResponse) ProtoReflect added in v1.7.38 

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

func (*UpdateWorkflowDefinitionResponse) Reset added in v1.7.38 

func (x *UpdateWorkflowDefinitionResponse) Reset()

func (*UpdateWorkflowDefinitionResponse) String added in v1.7.38 

func (x *UpdateWorkflowDefinitionResponse) String() string

type ValidateWorkflowDefinitionRequest added in v1.7.38 

type ValidateWorkflowDefinitionRequest struct {

	// workflow_definition is the object to be validated
	WorkflowDefinition *PersistedWorkflowDefinition `protobuf:"bytes,1,opt,name=workflow_definition,json=workflowDefinition,proto3" json:"workflow_definition,omitempty"`
	// contains filtered or unexported fields
}

ValidateWorkflowDefinitionRequest is the request object for validating a flow definition

func (*ValidateWorkflowDefinitionRequest) Descriptor deprecated added in v1.7.38 

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

Deprecated: Use ValidateWorkflowDefinitionRequest.ProtoReflect.Descriptor instead.

func (*ValidateWorkflowDefinitionRequest) GetWorkflowDefinition added in v1.7.38 

func (x *ValidateWorkflowDefinitionRequest) GetWorkflowDefinition() *PersistedWorkflowDefinition

func (*ValidateWorkflowDefinitionRequest) ProtoMessage added in v1.7.38 

func (*ValidateWorkflowDefinitionRequest) ProtoMessage()

func (*ValidateWorkflowDefinitionRequest) ProtoReflect added in v1.7.38 

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

func (*ValidateWorkflowDefinitionRequest) Reset added in v1.7.38 

func (x *ValidateWorkflowDefinitionRequest) Reset()

func (*ValidateWorkflowDefinitionRequest) String added in v1.7.38 

func (x *ValidateWorkflowDefinitionRequest) String() string

type ValidateWorkflowDefinitionResponse added in v1.7.38 

type ValidateWorkflowDefinitionResponse struct {

	// valid is true if the flow definition is valid, false otherwise
	Valid bool `protobuf:"varint,1,opt,name=valid,proto3" json:"valid,omitempty"`
	// error is the error message if the flow definition is invalid
	Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

ValidateWorkflowDefinitionResponse is the response object for validating a flow definition

func (*ValidateWorkflowDefinitionResponse) Descriptor deprecated added in v1.7.38 

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

Deprecated: Use ValidateWorkflowDefinitionResponse.ProtoReflect.Descriptor instead.

func (*ValidateWorkflowDefinitionResponse) GetError added in v1.7.38 

func (x *ValidateWorkflowDefinitionResponse) GetError() string

func (*ValidateWorkflowDefinitionResponse) GetValid added in v1.7.38 

func (x *ValidateWorkflowDefinitionResponse) GetValid() bool

func (*ValidateWorkflowDefinitionResponse) ProtoMessage added in v1.7.38 

func (*ValidateWorkflowDefinitionResponse) ProtoMessage()

func (*ValidateWorkflowDefinitionResponse) ProtoReflect added in v1.7.38 

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

func (*ValidateWorkflowDefinitionResponse) Reset added in v1.7.38 

func (x *ValidateWorkflowDefinitionResponse) Reset()

func (*ValidateWorkflowDefinitionResponse) String added in v1.7.38 

func (x *ValidateWorkflowDefinitionResponse) String() string

type WorkflowDefinitionPersistServiceClient added in v1.7.38 

type WorkflowDefinitionPersistServiceClient interface {
	// CreateWorkflowDefinition creates a new flow definition in the database
	CreateWorkflowDefinition(ctx context.Context, in *CreateWorkflowDefinitionRequest, opts ...grpc.CallOption) (*CreateWorkflowDefinitionResponse, error)
	// GetWorkflowDefinition retrieves a flow definition from the database
	GetWorkflowDefinition(ctx context.Context, in *GetWorkflowDefinitionRequest, opts ...grpc.CallOption) (*GetWorkflowDefinitionResponse, error)
	// ListWorkflowDefinitions retrieves a list of flow definitions from the database optionally filtered by the owning application
	// if application is not specified, all flow definitions for the org are returned
	ListWorkflowDefinitions(ctx context.Context, in *ListWorkflowDefinitionsRequest, opts ...grpc.CallOption) (WorkflowDefinitionPersistService_ListWorkflowDefinitionsClient, error)
	// UpdateWorkflowDefinition updates a flow definition in the database. Only the name, description and definition graph itself are updated
	UpdateWorkflowDefinition(ctx context.Context, in *UpdateWorkflowDefinitionRequest, opts ...grpc.CallOption) (*UpdateWorkflowDefinitionResponse, error)
	// DeleteWorkflowDefinition deletes a flow definition from the database
	DeleteWorkflowDefinition(ctx context.Context, in *DeleteWorkflowDefinitionRequest, opts ...grpc.CallOption) (*DeleteWorkflowDefinitionResponse, error)
	// ValidateWorkflowDefinition validates a flow definition in the database. Only the name, description and definition graph itself are updated
	ValidateWorkflowDefinition(ctx context.Context, in *ValidateWorkflowDefinitionRequest, opts ...grpc.CallOption) (*ValidateWorkflowDefinitionResponse, error)
}

WorkflowDefinitionPersistServiceClient is the client API for WorkflowDefinitionPersistService 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.

WorkflowDefinitionPersistService is the service that provides CRUD operations for workflow definitions. PERMISSION_WORKFLOWS is required for all operations

func NewWorkflowDefinitionPersistServiceClient added in v1.7.38 

func NewWorkflowDefinitionPersistServiceClient(cc grpc.ClientConnInterface) WorkflowDefinitionPersistServiceClient

type WorkflowDefinitionPersistServiceServer added in v1.7.38 

type WorkflowDefinitionPersistServiceServer interface {
	// CreateWorkflowDefinition creates a new flow definition in the database
	CreateWorkflowDefinition(context.Context, *CreateWorkflowDefinitionRequest) (*CreateWorkflowDefinitionResponse, error)
	// GetWorkflowDefinition retrieves a flow definition from the database
	GetWorkflowDefinition(context.Context, *GetWorkflowDefinitionRequest) (*GetWorkflowDefinitionResponse, error)
	// ListWorkflowDefinitions retrieves a list of flow definitions from the database optionally filtered by the owning application
	// if application is not specified, all flow definitions for the org are returned
	ListWorkflowDefinitions(*ListWorkflowDefinitionsRequest, WorkflowDefinitionPersistService_ListWorkflowDefinitionsServer) error
	// UpdateWorkflowDefinition updates a flow definition in the database. Only the name, description and definition graph itself are updated
	UpdateWorkflowDefinition(context.Context, *UpdateWorkflowDefinitionRequest) (*UpdateWorkflowDefinitionResponse, error)
	// DeleteWorkflowDefinition deletes a flow definition from the database
	DeleteWorkflowDefinition(context.Context, *DeleteWorkflowDefinitionRequest) (*DeleteWorkflowDefinitionResponse, error)
	// ValidateWorkflowDefinition validates a flow definition in the database. Only the name, description and definition graph itself are updated
	ValidateWorkflowDefinition(context.Context, *ValidateWorkflowDefinitionRequest) (*ValidateWorkflowDefinitionResponse, error)
	// contains filtered or unexported methods
}

WorkflowDefinitionPersistServiceServer is the server API for WorkflowDefinitionPersistService service. All implementations must embed UnimplementedWorkflowDefinitionPersistServiceServer for forward compatibility.

WorkflowDefinitionPersistService is the service that provides CRUD operations for workflow definitions. PERMISSION_WORKFLOWS is required for all operations

type WorkflowDefinitionPersistService_ListWorkflowDefinitionsClient added in v1.7.38 

type WorkflowDefinitionPersistService_ListWorkflowDefinitionsClient interface {
	Recv() (*ListWorkflowDefinitionsResponse, error)
	grpc.ClientStream
}

type WorkflowDefinitionPersistService_ListWorkflowDefinitionsServer added in v1.7.38 

type WorkflowDefinitionPersistService_ListWorkflowDefinitionsServer interface {
	Send(*ListWorkflowDefinitionsResponse) error
	grpc.ServerStream
}

Source Files

View all Source files

Directories

Path Synopsis

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.