diagnosticv1alpha1

package
v1.19.1 Latest Latest
Warning

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

 Go to latest Published: Apr 5, 2024 License: MIT Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	JobState_name = map[int32]string{
		0: "JOB_STATE_UNSPECIFIED",
		1: "JOB_STATE_AVAILABLE",
		2: "JOB_STATE_CANCELLED",
		3: "JOB_STATE_COMPLETED",
		4: "JOB_STATE_DISCARDED",
		5: "JOB_STATE_RETRYABLE",
		6: "JOB_STATE_RUNNING",
		7: "JOB_STATE_SCHEDULED",
	}
	JobState_value = map[string]int32{
		"JOB_STATE_UNSPECIFIED": 0,
		"JOB_STATE_AVAILABLE":   1,
		"JOB_STATE_CANCELLED":   2,
		"JOB_STATE_COMPLETED":   3,
		"JOB_STATE_DISCARDED":   4,
		"JOB_STATE_RETRYABLE":   5,
		"JOB_STATE_RUNNING":     6,
		"JOB_STATE_SCHEDULED":   7,
	}
)

Enum value maps for JobState.

View Source 
var File_commonfate_control_diagnostic_v1alpha1_diagnostic_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AllDiagnostics 

type AllDiagnostics struct {
	OauthTokenMetadata *GetOAuthTokenMetadataResponse `protobuf:"bytes,1,opt,name=oauth_token_metadata,json=oauthTokenMetadata,proto3" json:"oauth_token_metadata,omitempty"`
	// contains filtered or unexported fields
}

AllDiagnostics is used client-side to combine and serialise all collected diagnostics into a single JSON.

func (*AllDiagnostics) Descriptor deprecated 

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

Deprecated: Use AllDiagnostics.ProtoReflect.Descriptor instead.

func (*AllDiagnostics) GetOauthTokenMetadata 

func (x *AllDiagnostics) GetOauthTokenMetadata() *GetOAuthTokenMetadataResponse

func (*AllDiagnostics) ProtoMessage 

func (*AllDiagnostics) ProtoMessage()

func (*AllDiagnostics) ProtoReflect 

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

func (*AllDiagnostics) Reset 

func (x *AllDiagnostics) Reset()

func (*AllDiagnostics) String 

func (x *AllDiagnostics) String() string

type AttemptError added in v1.11.0 

type AttemptError struct {

	// At is the time at which the error occurred.
	At *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=at,proto3" json:"at,omitempty"`
	// Attempt is the attempt number on which the error occurred (maps to
	// Attempt on a job row).
	Attempt int64 `protobuf:"varint,2,opt,name=attempt,proto3" json:"attempt,omitempty"`
	// Error contains the stringified error of an error returned from a job or a
	// panic value in case of a panic.
	Error string `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	// Trace contains a stack trace from a job that panicked. The trace is
	// produced by invoking `debug.Trace()`.
	Trace string `protobuf:"bytes,4,opt,name=trace,proto3" json:"trace,omitempty"`
	// contains filtered or unexported fields
}

AttemptError is an error from a single job attempt that failed due to an error or a panic.

func (*AttemptError) Descriptor deprecated added in v1.11.0 

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

Deprecated: Use AttemptError.ProtoReflect.Descriptor instead.

func (*AttemptError) GetAt added in v1.11.0 

func (x *AttemptError) GetAt() *timestamppb.Timestamp

func (*AttemptError) GetAttempt added in v1.11.0 

func (x *AttemptError) GetAttempt() int64

func (*AttemptError) GetError added in v1.11.0 

func (x *AttemptError) GetError() string

func (*AttemptError) GetTrace added in v1.11.0 

func (x *AttemptError) GetTrace() string

func (*AttemptError) ProtoMessage added in v1.11.0 

func (*AttemptError) ProtoMessage()

func (*AttemptError) ProtoReflect added in v1.11.0 

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

func (*AttemptError) Reset added in v1.11.0 

func (x *AttemptError) Reset()

func (*AttemptError) String added in v1.11.0 

func (x *AttemptError) String() string

type GetOAuthTokenMetadataRequest 

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

func (*GetOAuthTokenMetadataRequest) Descriptor deprecated 

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

Deprecated: Use GetOAuthTokenMetadataRequest.ProtoReflect.Descriptor instead.

func (*GetOAuthTokenMetadataRequest) ProtoMessage 

func (*GetOAuthTokenMetadataRequest) ProtoMessage()

func (*GetOAuthTokenMetadataRequest) ProtoReflect 

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

func (*GetOAuthTokenMetadataRequest) Reset 

func (x *GetOAuthTokenMetadataRequest) Reset()

func (*GetOAuthTokenMetadataRequest) String 

func (x *GetOAuthTokenMetadataRequest) String() string

type GetOAuthTokenMetadataResponse 

type GetOAuthTokenMetadataResponse struct {
	Tokens []*OAuthTokenMetadata `protobuf:"bytes,1,rep,name=tokens,proto3" json:"tokens,omitempty"`
	// contains filtered or unexported fields
}

func (*GetOAuthTokenMetadataResponse) Descriptor deprecated 

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

Deprecated: Use GetOAuthTokenMetadataResponse.ProtoReflect.Descriptor instead.

func (*GetOAuthTokenMetadataResponse) GetTokens 

func (x *GetOAuthTokenMetadataResponse) GetTokens() []*OAuthTokenMetadata

func (*GetOAuthTokenMetadataResponse) ProtoMessage 

func (*GetOAuthTokenMetadataResponse) ProtoMessage()

func (*GetOAuthTokenMetadataResponse) ProtoReflect 

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

func (*GetOAuthTokenMetadataResponse) Reset 

func (x *GetOAuthTokenMetadataResponse) Reset()

func (*GetOAuthTokenMetadataResponse) String 

func (x *GetOAuthTokenMetadataResponse) String() string

type Job added in v1.11.0 

type Job struct {
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// Attempt is the attempt number of the job. Jobs are inserted at 0, the
	// number is incremented to 1 the first time work its worked, and may
	// increment further if it's either snoozed or errors.
	Attempt int64 `protobuf:"varint,2,opt,name=attempt,proto3" json:"attempt,omitempty"`
	// AttemptedAt is the time that the job was last worked. Starts out as `nil`
	// on a new insert.
	AttemptedAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=attempted_at,json=attemptedAt,proto3" json:"attempted_at,omitempty"`
	// AttemptedBy is the set of client IDs that have worked this job.
	AttemptedBy []string `protobuf:"bytes,4,rep,name=attempted_by,json=attemptedBy,proto3" json:"attempted_by,omitempty"`
	// CreatedAt is when the job record was created.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// EncodedArgs is the job's JobArgs encoded as JSON.
	EncodedArgs []byte `protobuf:"bytes,6,opt,name=encoded_args,json=encodedArgs,proto3" json:"encoded_args,omitempty"`
	// Errors is a set of errors that occurred when the job was worked, one for
	// each attempt. Ordered from earliest error to the latest error.
	Errors []*AttemptError `protobuf:"bytes,7,rep,name=errors,proto3" json:"errors,omitempty"`
	// FinalizedAt is the time at which the job was "finalized", meaning it was
	// either completed successfully or errored for the last time such that
	// it'll no longer be retried.
	FinalizedAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=finalized_at,json=finalizedAt,proto3" json:"finalized_at,omitempty"`
	// Kind uniquely identifies the type of job and instructs which worker
	// should work it. It is set at insertion time via `Kind()` on the
	// `JobArgs`.
	Kind string `protobuf:"bytes,9,opt,name=kind,proto3" json:"kind,omitempty"`
	// MaxAttempts is the maximum number of attempts that the job will be tried
	// before it errors for the last time and will no longer be worked.
	//
	// Extracted (in order of precedence) from job-specific InsertOpts
	// on Insert, from the worker level InsertOpts from JobArgsWithInsertOpts,
	// or from a client's default value.
	MaxAttempts int64 `protobuf:"varint,10,opt,name=max_attempts,json=maxAttempts,proto3" json:"max_attempts,omitempty"`
	// Metadata is a field for storing arbitrary metadata on a job. It should
	// always be a valid JSON object payload, and users should not overwrite or
	// remove anything stored in this field by River.
	Metadata []byte `protobuf:"bytes,11,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Priority is the priority of the job, with 1 being the highest priority and
	// 4 being the lowest. When fetching available jobs to work, the highest
	// priority jobs will always be fetched before any lower priority jobs are
	// fetched. Note that if your workers are swamped with more high-priority jobs
	// then they can handle, lower priority jobs may not be fetched.
	Priority int64 `protobuf:"varint,12,opt,name=priority,proto3" json:"priority,omitempty"`
	// Queue is the name of the queue where the job will be worked. Queues can
	// be configured independently and be used to isolate jobs.
	//
	// Extracted from either specific InsertOpts on Insert, or InsertOpts from
	// JobArgsWithInsertOpts, or a client's default value.
	Queue string `protobuf:"bytes,13,opt,name=queue,proto3" json:"queue,omitempty"`
	// ScheduledAt is when the job is scheduled to become available to be
	// worked. Jobs default to running immediately, but may be scheduled
	// for the future when they're inserted. They may also be scheduled for
	// later because they were snoozed or because they errored and have
	// additional retry attempts remaining.
	ScheduledAt *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=scheduled_at,json=scheduledAt,proto3" json:"scheduled_at,omitempty"`
	// State is the state of job like `available` or `completed`. Jobs are
	// `available` when they're first inserted.
	State string `protobuf:"bytes,15,opt,name=state,proto3" json:"state,omitempty"`
	// Tags are an arbitrary list of keywords to add to the job. They have no
	// functional behavior and are meant entirely as a user-specified construct
	// to help group and categorize jobs.
	Tags []string `protobuf:"bytes,16,rep,name=tags,proto3" json:"tags,omitempty"`
	// contains filtered or unexported fields
}

func (*Job) Descriptor deprecated added in v1.11.0 

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

Deprecated: Use Job.ProtoReflect.Descriptor instead.

func (*Job) GetAttempt added in v1.11.0 

func (x *Job) GetAttempt() int64

func (*Job) GetAttemptedAt added in v1.11.0 

func (x *Job) GetAttemptedAt() *timestamppb.Timestamp

func (*Job) GetAttemptedBy added in v1.11.0 

func (x *Job) GetAttemptedBy() []string

func (*Job) GetCreatedAt added in v1.11.0 

func (x *Job) GetCreatedAt() *timestamppb.Timestamp

func (*Job) GetEncodedArgs added in v1.11.0 

func (x *Job) GetEncodedArgs() []byte

func (*Job) GetErrors added in v1.11.0 

func (x *Job) GetErrors() []*AttemptError

func (*Job) GetFinalizedAt added in v1.11.0 

func (x *Job) GetFinalizedAt() *timestamppb.Timestamp

func (*Job) GetId added in v1.11.0 

func (x *Job) GetId() int64

func (*Job) GetKind added in v1.11.0 

func (x *Job) GetKind() string

func (*Job) GetMaxAttempts added in v1.11.0 

func (x *Job) GetMaxAttempts() int64

func (*Job) GetMetadata added in v1.11.0 

func (x *Job) GetMetadata() []byte

func (*Job) GetPriority added in v1.11.0 

func (x *Job) GetPriority() int64

func (*Job) GetQueue added in v1.11.0 

func (x *Job) GetQueue() string

func (*Job) GetScheduledAt added in v1.11.0 

func (x *Job) GetScheduledAt() *timestamppb.Timestamp

func (*Job) GetState added in v1.11.0 

func (x *Job) GetState() string

func (*Job) GetTags added in v1.11.0 

func (x *Job) GetTags() []string

func (*Job) ProtoMessage added in v1.11.0 

func (*Job) ProtoMessage()

func (*Job) ProtoReflect added in v1.11.0 

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

func (*Job) Reset added in v1.11.0 

func (x *Job) Reset()

func (*Job) String added in v1.11.0 

func (x *Job) String() string

type JobState added in v1.11.0 

type JobState int32
const (
	JobState_JOB_STATE_UNSPECIFIED JobState = 0
	JobState_JOB_STATE_AVAILABLE   JobState = 1
	JobState_JOB_STATE_CANCELLED   JobState = 2
	JobState_JOB_STATE_COMPLETED   JobState = 3
	JobState_JOB_STATE_DISCARDED   JobState = 4
	JobState_JOB_STATE_RETRYABLE   JobState = 5
	JobState_JOB_STATE_RUNNING     JobState = 6
	JobState_JOB_STATE_SCHEDULED   JobState = 7
)

func (JobState) Descriptor added in v1.11.0 

func (JobState) Descriptor() protoreflect.EnumDescriptor

func (JobState) Enum added in v1.11.0 

func (x JobState) Enum() *JobState

func (JobState) EnumDescriptor deprecated added in v1.11.0 

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

Deprecated: Use JobState.Descriptor instead.

func (JobState) Number added in v1.11.0 

func (x JobState) Number() protoreflect.EnumNumber

func (JobState) String added in v1.11.0 

func (x JobState) String() string

func (JobState) Type added in v1.11.0 

func (JobState) Type() protoreflect.EnumType

type ListBackgroundJobsRequest added in v1.11.0 

type ListBackgroundJobsRequest struct {

	// Optionally filter jobs by kind, supplying an empty list will return jobs for all kinds
	Kinds []string `protobuf:"bytes,1,rep,name=kinds,proto3" json:"kinds,omitempty"`
	// by default requests will return upp to 100 jobs, set this between 1 and 10000 to retrieve more jobs
	Count *int64 `protobuf:"varint,2,opt,name=count,proto3,oneof" json:"count,omitempty"`
	// The job state to filter for
	State JobState `protobuf:"varint,3,opt,name=state,proto3,enum=commonfate.control.diagnostic.v1alpha1.JobState" json:"state,omitempty"`
	// contains filtered or unexported fields
}

func (*ListBackgroundJobsRequest) Descriptor deprecated added in v1.11.0 

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

Deprecated: Use ListBackgroundJobsRequest.ProtoReflect.Descriptor instead.

func (*ListBackgroundJobsRequest) GetCount added in v1.11.0 

func (x *ListBackgroundJobsRequest) GetCount() int64

func (*ListBackgroundJobsRequest) GetKinds added in v1.11.0 

func (x *ListBackgroundJobsRequest) GetKinds() []string

func (*ListBackgroundJobsRequest) GetState added in v1.11.0 

func (x *ListBackgroundJobsRequest) GetState() JobState

func (*ListBackgroundJobsRequest) ProtoMessage added in v1.11.0 

func (*ListBackgroundJobsRequest) ProtoMessage()

func (*ListBackgroundJobsRequest) ProtoReflect added in v1.11.0 

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

func (*ListBackgroundJobsRequest) Reset added in v1.11.0 

func (x *ListBackgroundJobsRequest) Reset()

func (*ListBackgroundJobsRequest) String added in v1.11.0 

func (x *ListBackgroundJobsRequest) String() string

type ListBackgroundJobsResponse added in v1.11.0 

type ListBackgroundJobsResponse struct {
	Jobs []*Job `protobuf:"bytes,1,rep,name=jobs,proto3" json:"jobs,omitempty"`
	// contains filtered or unexported fields
}

func (*ListBackgroundJobsResponse) Descriptor deprecated added in v1.11.0 

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

Deprecated: Use ListBackgroundJobsResponse.ProtoReflect.Descriptor instead.

func (*ListBackgroundJobsResponse) GetJobs added in v1.11.0 

func (x *ListBackgroundJobsResponse) GetJobs() []*Job

func (*ListBackgroundJobsResponse) ProtoMessage added in v1.11.0 

func (*ListBackgroundJobsResponse) ProtoMessage()

func (*ListBackgroundJobsResponse) ProtoReflect added in v1.11.0 

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

func (*ListBackgroundJobsResponse) Reset added in v1.11.0 

func (x *ListBackgroundJobsResponse) Reset()

func (*ListBackgroundJobsResponse) String added in v1.11.0 

func (x *ListBackgroundJobsResponse) String() string

type OAuthTokenMetadata 

type OAuthTokenMetadata struct {
	Id        string                 `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	AppName   string                 `protobuf:"bytes,2,opt,name=app_name,json=appName,proto3" json:"app_name,omitempty"`
	ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
	// contains filtered or unexported fields
}

func (*OAuthTokenMetadata) Descriptor deprecated 

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

Deprecated: Use OAuthTokenMetadata.ProtoReflect.Descriptor instead.

func (*OAuthTokenMetadata) GetAppName 

func (x *OAuthTokenMetadata) GetAppName() string

func (*OAuthTokenMetadata) GetExpiresAt 

func (x *OAuthTokenMetadata) GetExpiresAt() *timestamppb.Timestamp

func (*OAuthTokenMetadata) GetId 

func (x *OAuthTokenMetadata) GetId() string

func (*OAuthTokenMetadata) ProtoMessage 

func (*OAuthTokenMetadata) ProtoMessage()

func (*OAuthTokenMetadata) ProtoReflect 

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

func (*OAuthTokenMetadata) Reset 

func (x *OAuthTokenMetadata) Reset()

func (*OAuthTokenMetadata) String 

func (x *OAuthTokenMetadata) String() string

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.