pjs

package
v2.9.4 Latest Latest
Warning

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

Go to latest
Published: Apr 8, 2024 License: Apache-2.0 Imports: 29 Imported by: 0

Documentation

Overview

Package pjs is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source
const (
	API_CreateJob_FullMethodName    = "/pjs.API/CreateJob"
	API_CancelJob_FullMethodName    = "/pjs.API/CancelJob"
	API_DeleteJob_FullMethodName    = "/pjs.API/DeleteJob"
	API_ListJob_FullMethodName      = "/pjs.API/ListJob"
	API_WalkJob_FullMethodName      = "/pjs.API/WalkJob"
	API_InspectJob_FullMethodName   = "/pjs.API/InspectJob"
	API_ProcessQueue_FullMethodName = "/pjs.API/ProcessQueue"
	API_ListQueue_FullMethodName    = "/pjs.API/ListQueue"
	API_InspectQueue_FullMethodName = "/pjs.API/InspectQueue"
)

Variables

View Source
var (
	JobState_name = map[int32]string{
		0: "JobState_UNSPECIFIED",
		1: "QUEUED",
		2: "PROCESSING",
		3: "DONE",
	}
	JobState_value = map[string]int32{
		"JobState_UNSPECIFIED": 0,
		"QUEUED":               1,
		"PROCESSING":           2,
		"DONE":                 3,
	}
)

Enum value maps for JobState.

View Source
var (
	JobErrorCode_name = map[int32]string{
		0: "JobErrorCode_UNSPECIFIED",
		1: "FAILED",
		2: "DISCONNECTED",
		3: "CANCELED",
	}
	JobErrorCode_value = map[string]int32{
		"JobErrorCode_UNSPECIFIED": 0,
		"FAILED":                   1,
		"DISCONNECTED":             2,
		"CANCELED":                 3,
	}
)

Enum value maps for JobErrorCode.

View Source
var API_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "pjs.API",
	HandlerType: (*APIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateJob",
			Handler:    _API_CreateJob_Handler,
		},
		{
			MethodName: "CancelJob",
			Handler:    _API_CancelJob_Handler,
		},
		{
			MethodName: "DeleteJob",
			Handler:    _API_DeleteJob_Handler,
		},
		{
			MethodName: "InspectJob",
			Handler:    _API_InspectJob_Handler,
		},
		{
			MethodName: "InspectQueue",
			Handler:    _API_InspectQueue_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "ListJob",
			Handler:       _API_ListJob_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "WalkJob",
			Handler:       _API_WalkJob_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "ProcessQueue",
			Handler:       _API_ProcessQueue_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "ListQueue",
			Handler:       _API_ListQueue_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "pjs/pjs.proto",
}

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

View Source
var File_pjs_pjs_proto protoreflect.FileDescriptor

Functions

func RegisterAPIHandler

func RegisterAPIHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterAPIHandler registers the http handlers for service API to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterAPIHandlerClient

func RegisterAPIHandlerClient(ctx context.Context, mux *runtime.ServeMux, client APIClient) error

RegisterAPIHandlerClient registers the http handlers for service API to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "APIClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "APIClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "APIClient" to call the correct interceptors.

func RegisterAPIHandlerFromEndpoint

func RegisterAPIHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterAPIHandlerFromEndpoint is same as RegisterAPIHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterAPIHandlerServer

func RegisterAPIHandlerServer(ctx context.Context, mux *runtime.ServeMux, server APIServer) error

RegisterAPIHandlerServer registers the http handlers for service API to "mux". UnaryRPC :call APIServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterAPIHandlerFromEndpoint instead.

func RegisterAPIServer

func RegisterAPIServer(s grpc.ServiceRegistrar, srv APIServer)

Types

type APIClient

type APIClient interface {
	// CreateJob creates a new job.
	// Child jobs can be created by setting the context field to the appropriate parent job context.
	CreateJob(ctx context.Context, in *CreateJobRequest, opts ...grpc.CallOption) (*CreateJobResponse, error)
	// CancelJob cancels a job.
	// Canceling a job transitions all of the associated QUEUED and PROCESSING jobs to the DONE state and sets their error codes to CANCELED.
	// This will terminate all ongoing processing associated with the job.
	// Nothing will be deleted.
	// A job can only be canceled with the parent job context.
	CancelJob(ctx context.Context, in *CancelJobRequest, opts ...grpc.CallOption) (*CancelJobResponse, error)
	// DeleteJob deletes a job.
	// DeleteJob first cancels the job, then deletes all of the metadata and filesets associated with the job.
	// A job can only be deleted with the parent job context.
	DeleteJob(ctx context.Context, in *DeleteJobRequest, opts ...grpc.CallOption) (*DeleteJobResponse, error)
	// ListJob returns a list of jobs and information about each job.
	// The jobs returned in the list are the child jobs of the provided job.
	// If no job is provided, the list is the child jobs of the provided job context.
	// The provided job must be associated with the provided job context or a descendant of the job associated with the provided job context.
	ListJob(ctx context.Context, in *ListJobRequest, opts ...grpc.CallOption) (API_ListJobClient, error)
	// WalkJob returns a list of jobs in a hierarchy and information about each job.
	// Walking a job traverses the job hierarchy rooted at the provided job.
	// The provided job must be associated with the provided job context or a descendant of the job associated with the provided job context.
	WalkJob(ctx context.Context, in *WalkJobRequest, opts ...grpc.CallOption) (API_WalkJobClient, error)
	// InspectJob returns detailed information about a job.
	InspectJob(ctx context.Context, in *InspectJobRequest, opts ...grpc.CallOption) (*InspectJobResponse, error)
	// ProcessQueue should be called by workers to process jobs in a queue.
	// The protocol is as follows:
	//
	//	Worker sends an initial request with the queue id.
	//	For each job:
	//	  Server sends a response with a job context and the associated queue element.
	//	  Worker processes the job.
	//	  Worker sends a request with the job output or indicates that the job failed.
	//
	// This RPC should generally be run indefinitely. Workers will be scaled based on demand, so the expectation is that they should be processing queues while they are up.
	// This RPC will be canceled by the server if the current job is canceled. Workers should generally retry the RPC when disconnects occur.
	ProcessQueue(ctx context.Context, opts ...grpc.CallOption) (API_ProcessQueueClient, error)
	// ListQueue returns a list of queues and information about each queue.
	ListQueue(ctx context.Context, in *ListQueueRequest, opts ...grpc.CallOption) (API_ListQueueClient, error)
	// InspectQueue returns detailed information about a queue.
	InspectQueue(ctx context.Context, in *InspectQueueRequest, opts ...grpc.CallOption) (*InspectQueueResponse, error)
}

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

func NewAPIClient

func NewAPIClient(cc grpc.ClientConnInterface) APIClient

type APIServer

type APIServer interface {
	// CreateJob creates a new job.
	// Child jobs can be created by setting the context field to the appropriate parent job context.
	CreateJob(context.Context, *CreateJobRequest) (*CreateJobResponse, error)
	// CancelJob cancels a job.
	// Canceling a job transitions all of the associated QUEUED and PROCESSING jobs to the DONE state and sets their error codes to CANCELED.
	// This will terminate all ongoing processing associated with the job.
	// Nothing will be deleted.
	// A job can only be canceled with the parent job context.
	CancelJob(context.Context, *CancelJobRequest) (*CancelJobResponse, error)
	// DeleteJob deletes a job.
	// DeleteJob first cancels the job, then deletes all of the metadata and filesets associated with the job.
	// A job can only be deleted with the parent job context.
	DeleteJob(context.Context, *DeleteJobRequest) (*DeleteJobResponse, error)
	// ListJob returns a list of jobs and information about each job.
	// The jobs returned in the list are the child jobs of the provided job.
	// If no job is provided, the list is the child jobs of the provided job context.
	// The provided job must be associated with the provided job context or a descendant of the job associated with the provided job context.
	ListJob(*ListJobRequest, API_ListJobServer) error
	// WalkJob returns a list of jobs in a hierarchy and information about each job.
	// Walking a job traverses the job hierarchy rooted at the provided job.
	// The provided job must be associated with the provided job context or a descendant of the job associated with the provided job context.
	WalkJob(*WalkJobRequest, API_WalkJobServer) error
	// InspectJob returns detailed information about a job.
	InspectJob(context.Context, *InspectJobRequest) (*InspectJobResponse, error)
	// ProcessQueue should be called by workers to process jobs in a queue.
	// The protocol is as follows:
	//
	//	Worker sends an initial request with the queue id.
	//	For each job:
	//	  Server sends a response with a job context and the associated queue element.
	//	  Worker processes the job.
	//	  Worker sends a request with the job output or indicates that the job failed.
	//
	// This RPC should generally be run indefinitely. Workers will be scaled based on demand, so the expectation is that they should be processing queues while they are up.
	// This RPC will be canceled by the server if the current job is canceled. Workers should generally retry the RPC when disconnects occur.
	ProcessQueue(API_ProcessQueueServer) error
	// ListQueue returns a list of queues and information about each queue.
	ListQueue(*ListQueueRequest, API_ListQueueServer) error
	// InspectQueue returns detailed information about a queue.
	InspectQueue(context.Context, *InspectQueueRequest) (*InspectQueueResponse, error)
	// contains filtered or unexported methods
}

APIServer is the server API for API service. All implementations must embed UnimplementedAPIServer for forward compatibility

type API_ListJobClient

type API_ListJobClient interface {
	Recv() (*ListJobResponse, error)
	grpc.ClientStream
}

type API_ListJobServer

type API_ListJobServer interface {
	Send(*ListJobResponse) error
	grpc.ServerStream
}

type API_ListQueueClient

type API_ListQueueClient interface {
	Recv() (*ListQueueResponse, error)
	grpc.ClientStream
}

type API_ListQueueServer

type API_ListQueueServer interface {
	Send(*ListQueueResponse) error
	grpc.ServerStream
}

type API_ProcessQueueClient

type API_ProcessQueueClient interface {
	Send(*ProcessQueueRequest) error
	Recv() (*ProcessQueueResponse, error)
	grpc.ClientStream
}

type API_ProcessQueueServer

type API_ProcessQueueServer interface {
	Send(*ProcessQueueResponse) error
	Recv() (*ProcessQueueRequest, error)
	grpc.ServerStream
}

type API_WalkJobClient

type API_WalkJobClient interface {
	Recv() (*ListJobResponse, error)
	grpc.ClientStream
}

type API_WalkJobServer

type API_WalkJobServer interface {
	Send(*ListJobResponse) error
	grpc.ServerStream
}

type CancelJobRequest

type CancelJobRequest struct {

	// context is a bearer token used when calling from within a running Job.
	Context string `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"`
	Job     *Job   `protobuf:"bytes,2,opt,name=job,proto3" json:"job,omitempty"`
	// contains filtered or unexported fields
}

func (*CancelJobRequest) Descriptor deprecated

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

Deprecated: Use CancelJobRequest.ProtoReflect.Descriptor instead.

func (*CancelJobRequest) GetContext

func (x *CancelJobRequest) GetContext() string

func (*CancelJobRequest) GetJob

func (x *CancelJobRequest) GetJob() *Job

func (*CancelJobRequest) MarshalLogObject

func (x *CancelJobRequest) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*CancelJobRequest) ProtoMessage

func (*CancelJobRequest) ProtoMessage()

func (*CancelJobRequest) ProtoReflect

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

func (*CancelJobRequest) Reset

func (x *CancelJobRequest) Reset()

func (*CancelJobRequest) String

func (x *CancelJobRequest) String() string

func (*CancelJobRequest) Validate

func (m *CancelJobRequest) Validate() error

Validate checks the field values on CancelJobRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*CancelJobRequest) ValidateAll

func (m *CancelJobRequest) ValidateAll() error

ValidateAll checks the field values on CancelJobRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in CancelJobRequestMultiError, or nil if none found.

type CancelJobRequestMultiError

type CancelJobRequestMultiError []error

CancelJobRequestMultiError is an error wrapping multiple validation errors returned by CancelJobRequest.ValidateAll() if the designated constraints aren't met.

func (CancelJobRequestMultiError) AllErrors

func (m CancelJobRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CancelJobRequestMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type CancelJobRequestValidationError

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

CancelJobRequestValidationError is the validation error returned by CancelJobRequest.Validate if the designated constraints aren't met.

func (CancelJobRequestValidationError) Cause

Cause function returns cause value.

func (CancelJobRequestValidationError) Error

Error satisfies the builtin error interface

func (CancelJobRequestValidationError) ErrorName

ErrorName returns error name.

func (CancelJobRequestValidationError) Field

Field function returns field value.

func (CancelJobRequestValidationError) Key

Key function returns key value.

func (CancelJobRequestValidationError) Reason

Reason function returns reason value.

type CancelJobResponse

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

func (*CancelJobResponse) Descriptor deprecated

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

Deprecated: Use CancelJobResponse.ProtoReflect.Descriptor instead.

func (*CancelJobResponse) MarshalLogObject

func (x *CancelJobResponse) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*CancelJobResponse) ProtoMessage

func (*CancelJobResponse) ProtoMessage()

func (*CancelJobResponse) ProtoReflect

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

func (*CancelJobResponse) Reset

func (x *CancelJobResponse) Reset()

func (*CancelJobResponse) String

func (x *CancelJobResponse) String() string

func (*CancelJobResponse) Validate

func (m *CancelJobResponse) Validate() error

Validate checks the field values on CancelJobResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*CancelJobResponse) ValidateAll

func (m *CancelJobResponse) ValidateAll() error

ValidateAll checks the field values on CancelJobResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in CancelJobResponseMultiError, or nil if none found.

type CancelJobResponseMultiError

type CancelJobResponseMultiError []error

CancelJobResponseMultiError is an error wrapping multiple validation errors returned by CancelJobResponse.ValidateAll() if the designated constraints aren't met.

func (CancelJobResponseMultiError) AllErrors

func (m CancelJobResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CancelJobResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type CancelJobResponseValidationError

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

CancelJobResponseValidationError is the validation error returned by CancelJobResponse.Validate if the designated constraints aren't met.

func (CancelJobResponseValidationError) Cause

Cause function returns cause value.

func (CancelJobResponseValidationError) Error

Error satisfies the builtin error interface

func (CancelJobResponseValidationError) ErrorName

ErrorName returns error name.

func (CancelJobResponseValidationError) Field

Field function returns field value.

func (CancelJobResponseValidationError) Key

Key function returns key value.

func (CancelJobResponseValidationError) Reason

Reason function returns reason value.

type CreateJobRequest

type CreateJobRequest struct {

	// context is a bearer token used when calling from within a running Job.
	Context    string        `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"`
	Spec       *anypb.Any    `protobuf:"bytes,2,opt,name=spec,proto3" json:"spec,omitempty"`
	Input      *QueueElement `protobuf:"bytes,3,opt,name=input,proto3" json:"input,omitempty"`
	CacheRead  bool          `protobuf:"varint,4,opt,name=cache_read,json=cacheRead,proto3" json:"cache_read,omitempty"`
	CacheWrite bool          `protobuf:"varint,5,opt,name=cache_write,json=cacheWrite,proto3" json:"cache_write,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateJobRequest) Descriptor deprecated

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

Deprecated: Use CreateJobRequest.ProtoReflect.Descriptor instead.

func (*CreateJobRequest) GetCacheRead

func (x *CreateJobRequest) GetCacheRead() bool

func (*CreateJobRequest) GetCacheWrite

func (x *CreateJobRequest) GetCacheWrite() bool

func (*CreateJobRequest) GetContext

func (x *CreateJobRequest) GetContext() string

func (*CreateJobRequest) GetInput

func (x *CreateJobRequest) GetInput() *QueueElement

func (*CreateJobRequest) GetSpec

func (x *CreateJobRequest) GetSpec() *anypb.Any

func (*CreateJobRequest) MarshalLogObject

func (x *CreateJobRequest) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*CreateJobRequest) ProtoMessage

func (*CreateJobRequest) ProtoMessage()

func (*CreateJobRequest) ProtoReflect

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

func (*CreateJobRequest) Reset

func (x *CreateJobRequest) Reset()

func (*CreateJobRequest) String

func (x *CreateJobRequest) String() string

func (*CreateJobRequest) Validate

func (m *CreateJobRequest) Validate() error

Validate checks the field values on CreateJobRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*CreateJobRequest) ValidateAll

func (m *CreateJobRequest) ValidateAll() error

ValidateAll checks the field values on CreateJobRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in CreateJobRequestMultiError, or nil if none found.

type CreateJobRequestMultiError

type CreateJobRequestMultiError []error

CreateJobRequestMultiError is an error wrapping multiple validation errors returned by CreateJobRequest.ValidateAll() if the designated constraints aren't met.

func (CreateJobRequestMultiError) AllErrors

func (m CreateJobRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CreateJobRequestMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type CreateJobRequestValidationError

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

CreateJobRequestValidationError is the validation error returned by CreateJobRequest.Validate if the designated constraints aren't met.

func (CreateJobRequestValidationError) Cause

Cause function returns cause value.

func (CreateJobRequestValidationError) Error

Error satisfies the builtin error interface

func (CreateJobRequestValidationError) ErrorName

ErrorName returns error name.

func (CreateJobRequestValidationError) Field

Field function returns field value.

func (CreateJobRequestValidationError) Key

Key function returns key value.

func (CreateJobRequestValidationError) Reason

Reason function returns reason value.

type CreateJobResponse

type CreateJobResponse struct {
	Id *Job `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateJobResponse) Descriptor deprecated

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

Deprecated: Use CreateJobResponse.ProtoReflect.Descriptor instead.

func (*CreateJobResponse) GetId

func (x *CreateJobResponse) GetId() *Job

func (*CreateJobResponse) MarshalLogObject

func (x *CreateJobResponse) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*CreateJobResponse) ProtoMessage

func (*CreateJobResponse) ProtoMessage()

func (*CreateJobResponse) ProtoReflect

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

func (*CreateJobResponse) Reset

func (x *CreateJobResponse) Reset()

func (*CreateJobResponse) String

func (x *CreateJobResponse) String() string

func (*CreateJobResponse) Validate

func (m *CreateJobResponse) Validate() error

Validate checks the field values on CreateJobResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*CreateJobResponse) ValidateAll

func (m *CreateJobResponse) ValidateAll() error

ValidateAll checks the field values on CreateJobResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in CreateJobResponseMultiError, or nil if none found.

type CreateJobResponseMultiError

type CreateJobResponseMultiError []error

CreateJobResponseMultiError is an error wrapping multiple validation errors returned by CreateJobResponse.ValidateAll() if the designated constraints aren't met.

func (CreateJobResponseMultiError) AllErrors

func (m CreateJobResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CreateJobResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type CreateJobResponseValidationError

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

CreateJobResponseValidationError is the validation error returned by CreateJobResponse.Validate if the designated constraints aren't met.

func (CreateJobResponseValidationError) Cause

Cause function returns cause value.

func (CreateJobResponseValidationError) Error

Error satisfies the builtin error interface

func (CreateJobResponseValidationError) ErrorName

ErrorName returns error name.

func (CreateJobResponseValidationError) Field

Field function returns field value.

func (CreateJobResponseValidationError) Key

Key function returns key value.

func (CreateJobResponseValidationError) Reason

Reason function returns reason value.

type DeleteJobRequest

type DeleteJobRequest struct {

	// context is a bearer token used when calling from within a running Job.
	Context string `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"`
	Job     *Job   `protobuf:"bytes,2,opt,name=job,proto3" json:"job,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteJobRequest) Descriptor deprecated

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

Deprecated: Use DeleteJobRequest.ProtoReflect.Descriptor instead.

func (*DeleteJobRequest) GetContext

func (x *DeleteJobRequest) GetContext() string

func (*DeleteJobRequest) GetJob

func (x *DeleteJobRequest) GetJob() *Job

func (*DeleteJobRequest) MarshalLogObject

func (x *DeleteJobRequest) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*DeleteJobRequest) ProtoMessage

func (*DeleteJobRequest) ProtoMessage()

func (*DeleteJobRequest) ProtoReflect

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

func (*DeleteJobRequest) Reset

func (x *DeleteJobRequest) Reset()

func (*DeleteJobRequest) String

func (x *DeleteJobRequest) String() string

func (*DeleteJobRequest) Validate

func (m *DeleteJobRequest) Validate() error

Validate checks the field values on DeleteJobRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*DeleteJobRequest) ValidateAll

func (m *DeleteJobRequest) ValidateAll() error

ValidateAll checks the field values on DeleteJobRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in DeleteJobRequestMultiError, or nil if none found.

type DeleteJobRequestMultiError

type DeleteJobRequestMultiError []error

DeleteJobRequestMultiError is an error wrapping multiple validation errors returned by DeleteJobRequest.ValidateAll() if the designated constraints aren't met.

func (DeleteJobRequestMultiError) AllErrors

func (m DeleteJobRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (DeleteJobRequestMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type DeleteJobRequestValidationError

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

DeleteJobRequestValidationError is the validation error returned by DeleteJobRequest.Validate if the designated constraints aren't met.

func (DeleteJobRequestValidationError) Cause

Cause function returns cause value.

func (DeleteJobRequestValidationError) Error

Error satisfies the builtin error interface

func (DeleteJobRequestValidationError) ErrorName

ErrorName returns error name.

func (DeleteJobRequestValidationError) Field

Field function returns field value.

func (DeleteJobRequestValidationError) Key

Key function returns key value.

func (DeleteJobRequestValidationError) Reason

Reason function returns reason value.

type DeleteJobResponse

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

func (*DeleteJobResponse) Descriptor deprecated

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

Deprecated: Use DeleteJobResponse.ProtoReflect.Descriptor instead.

func (*DeleteJobResponse) MarshalLogObject

func (x *DeleteJobResponse) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*DeleteJobResponse) ProtoMessage

func (*DeleteJobResponse) ProtoMessage()

func (*DeleteJobResponse) ProtoReflect

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

func (*DeleteJobResponse) Reset

func (x *DeleteJobResponse) Reset()

func (*DeleteJobResponse) String

func (x *DeleteJobResponse) String() string

func (*DeleteJobResponse) Validate

func (m *DeleteJobResponse) Validate() error

Validate checks the field values on DeleteJobResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*DeleteJobResponse) ValidateAll

func (m *DeleteJobResponse) ValidateAll() error

ValidateAll checks the field values on DeleteJobResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in DeleteJobResponseMultiError, or nil if none found.

type DeleteJobResponseMultiError

type DeleteJobResponseMultiError []error

DeleteJobResponseMultiError is an error wrapping multiple validation errors returned by DeleteJobResponse.ValidateAll() if the designated constraints aren't met.

func (DeleteJobResponseMultiError) AllErrors

func (m DeleteJobResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (DeleteJobResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type DeleteJobResponseValidationError

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

DeleteJobResponseValidationError is the validation error returned by DeleteJobResponse.Validate if the designated constraints aren't met.

func (DeleteJobResponseValidationError) Cause

Cause function returns cause value.

func (DeleteJobResponseValidationError) Error

Error satisfies the builtin error interface

func (DeleteJobResponseValidationError) ErrorName

ErrorName returns error name.

func (DeleteJobResponseValidationError) Field

Field function returns field value.

func (DeleteJobResponseValidationError) Key

Key function returns key value.

func (DeleteJobResponseValidationError) Reason

Reason function returns reason value.

type InspectJobRequest

type InspectJobRequest struct {

	// context is a bearer token used when calling from within a running Job.
	Context string `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"`
	// job is the job to start walking from.  If unset the context Job is assumed.
	Job *Job `protobuf:"bytes,2,opt,name=job,proto3" json:"job,omitempty"`
	// contains filtered or unexported fields
}

func (*InspectJobRequest) Descriptor deprecated

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

Deprecated: Use InspectJobRequest.ProtoReflect.Descriptor instead.

func (*InspectJobRequest) GetContext

func (x *InspectJobRequest) GetContext() string

func (*InspectJobRequest) GetJob

func (x *InspectJobRequest) GetJob() *Job

func (*InspectJobRequest) MarshalLogObject

func (x *InspectJobRequest) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*InspectJobRequest) ProtoMessage

func (*InspectJobRequest) ProtoMessage()

func (*InspectJobRequest) ProtoReflect

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

func (*InspectJobRequest) Reset

func (x *InspectJobRequest) Reset()

func (*InspectJobRequest) String

func (x *InspectJobRequest) String() string

func (*InspectJobRequest) Validate

func (m *InspectJobRequest) Validate() error

Validate checks the field values on InspectJobRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*InspectJobRequest) ValidateAll

func (m *InspectJobRequest) ValidateAll() error

ValidateAll checks the field values on InspectJobRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in InspectJobRequestMultiError, or nil if none found.

type InspectJobRequestMultiError

type InspectJobRequestMultiError []error

InspectJobRequestMultiError is an error wrapping multiple validation errors returned by InspectJobRequest.ValidateAll() if the designated constraints aren't met.

func (InspectJobRequestMultiError) AllErrors

func (m InspectJobRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (InspectJobRequestMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type InspectJobRequestValidationError

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

InspectJobRequestValidationError is the validation error returned by InspectJobRequest.Validate if the designated constraints aren't met.

func (InspectJobRequestValidationError) Cause

Cause function returns cause value.

func (InspectJobRequestValidationError) Error

Error satisfies the builtin error interface

func (InspectJobRequestValidationError) ErrorName

ErrorName returns error name.

func (InspectJobRequestValidationError) Field

Field function returns field value.

func (InspectJobRequestValidationError) Key

Key function returns key value.

func (InspectJobRequestValidationError) Reason

Reason function returns reason value.

type InspectJobResponse

type InspectJobResponse struct {
	Details *JobInfoDetails `protobuf:"bytes,1,opt,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

func (*InspectJobResponse) Descriptor deprecated

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

Deprecated: Use InspectJobResponse.ProtoReflect.Descriptor instead.

func (*InspectJobResponse) GetDetails

func (x *InspectJobResponse) GetDetails() *JobInfoDetails

func (*InspectJobResponse) MarshalLogObject

func (x *InspectJobResponse) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*InspectJobResponse) ProtoMessage

func (*InspectJobResponse) ProtoMessage()

func (*InspectJobResponse) ProtoReflect

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

func (*InspectJobResponse) Reset

func (x *InspectJobResponse) Reset()

func (*InspectJobResponse) String

func (x *InspectJobResponse) String() string

func (*InspectJobResponse) Validate

func (m *InspectJobResponse) Validate() error

Validate checks the field values on InspectJobResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*InspectJobResponse) ValidateAll

func (m *InspectJobResponse) ValidateAll() error

ValidateAll checks the field values on InspectJobResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in InspectJobResponseMultiError, or nil if none found.

type InspectJobResponseMultiError

type InspectJobResponseMultiError []error

InspectJobResponseMultiError is an error wrapping multiple validation errors returned by InspectJobResponse.ValidateAll() if the designated constraints aren't met.

func (InspectJobResponseMultiError) AllErrors

func (m InspectJobResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (InspectJobResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type InspectJobResponseValidationError

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

InspectJobResponseValidationError is the validation error returned by InspectJobResponse.Validate if the designated constraints aren't met.

func (InspectJobResponseValidationError) Cause

Cause function returns cause value.

func (InspectJobResponseValidationError) Error

Error satisfies the builtin error interface

func (InspectJobResponseValidationError) ErrorName

ErrorName returns error name.

func (InspectJobResponseValidationError) Field

Field function returns field value.

func (InspectJobResponseValidationError) Key

Key function returns key value.

func (InspectJobResponseValidationError) Reason

Reason function returns reason value.

type InspectQueueRequest

type InspectQueueRequest struct {
	Queue *Queue `protobuf:"bytes,1,opt,name=queue,proto3" json:"queue,omitempty"`
	// contains filtered or unexported fields
}

func (*InspectQueueRequest) Descriptor deprecated

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

Deprecated: Use InspectQueueRequest.ProtoReflect.Descriptor instead.

func (*InspectQueueRequest) GetQueue

func (x *InspectQueueRequest) GetQueue() *Queue

func (*InspectQueueRequest) MarshalLogObject

func (x *InspectQueueRequest) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*InspectQueueRequest) ProtoMessage

func (*InspectQueueRequest) ProtoMessage()

func (*InspectQueueRequest) ProtoReflect

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

func (*InspectQueueRequest) Reset

func (x *InspectQueueRequest) Reset()

func (*InspectQueueRequest) String

func (x *InspectQueueRequest) String() string

func (*InspectQueueRequest) Validate

func (m *InspectQueueRequest) Validate() error

Validate checks the field values on InspectQueueRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*InspectQueueRequest) ValidateAll

func (m *InspectQueueRequest) ValidateAll() error

ValidateAll checks the field values on InspectQueueRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in InspectQueueRequestMultiError, or nil if none found.

type InspectQueueRequestMultiError

type InspectQueueRequestMultiError []error

InspectQueueRequestMultiError is an error wrapping multiple validation errors returned by InspectQueueRequest.ValidateAll() if the designated constraints aren't met.

func (InspectQueueRequestMultiError) AllErrors

func (m InspectQueueRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (InspectQueueRequestMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type InspectQueueRequestValidationError

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

InspectQueueRequestValidationError is the validation error returned by InspectQueueRequest.Validate if the designated constraints aren't met.

func (InspectQueueRequestValidationError) Cause

Cause function returns cause value.

func (InspectQueueRequestValidationError) Error

Error satisfies the builtin error interface

func (InspectQueueRequestValidationError) ErrorName

ErrorName returns error name.

func (InspectQueueRequestValidationError) Field

Field function returns field value.

func (InspectQueueRequestValidationError) Key

Key function returns key value.

func (InspectQueueRequestValidationError) Reason

Reason function returns reason value.

type InspectQueueResponse

type InspectQueueResponse struct {
	Details *QueueInfoDetails `protobuf:"bytes,1,opt,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

func (*InspectQueueResponse) Descriptor deprecated

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

Deprecated: Use InspectQueueResponse.ProtoReflect.Descriptor instead.

func (*InspectQueueResponse) GetDetails

func (x *InspectQueueResponse) GetDetails() *QueueInfoDetails

func (*InspectQueueResponse) MarshalLogObject

func (x *InspectQueueResponse) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*InspectQueueResponse) ProtoMessage

func (*InspectQueueResponse) ProtoMessage()

func (*InspectQueueResponse) ProtoReflect

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

func (*InspectQueueResponse) Reset

func (x *InspectQueueResponse) Reset()

func (*InspectQueueResponse) String

func (x *InspectQueueResponse) String() string

func (*InspectQueueResponse) Validate

func (m *InspectQueueResponse) Validate() error

Validate checks the field values on InspectQueueResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*InspectQueueResponse) ValidateAll

func (m *InspectQueueResponse) ValidateAll() error

ValidateAll checks the field values on InspectQueueResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in InspectQueueResponseMultiError, or nil if none found.

type InspectQueueResponseMultiError

type InspectQueueResponseMultiError []error

InspectQueueResponseMultiError is an error wrapping multiple validation errors returned by InspectQueueResponse.ValidateAll() if the designated constraints aren't met.

func (InspectQueueResponseMultiError) AllErrors

func (m InspectQueueResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (InspectQueueResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type InspectQueueResponseValidationError

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

InspectQueueResponseValidationError is the validation error returned by InspectQueueResponse.Validate if the designated constraints aren't met.

func (InspectQueueResponseValidationError) Cause

Cause function returns cause value.

func (InspectQueueResponseValidationError) Error

Error satisfies the builtin error interface

func (InspectQueueResponseValidationError) ErrorName

ErrorName returns error name.

func (InspectQueueResponseValidationError) Field

Field function returns field value.

func (InspectQueueResponseValidationError) Key

Key function returns key value.

func (InspectQueueResponseValidationError) Reason

Reason function returns reason value.

type Job

type Job struct {
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

Job uniquely identifies a Job Job will be nil to indicate no Job, or an unset Job.

func (*Job) Descriptor deprecated

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

Deprecated: Use Job.ProtoReflect.Descriptor instead.

func (*Job) GetId

func (x *Job) GetId() int64

func (*Job) MarshalLogObject

func (x *Job) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*Job) ProtoMessage

func (*Job) ProtoMessage()

func (*Job) ProtoReflect

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

func (*Job) Reset

func (x *Job) Reset()

func (*Job) String

func (x *Job) String() string

func (*Job) Validate

func (m *Job) Validate() error

Validate checks the field values on Job with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Job) ValidateAll

func (m *Job) ValidateAll() error

ValidateAll checks the field values on Job with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in JobMultiError, or nil if none found.

type JobErrorCode

type JobErrorCode int32
const (
	// UNSPECIFIED means the job error code is unspecified.
	JobErrorCode_JobErrorCode_UNSPECIFIED JobErrorCode = 0
	// FAILED means that the worker processing the job indicated that it failed.
	JobErrorCode_FAILED JobErrorCode = 1
	// DISCONNECTED means the worker processing the job disconnected.
	JobErrorCode_DISCONNECTED JobErrorCode = 2
	// CANCELED means the job was canceled.
	JobErrorCode_CANCELED JobErrorCode = 3
)

func (JobErrorCode) Descriptor

func (JobErrorCode) Enum

func (x JobErrorCode) Enum() *JobErrorCode

func (JobErrorCode) EnumDescriptor deprecated

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

Deprecated: Use JobErrorCode.Descriptor instead.

func (JobErrorCode) Number

func (JobErrorCode) String

func (x JobErrorCode) String() string

func (JobErrorCode) Type

type JobInfo

type JobInfo struct {

	// Job is the Job's identity
	Job *Job `protobuf:"bytes,1,opt,name=job,proto3" json:"job,omitempty"`
	// parent_job is the Job's parent if it exists.
	ParentJob *Job `protobuf:"bytes,2,opt,name=parent_job,json=parentJob,proto3" json:"parent_job,omitempty"`
	// state is the Job's state.
	// See JobState for a description of the possible states.
	State JobState `protobuf:"varint,3,opt,name=state,proto3,enum=pjs.JobState" json:"state,omitempty"`
	// spec is the code specification for the Job.
	Spec *anypb.Any `protobuf:"bytes,4,opt,name=spec,proto3" json:"spec,omitempty"`
	// input is the input data for the Job.
	Input *QueueElement `protobuf:"bytes,5,opt,name=input,proto3" json:"input,omitempty"`
	// result is set when the Job enters the DONE state.
	//
	// Types that are assignable to Result:
	//
	//	*JobInfo_Output
	//	*JobInfo_Error
	Result isJobInfo_Result `protobuf_oneof:"result"`
	// contains filtered or unexported fields
}

JobInfo describes a Job

func (*JobInfo) Descriptor deprecated

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

Deprecated: Use JobInfo.ProtoReflect.Descriptor instead.

func (*JobInfo) GetError

func (x *JobInfo) GetError() JobErrorCode

func (*JobInfo) GetInput

func (x *JobInfo) GetInput() *QueueElement

func (*JobInfo) GetJob

func (x *JobInfo) GetJob() *Job

func (*JobInfo) GetOutput

func (x *JobInfo) GetOutput() *QueueElement

func (*JobInfo) GetParentJob

func (x *JobInfo) GetParentJob() *Job

func (*JobInfo) GetResult

func (m *JobInfo) GetResult() isJobInfo_Result

func (*JobInfo) GetSpec

func (x *JobInfo) GetSpec() *anypb.Any

func (*JobInfo) GetState

func (x *JobInfo) GetState() JobState

func (*JobInfo) MarshalLogObject

func (x *JobInfo) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*JobInfo) ProtoMessage

func (*JobInfo) ProtoMessage()

func (*JobInfo) ProtoReflect

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

func (*JobInfo) Reset

func (x *JobInfo) Reset()

func (*JobInfo) String

func (x *JobInfo) String() string

func (*JobInfo) Validate

func (m *JobInfo) Validate() error

Validate checks the field values on JobInfo with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*JobInfo) ValidateAll

func (m *JobInfo) ValidateAll() error

ValidateAll checks the field values on JobInfo with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in JobInfoMultiError, or nil if none found.

type JobInfoDetails

type JobInfoDetails struct {
	JobInfo *JobInfo `protobuf:"bytes,1,opt,name=job_info,json=jobInfo,proto3" json:"job_info,omitempty"`
	// contains filtered or unexported fields
}

JobInfoDetails is more detailed information about a Job. It contains a superset of the information in JobInfo

func (*JobInfoDetails) Descriptor deprecated

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

Deprecated: Use JobInfoDetails.ProtoReflect.Descriptor instead.

func (*JobInfoDetails) GetJobInfo

func (x *JobInfoDetails) GetJobInfo() *JobInfo

func (*JobInfoDetails) MarshalLogObject

func (x *JobInfoDetails) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*JobInfoDetails) ProtoMessage

func (*JobInfoDetails) ProtoMessage()

func (*JobInfoDetails) ProtoReflect

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

func (*JobInfoDetails) Reset

func (x *JobInfoDetails) Reset()

func (*JobInfoDetails) String

func (x *JobInfoDetails) String() string

func (*JobInfoDetails) Validate

func (m *JobInfoDetails) Validate() error

Validate checks the field values on JobInfoDetails with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*JobInfoDetails) ValidateAll

func (m *JobInfoDetails) ValidateAll() error

ValidateAll checks the field values on JobInfoDetails with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in JobInfoDetailsMultiError, or nil if none found.

type JobInfoDetailsMultiError

type JobInfoDetailsMultiError []error

JobInfoDetailsMultiError is an error wrapping multiple validation errors returned by JobInfoDetails.ValidateAll() if the designated constraints aren't met.

func (JobInfoDetailsMultiError) AllErrors

func (m JobInfoDetailsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (JobInfoDetailsMultiError) Error

func (m JobInfoDetailsMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type JobInfoDetailsValidationError

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

JobInfoDetailsValidationError is the validation error returned by JobInfoDetails.Validate if the designated constraints aren't met.

func (JobInfoDetailsValidationError) Cause

Cause function returns cause value.

func (JobInfoDetailsValidationError) Error

Error satisfies the builtin error interface

func (JobInfoDetailsValidationError) ErrorName

func (e JobInfoDetailsValidationError) ErrorName() string

ErrorName returns error name.

func (JobInfoDetailsValidationError) Field

Field function returns field value.

func (JobInfoDetailsValidationError) Key

Key function returns key value.

func (JobInfoDetailsValidationError) Reason

Reason function returns reason value.

type JobInfoMultiError

type JobInfoMultiError []error

JobInfoMultiError is an error wrapping multiple validation errors returned by JobInfo.ValidateAll() if the designated constraints aren't met.

func (JobInfoMultiError) AllErrors

func (m JobInfoMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (JobInfoMultiError) Error

func (m JobInfoMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type JobInfoValidationError

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

JobInfoValidationError is the validation error returned by JobInfo.Validate if the designated constraints aren't met.

func (JobInfoValidationError) Cause

func (e JobInfoValidationError) Cause() error

Cause function returns cause value.

func (JobInfoValidationError) Error

func (e JobInfoValidationError) Error() string

Error satisfies the builtin error interface

func (JobInfoValidationError) ErrorName

func (e JobInfoValidationError) ErrorName() string

ErrorName returns error name.

func (JobInfoValidationError) Field

func (e JobInfoValidationError) Field() string

Field function returns field value.

func (JobInfoValidationError) Key

func (e JobInfoValidationError) Key() bool

Key function returns key value.

func (JobInfoValidationError) Reason

func (e JobInfoValidationError) Reason() string

Reason function returns reason value.

type JobInfo_Error

type JobInfo_Error struct {
	// error is set when the Job is unable to complete successfully
	Error JobErrorCode `protobuf:"varint,7,opt,name=error,proto3,enum=pjs.JobErrorCode,oneof"`
}

type JobInfo_Output

type JobInfo_Output struct {
	// output is produced by a successfully completing Job
	Output *QueueElement `protobuf:"bytes,6,opt,name=output,proto3,oneof"`
}

type JobMultiError

type JobMultiError []error

JobMultiError is an error wrapping multiple validation errors returned by Job.ValidateAll() if the designated constraints aren't met.

func (JobMultiError) AllErrors

func (m JobMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (JobMultiError) Error

func (m JobMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type JobState

type JobState int32
const (
	// UNSPECIFIED means the job state is unspecified.
	JobState_JobState_UNSPECIFIED JobState = 0
	// QUEUED means the job is currently in a queue.
	// A QUEUED job will not have any descendants.
	JobState_QUEUED JobState = 1
	// PROCESSING means the job is currently being processed by a worker.
	JobState_PROCESSING JobState = 2
	// DONE means the job, and all of its descendants, are done.
	JobState_DONE JobState = 3
)

func (JobState) Descriptor

func (JobState) Descriptor() protoreflect.EnumDescriptor

func (JobState) Enum

func (x JobState) Enum() *JobState

func (JobState) EnumDescriptor deprecated

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

Deprecated: Use JobState.Descriptor instead.

func (JobState) Number

func (x JobState) Number() protoreflect.EnumNumber

func (JobState) String

func (x JobState) String() string

func (JobState) Type

type JobValidationError

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

JobValidationError is the validation error returned by Job.Validate if the designated constraints aren't met.

func (JobValidationError) Cause

func (e JobValidationError) Cause() error

Cause function returns cause value.

func (JobValidationError) Error

func (e JobValidationError) Error() string

Error satisfies the builtin error interface

func (JobValidationError) ErrorName

func (e JobValidationError) ErrorName() string

ErrorName returns error name.

func (JobValidationError) Field

func (e JobValidationError) Field() string

Field function returns field value.

func (JobValidationError) Key

func (e JobValidationError) Key() bool

Key function returns key value.

func (JobValidationError) Reason

func (e JobValidationError) Reason() string

Reason function returns reason value.

type ListJobRequest

type ListJobRequest struct {

	// context is a bearer token used when calling from within a running Job.
	Context string `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"`
	// job is the job to start listing at.
	// If nil, then the listing starts at the first job in the natural ordering.
	Job *Job `protobuf:"bytes,2,opt,name=job,proto3" json:"job,omitempty"`
	// contains filtered or unexported fields
}

TODO: - Filter - Paginate

func (*ListJobRequest) Descriptor deprecated

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

Deprecated: Use ListJobRequest.ProtoReflect.Descriptor instead.

func (*ListJobRequest) GetContext

func (x *ListJobRequest) GetContext() string

func (*ListJobRequest) GetJob

func (x *ListJobRequest) GetJob() *Job

func (*ListJobRequest) MarshalLogObject

func (x *ListJobRequest) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*ListJobRequest) ProtoMessage

func (*ListJobRequest) ProtoMessage()

func (*ListJobRequest) ProtoReflect

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

func (*ListJobRequest) Reset

func (x *ListJobRequest) Reset()

func (*ListJobRequest) String

func (x *ListJobRequest) String() string

func (*ListJobRequest) Validate

func (m *ListJobRequest) Validate() error

Validate checks the field values on ListJobRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ListJobRequest) ValidateAll

func (m *ListJobRequest) ValidateAll() error

ValidateAll checks the field values on ListJobRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ListJobRequestMultiError, or nil if none found.

type ListJobRequestMultiError

type ListJobRequestMultiError []error

ListJobRequestMultiError is an error wrapping multiple validation errors returned by ListJobRequest.ValidateAll() if the designated constraints aren't met.

func (ListJobRequestMultiError) AllErrors

func (m ListJobRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ListJobRequestMultiError) Error

func (m ListJobRequestMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ListJobRequestValidationError

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

ListJobRequestValidationError is the validation error returned by ListJobRequest.Validate if the designated constraints aren't met.

func (ListJobRequestValidationError) Cause

Cause function returns cause value.

func (ListJobRequestValidationError) Error

Error satisfies the builtin error interface

func (ListJobRequestValidationError) ErrorName

func (e ListJobRequestValidationError) ErrorName() string

ErrorName returns error name.

func (ListJobRequestValidationError) Field

Field function returns field value.

func (ListJobRequestValidationError) Key

Key function returns key value.

func (ListJobRequestValidationError) Reason

Reason function returns reason value.

type ListJobResponse

type ListJobResponse struct {
	Id      *Job            `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Info    *JobInfo        `protobuf:"bytes,2,opt,name=info,proto3" json:"info,omitempty"`
	Details *JobInfoDetails `protobuf:"bytes,3,opt,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

ListJobResponse lists information about Jobs ID will always be set. Info and Details may not be set depending on how much information was requested.

func (*ListJobResponse) Descriptor deprecated

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

Deprecated: Use ListJobResponse.ProtoReflect.Descriptor instead.

func (*ListJobResponse) GetDetails

func (x *ListJobResponse) GetDetails() *JobInfoDetails

func (*ListJobResponse) GetId

func (x *ListJobResponse) GetId() *Job

func (*ListJobResponse) GetInfo

func (x *ListJobResponse) GetInfo() *JobInfo

func (*ListJobResponse) MarshalLogObject

func (x *ListJobResponse) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*ListJobResponse) ProtoMessage

func (*ListJobResponse) ProtoMessage()

func (*ListJobResponse) ProtoReflect

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

func (*ListJobResponse) Reset

func (x *ListJobResponse) Reset()

func (*ListJobResponse) String

func (x *ListJobResponse) String() string

func (*ListJobResponse) Validate

func (m *ListJobResponse) Validate() error

Validate checks the field values on ListJobResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ListJobResponse) ValidateAll

func (m *ListJobResponse) ValidateAll() error

ValidateAll checks the field values on ListJobResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ListJobResponseMultiError, or nil if none found.

type ListJobResponseMultiError

type ListJobResponseMultiError []error

ListJobResponseMultiError is an error wrapping multiple validation errors returned by ListJobResponse.ValidateAll() if the designated constraints aren't met.

func (ListJobResponseMultiError) AllErrors

func (m ListJobResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ListJobResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type ListJobResponseValidationError

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

ListJobResponseValidationError is the validation error returned by ListJobResponse.Validate if the designated constraints aren't met.

func (ListJobResponseValidationError) Cause

Cause function returns cause value.

func (ListJobResponseValidationError) Error

Error satisfies the builtin error interface

func (ListJobResponseValidationError) ErrorName

func (e ListJobResponseValidationError) ErrorName() string

ErrorName returns error name.

func (ListJobResponseValidationError) Field

Field function returns field value.

func (ListJobResponseValidationError) Key

Key function returns key value.

func (ListJobResponseValidationError) Reason

Reason function returns reason value.

type ListQueueRequest

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

TODO: - Filter - Paginate

func (*ListQueueRequest) Descriptor deprecated

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

Deprecated: Use ListQueueRequest.ProtoReflect.Descriptor instead.

func (*ListQueueRequest) MarshalLogObject

func (x *ListQueueRequest) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*ListQueueRequest) ProtoMessage

func (*ListQueueRequest) ProtoMessage()

func (*ListQueueRequest) ProtoReflect

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

func (*ListQueueRequest) Reset

func (x *ListQueueRequest) Reset()

func (*ListQueueRequest) String

func (x *ListQueueRequest) String() string

func (*ListQueueRequest) Validate

func (m *ListQueueRequest) Validate() error

Validate checks the field values on ListQueueRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ListQueueRequest) ValidateAll

func (m *ListQueueRequest) ValidateAll() error

ValidateAll checks the field values on ListQueueRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ListQueueRequestMultiError, or nil if none found.

type ListQueueRequestMultiError

type ListQueueRequestMultiError []error

ListQueueRequestMultiError is an error wrapping multiple validation errors returned by ListQueueRequest.ValidateAll() if the designated constraints aren't met.

func (ListQueueRequestMultiError) AllErrors

func (m ListQueueRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ListQueueRequestMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type ListQueueRequestValidationError

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

ListQueueRequestValidationError is the validation error returned by ListQueueRequest.Validate if the designated constraints aren't met.

func (ListQueueRequestValidationError) Cause

Cause function returns cause value.

func (ListQueueRequestValidationError) Error

Error satisfies the builtin error interface

func (ListQueueRequestValidationError) ErrorName

ErrorName returns error name.

func (ListQueueRequestValidationError) Field

Field function returns field value.

func (ListQueueRequestValidationError) Key

Key function returns key value.

func (ListQueueRequestValidationError) Reason

Reason function returns reason value.

type ListQueueResponse

type ListQueueResponse struct {
	Id      *Queue            `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Info    *QueueInfo        `protobuf:"bytes,2,opt,name=info,proto3" json:"info,omitempty"`
	Details *QueueInfoDetails `protobuf:"bytes,3,opt,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

func (*ListQueueResponse) Descriptor deprecated

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

Deprecated: Use ListQueueResponse.ProtoReflect.Descriptor instead.

func (*ListQueueResponse) GetDetails

func (x *ListQueueResponse) GetDetails() *QueueInfoDetails

func (*ListQueueResponse) GetId

func (x *ListQueueResponse) GetId() *Queue

func (*ListQueueResponse) GetInfo

func (x *ListQueueResponse) GetInfo() *QueueInfo

func (*ListQueueResponse) MarshalLogObject

func (x *ListQueueResponse) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*ListQueueResponse) ProtoMessage

func (*ListQueueResponse) ProtoMessage()

func (*ListQueueResponse) ProtoReflect

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

func (*ListQueueResponse) Reset

func (x *ListQueueResponse) Reset()

func (*ListQueueResponse) String

func (x *ListQueueResponse) String() string

func (*ListQueueResponse) Validate

func (m *ListQueueResponse) Validate() error

Validate checks the field values on ListQueueResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ListQueueResponse) ValidateAll

func (m *ListQueueResponse) ValidateAll() error

ValidateAll checks the field values on ListQueueResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ListQueueResponseMultiError, or nil if none found.

type ListQueueResponseMultiError

type ListQueueResponseMultiError []error

ListQueueResponseMultiError is an error wrapping multiple validation errors returned by ListQueueResponse.ValidateAll() if the designated constraints aren't met.

func (ListQueueResponseMultiError) AllErrors

func (m ListQueueResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ListQueueResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type ListQueueResponseValidationError

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

ListQueueResponseValidationError is the validation error returned by ListQueueResponse.Validate if the designated constraints aren't met.

func (ListQueueResponseValidationError) Cause

Cause function returns cause value.

func (ListQueueResponseValidationError) Error

Error satisfies the builtin error interface

func (ListQueueResponseValidationError) ErrorName

ErrorName returns error name.

func (ListQueueResponseValidationError) Field

Field function returns field value.

func (ListQueueResponseValidationError) Key

Key function returns key value.

func (ListQueueResponseValidationError) Reason

Reason function returns reason value.

type ProcessQueueRequest

type ProcessQueueRequest struct {

	// queue is set to start processing from a Queue.
	Queue *Queue `protobuf:"bytes,1,opt,name=queue,proto3" json:"queue,omitempty"`
	// result must be set for the Job's output to be defined.
	// If the result is not set, the Job will error with DISCONNECTED.
	//
	// Types that are assignable to Result:
	//
	//	*ProcessQueueRequest_Output
	//	*ProcessQueueRequest_Failed
	Result isProcessQueueRequest_Result `protobuf_oneof:"result"`
	// contains filtered or unexported fields
}

Queue Messages ProcessQueueRequest is the client -> server message for the bi-di ProcessQueue RPC.

func (*ProcessQueueRequest) Descriptor deprecated

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

Deprecated: Use ProcessQueueRequest.ProtoReflect.Descriptor instead.

func (*ProcessQueueRequest) GetFailed

func (x *ProcessQueueRequest) GetFailed() bool

func (*ProcessQueueRequest) GetOutput

func (x *ProcessQueueRequest) GetOutput() *QueueElement

func (*ProcessQueueRequest) GetQueue

func (x *ProcessQueueRequest) GetQueue() *Queue

func (*ProcessQueueRequest) GetResult

func (m *ProcessQueueRequest) GetResult() isProcessQueueRequest_Result

func (*ProcessQueueRequest) MarshalLogObject

func (x *ProcessQueueRequest) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*ProcessQueueRequest) ProtoMessage

func (*ProcessQueueRequest) ProtoMessage()

func (*ProcessQueueRequest) ProtoReflect

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

func (*ProcessQueueRequest) Reset

func (x *ProcessQueueRequest) Reset()

func (*ProcessQueueRequest) String

func (x *ProcessQueueRequest) String() string

func (*ProcessQueueRequest) Validate

func (m *ProcessQueueRequest) Validate() error

Validate checks the field values on ProcessQueueRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ProcessQueueRequest) ValidateAll

func (m *ProcessQueueRequest) ValidateAll() error

ValidateAll checks the field values on ProcessQueueRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ProcessQueueRequestMultiError, or nil if none found.

type ProcessQueueRequestMultiError

type ProcessQueueRequestMultiError []error

ProcessQueueRequestMultiError is an error wrapping multiple validation errors returned by ProcessQueueRequest.ValidateAll() if the designated constraints aren't met.

func (ProcessQueueRequestMultiError) AllErrors

func (m ProcessQueueRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ProcessQueueRequestMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type ProcessQueueRequestValidationError

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

ProcessQueueRequestValidationError is the validation error returned by ProcessQueueRequest.Validate if the designated constraints aren't met.

func (ProcessQueueRequestValidationError) Cause

Cause function returns cause value.

func (ProcessQueueRequestValidationError) Error

Error satisfies the builtin error interface

func (ProcessQueueRequestValidationError) ErrorName

ErrorName returns error name.

func (ProcessQueueRequestValidationError) Field

Field function returns field value.

func (ProcessQueueRequestValidationError) Key

Key function returns key value.

func (ProcessQueueRequestValidationError) Reason

Reason function returns reason value.

type ProcessQueueRequest_Failed

type ProcessQueueRequest_Failed struct {
	// failed is set by the client to fail the Job.
	// The Job will transition to state DONE with code FAILED.
	Failed bool `protobuf:"varint,3,opt,name=failed,proto3,oneof"`
}

type ProcessQueueRequest_Output

type ProcessQueueRequest_Output struct {
	// output is set by the client to complete the Job successfully.
	Output *QueueElement `protobuf:"bytes,2,opt,name=output,proto3,oneof"`
}

type ProcessQueueResponse

type ProcessQueueResponse struct {

	// context is a bearer token used to act on behalf of the Job in other RPCs.
	// The server issues this token to the client, and the client should use it when performing Job RPCs.
	Context string `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"`
	// input is the input data for a Job.
	// The server sends this to ask the client to compute the output.
	Input *QueueElement `protobuf:"bytes,2,opt,name=input,proto3" json:"input,omitempty"`
	// contains filtered or unexported fields
}

ProcessQueueResposne is the server -> client message for the bi-di ProcessQueue RPC.

func (*ProcessQueueResponse) Descriptor deprecated

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

Deprecated: Use ProcessQueueResponse.ProtoReflect.Descriptor instead.

func (*ProcessQueueResponse) GetContext

func (x *ProcessQueueResponse) GetContext() string

func (*ProcessQueueResponse) GetInput

func (x *ProcessQueueResponse) GetInput() *QueueElement

func (*ProcessQueueResponse) MarshalLogObject

func (x *ProcessQueueResponse) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*ProcessQueueResponse) ProtoMessage

func (*ProcessQueueResponse) ProtoMessage()

func (*ProcessQueueResponse) ProtoReflect

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

func (*ProcessQueueResponse) Reset

func (x *ProcessQueueResponse) Reset()

func (*ProcessQueueResponse) String

func (x *ProcessQueueResponse) String() string

func (*ProcessQueueResponse) Validate

func (m *ProcessQueueResponse) Validate() error

Validate checks the field values on ProcessQueueResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ProcessQueueResponse) ValidateAll

func (m *ProcessQueueResponse) ValidateAll() error

ValidateAll checks the field values on ProcessQueueResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ProcessQueueResponseMultiError, or nil if none found.

type ProcessQueueResponseMultiError

type ProcessQueueResponseMultiError []error

ProcessQueueResponseMultiError is an error wrapping multiple validation errors returned by ProcessQueueResponse.ValidateAll() if the designated constraints aren't met.

func (ProcessQueueResponseMultiError) AllErrors

func (m ProcessQueueResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ProcessQueueResponseMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type ProcessQueueResponseValidationError

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

ProcessQueueResponseValidationError is the validation error returned by ProcessQueueResponse.Validate if the designated constraints aren't met.

func (ProcessQueueResponseValidationError) Cause

Cause function returns cause value.

func (ProcessQueueResponseValidationError) Error

Error satisfies the builtin error interface

func (ProcessQueueResponseValidationError) ErrorName

ErrorName returns error name.

func (ProcessQueueResponseValidationError) Field

Field function returns field value.

func (ProcessQueueResponseValidationError) Key

Key function returns key value.

func (ProcessQueueResponseValidationError) Reason

Reason function returns reason value.

type Queue

type Queue struct {
	Id []byte `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

Queue uniquely identifies a Queue Queue will be nil to identify no Queue, or to indicate unset.

func (*Queue) Descriptor deprecated

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

Deprecated: Use Queue.ProtoReflect.Descriptor instead.

func (*Queue) GetId

func (x *Queue) GetId() []byte

func (*Queue) MarshalLogObject

func (x *Queue) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*Queue) ProtoMessage

func (*Queue) ProtoMessage()

func (*Queue) ProtoReflect

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

func (*Queue) Reset

func (x *Queue) Reset()

func (*Queue) String

func (x *Queue) String() string

func (*Queue) Validate

func (m *Queue) Validate() error

Validate checks the field values on Queue with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Queue) ValidateAll

func (m *Queue) ValidateAll() error

ValidateAll checks the field values on Queue with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in QueueMultiError, or nil if none found.

type QueueElement

type QueueElement struct {

	// data is opaque data used as the input and output of Jobs
	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// filesets is a list of Fileset handles, used to associate Filesets with the input and output of Jobs.
	// Any of the filesets referenced here will be persisted for as long as this element is in a Queue.
	// New handles, pointing to equivalent Filesets, are minted whenever they cross the API boundary.
	Filesets []string `protobuf:"bytes,2,rep,name=filesets,proto3" json:"filesets,omitempty"`
	// contains filtered or unexported fields
}

QueueElement is a single element in a Queue.

func (*QueueElement) Descriptor deprecated

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

Deprecated: Use QueueElement.ProtoReflect.Descriptor instead.

func (*QueueElement) GetData

func (x *QueueElement) GetData() []byte

func (*QueueElement) GetFilesets

func (x *QueueElement) GetFilesets() []string

func (*QueueElement) MarshalLogObject

func (x *QueueElement) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*QueueElement) ProtoMessage

func (*QueueElement) ProtoMessage()

func (*QueueElement) ProtoReflect

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

func (*QueueElement) Reset

func (x *QueueElement) Reset()

func (*QueueElement) String

func (x *QueueElement) String() string

func (*QueueElement) Validate

func (m *QueueElement) Validate() error

Validate checks the field values on QueueElement with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*QueueElement) ValidateAll

func (m *QueueElement) ValidateAll() error

ValidateAll checks the field values on QueueElement with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in QueueElementMultiError, or nil if none found.

type QueueElementMultiError

type QueueElementMultiError []error

QueueElementMultiError is an error wrapping multiple validation errors returned by QueueElement.ValidateAll() if the designated constraints aren't met.

func (QueueElementMultiError) AllErrors

func (m QueueElementMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (QueueElementMultiError) Error

func (m QueueElementMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type QueueElementValidationError

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

QueueElementValidationError is the validation error returned by QueueElement.Validate if the designated constraints aren't met.

func (QueueElementValidationError) Cause

Cause function returns cause value.

func (QueueElementValidationError) Error

Error satisfies the builtin error interface

func (QueueElementValidationError) ErrorName

func (e QueueElementValidationError) ErrorName() string

ErrorName returns error name.

func (QueueElementValidationError) Field

Field function returns field value.

func (QueueElementValidationError) Key

Key function returns key value.

func (QueueElementValidationError) Reason

Reason function returns reason value.

type QueueInfo

type QueueInfo struct {

	// queue is the Queue's identity
	Queue *Queue `protobuf:"bytes,1,opt,name=queue,proto3" json:"queue,omitempty"`
	// spec specifies the code to be run to process the Queue.
	Spec *anypb.Any `protobuf:"bytes,2,opt,name=spec,proto3" json:"spec,omitempty"`
	// contains filtered or unexported fields
}

QueueInfo describes a Queue

func (*QueueInfo) Descriptor deprecated

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

Deprecated: Use QueueInfo.ProtoReflect.Descriptor instead.

func (*QueueInfo) GetQueue

func (x *QueueInfo) GetQueue() *Queue

func (*QueueInfo) GetSpec

func (x *QueueInfo) GetSpec() *anypb.Any

func (*QueueInfo) MarshalLogObject

func (x *QueueInfo) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*QueueInfo) ProtoMessage

func (*QueueInfo) ProtoMessage()

func (*QueueInfo) ProtoReflect

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

func (*QueueInfo) Reset

func (x *QueueInfo) Reset()

func (*QueueInfo) String

func (x *QueueInfo) String() string

func (*QueueInfo) Validate

func (m *QueueInfo) Validate() error

Validate checks the field values on QueueInfo with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*QueueInfo) ValidateAll

func (m *QueueInfo) ValidateAll() error

ValidateAll checks the field values on QueueInfo with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in QueueInfoMultiError, or nil if none found.

type QueueInfoDetails

type QueueInfoDetails struct {
	QueueInfo *QueueInfo `protobuf:"bytes,1,opt,name=queue_info,json=queueInfo,proto3" json:"queue_info,omitempty"`
	// size is the number of elements queued.
	Size int64 `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"`
	// contains filtered or unexported fields
}

QueueInfoDetails contains detailed information about a Queue, which may be more expensive to get. It contains a superset of the information in QueueInfo.

func (*QueueInfoDetails) Descriptor deprecated

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

Deprecated: Use QueueInfoDetails.ProtoReflect.Descriptor instead.

func (*QueueInfoDetails) GetQueueInfo

func (x *QueueInfoDetails) GetQueueInfo() *QueueInfo

func (*QueueInfoDetails) GetSize

func (x *QueueInfoDetails) GetSize() int64

func (*QueueInfoDetails) MarshalLogObject

func (x *QueueInfoDetails) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*QueueInfoDetails) ProtoMessage

func (*QueueInfoDetails) ProtoMessage()

func (*QueueInfoDetails) ProtoReflect

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

func (*QueueInfoDetails) Reset

func (x *QueueInfoDetails) Reset()

func (*QueueInfoDetails) String

func (x *QueueInfoDetails) String() string

func (*QueueInfoDetails) Validate

func (m *QueueInfoDetails) Validate() error

Validate checks the field values on QueueInfoDetails with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*QueueInfoDetails) ValidateAll

func (m *QueueInfoDetails) ValidateAll() error

ValidateAll checks the field values on QueueInfoDetails with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in QueueInfoDetailsMultiError, or nil if none found.

type QueueInfoDetailsMultiError

type QueueInfoDetailsMultiError []error

QueueInfoDetailsMultiError is an error wrapping multiple validation errors returned by QueueInfoDetails.ValidateAll() if the designated constraints aren't met.

func (QueueInfoDetailsMultiError) AllErrors

func (m QueueInfoDetailsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (QueueInfoDetailsMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type QueueInfoDetailsValidationError

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

QueueInfoDetailsValidationError is the validation error returned by QueueInfoDetails.Validate if the designated constraints aren't met.

func (QueueInfoDetailsValidationError) Cause

Cause function returns cause value.

func (QueueInfoDetailsValidationError) Error

Error satisfies the builtin error interface

func (QueueInfoDetailsValidationError) ErrorName

ErrorName returns error name.

func (QueueInfoDetailsValidationError) Field

Field function returns field value.

func (QueueInfoDetailsValidationError) Key

Key function returns key value.

func (QueueInfoDetailsValidationError) Reason

Reason function returns reason value.

type QueueInfoMultiError

type QueueInfoMultiError []error

QueueInfoMultiError is an error wrapping multiple validation errors returned by QueueInfo.ValidateAll() if the designated constraints aren't met.

func (QueueInfoMultiError) AllErrors

func (m QueueInfoMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (QueueInfoMultiError) Error

func (m QueueInfoMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type QueueInfoValidationError

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

QueueInfoValidationError is the validation error returned by QueueInfo.Validate if the designated constraints aren't met.

func (QueueInfoValidationError) Cause

func (e QueueInfoValidationError) Cause() error

Cause function returns cause value.

func (QueueInfoValidationError) Error

func (e QueueInfoValidationError) Error() string

Error satisfies the builtin error interface

func (QueueInfoValidationError) ErrorName

func (e QueueInfoValidationError) ErrorName() string

ErrorName returns error name.

func (QueueInfoValidationError) Field

func (e QueueInfoValidationError) Field() string

Field function returns field value.

func (QueueInfoValidationError) Key

Key function returns key value.

func (QueueInfoValidationError) Reason

func (e QueueInfoValidationError) Reason() string

Reason function returns reason value.

type QueueMultiError

type QueueMultiError []error

QueueMultiError is an error wrapping multiple validation errors returned by Queue.ValidateAll() if the designated constraints aren't met.

func (QueueMultiError) AllErrors

func (m QueueMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (QueueMultiError) Error

func (m QueueMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type QueueValidationError

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

QueueValidationError is the validation error returned by Queue.Validate if the designated constraints aren't met.

func (QueueValidationError) Cause

func (e QueueValidationError) Cause() error

Cause function returns cause value.

func (QueueValidationError) Error

func (e QueueValidationError) Error() string

Error satisfies the builtin error interface

func (QueueValidationError) ErrorName

func (e QueueValidationError) ErrorName() string

ErrorName returns error name.

func (QueueValidationError) Field

func (e QueueValidationError) Field() string

Field function returns field value.

func (QueueValidationError) Key

func (e QueueValidationError) Key() bool

Key function returns key value.

func (QueueValidationError) Reason

func (e QueueValidationError) Reason() string

Reason function returns reason value.

type UnimplementedAPIServer

type UnimplementedAPIServer struct {
}

UnimplementedAPIServer must be embedded to have forward compatible implementations.

func (UnimplementedAPIServer) CancelJob

func (UnimplementedAPIServer) CreateJob

func (UnimplementedAPIServer) DeleteJob

func (UnimplementedAPIServer) InspectJob

func (UnimplementedAPIServer) InspectQueue

func (UnimplementedAPIServer) ListJob

func (UnimplementedAPIServer) ListQueue

func (UnimplementedAPIServer) ProcessQueue

func (UnimplementedAPIServer) WalkJob

type UnsafeAPIServer

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

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

type WalkJobRequest

type WalkJobRequest struct {

	// context is a bearer token used when calling from within a running Job.
	Context string `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"`
	// job is the job to start walking from.  If unset, the context Job is assumed.
	Job *Job `protobuf:"bytes,2,opt,name=job,proto3" json:"job,omitempty"`
	// contains filtered or unexported fields
}

func (*WalkJobRequest) Descriptor deprecated

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

Deprecated: Use WalkJobRequest.ProtoReflect.Descriptor instead.

func (*WalkJobRequest) GetContext

func (x *WalkJobRequest) GetContext() string

func (*WalkJobRequest) GetJob

func (x *WalkJobRequest) GetJob() *Job

func (*WalkJobRequest) MarshalLogObject

func (x *WalkJobRequest) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*WalkJobRequest) ProtoMessage

func (*WalkJobRequest) ProtoMessage()

func (*WalkJobRequest) ProtoReflect

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

func (*WalkJobRequest) Reset

func (x *WalkJobRequest) Reset()

func (*WalkJobRequest) String

func (x *WalkJobRequest) String() string

func (*WalkJobRequest) Validate

func (m *WalkJobRequest) Validate() error

Validate checks the field values on WalkJobRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*WalkJobRequest) ValidateAll

func (m *WalkJobRequest) ValidateAll() error

ValidateAll checks the field values on WalkJobRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in WalkJobRequestMultiError, or nil if none found.

type WalkJobRequestMultiError

type WalkJobRequestMultiError []error

WalkJobRequestMultiError is an error wrapping multiple validation errors returned by WalkJobRequest.ValidateAll() if the designated constraints aren't met.

func (WalkJobRequestMultiError) AllErrors

func (m WalkJobRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (WalkJobRequestMultiError) Error

func (m WalkJobRequestMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type WalkJobRequestValidationError

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

WalkJobRequestValidationError is the validation error returned by WalkJobRequest.Validate if the designated constraints aren't met.

func (WalkJobRequestValidationError) Cause

Cause function returns cause value.

func (WalkJobRequestValidationError) Error

Error satisfies the builtin error interface

func (WalkJobRequestValidationError) ErrorName

func (e WalkJobRequestValidationError) ErrorName() string

ErrorName returns error name.

func (WalkJobRequestValidationError) Field

Field function returns field value.

func (WalkJobRequestValidationError) Key

Key function returns key value.

func (WalkJobRequestValidationError) Reason

Reason function returns reason value.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL