Documentation
¶
Overview ¶
Package persist is a generated protocol buffer package.
It is generated from these files:
server/pps/persist/persist.proto
It has these top-level messages:
JobInfo JobInfos JobOutput JobState PipelineInfo PipelineInfos SubscribePipelineInfosRequest ListPipelineInfosRequest Shard
Index ¶
- func RegisterAPIServer(s *grpc.Server, srv APIServer)
- type APIClient
- type APIServer
- type API_SubscribePipelineInfosClient
- type API_SubscribePipelineInfosServer
- type JobInfo
- func (*JobInfo) Descriptor() ([]byte, []int)
- func (m *JobInfo) GetCreatedAt() *google_protobuf1.Timestamp
- func (m *JobInfo) GetInputs() []*pachyderm_pps.JobInput
- func (m *JobInfo) GetOutputCommit() *pfs.Commit
- func (m *JobInfo) GetParentJob() *pachyderm_pps.Job
- func (m *JobInfo) GetTransform() *pachyderm_pps.Transform
- func (*JobInfo) ProtoMessage()
- func (m *JobInfo) Reset()
- func (m *JobInfo) String() string
- type JobInfos
- type JobOutput
- type JobState
- type ListPipelineInfosRequest
- type PipelineInfo
- func (*PipelineInfo) Descriptor() ([]byte, []int)
- func (m *PipelineInfo) GetCreatedAt() *google_protobuf1.Timestamp
- func (m *PipelineInfo) GetInputs() []*pachyderm_pps.PipelineInput
- func (m *PipelineInfo) GetOutputRepo() *pfs.Repo
- func (m *PipelineInfo) GetTransform() *pachyderm_pps.Transform
- func (*PipelineInfo) ProtoMessage()
- func (m *PipelineInfo) Reset()
- func (m *PipelineInfo) String() string
- type PipelineInfos
- type Shard
- type SubscribePipelineInfosRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterAPIServer ¶
Types ¶
type APIClient ¶
type APIClient interface {
// Job rpcs
// job_id cannot be set
// timestamp cannot be set
CreateJobInfo(ctx context.Context, in *JobInfo, opts ...grpc.CallOption) (*JobInfo, error)
InspectJob(ctx context.Context, in *pachyderm_pps.InspectJobRequest, opts ...grpc.CallOption) (*JobInfo, error)
// ordered by time, latest to earliest
ListJobInfos(ctx context.Context, in *pachyderm_pps.ListJobRequest, opts ...grpc.CallOption) (*JobInfos, error)
// should only be called when rolling back if a Job does not start!
DeleteJobInfo(ctx context.Context, in *pachyderm_pps.Job, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
// JobOutput rpcs
CreateJobOutput(ctx context.Context, in *JobOutput, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
// JobState rpcs
CreateJobState(ctx context.Context, in *JobState, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
// Pipeline rpcs
CreatePipelineInfo(ctx context.Context, in *PipelineInfo, opts ...grpc.CallOption) (*PipelineInfo, error)
GetPipelineInfo(ctx context.Context, in *pachyderm_pps.Pipeline, opts ...grpc.CallOption) (*PipelineInfo, error)
// ordered by time, latest to earliest
ListPipelineInfos(ctx context.Context, in *ListPipelineInfosRequest, opts ...grpc.CallOption) (*PipelineInfos, error)
DeletePipelineInfo(ctx context.Context, in *pachyderm_pps.Pipeline, opts ...grpc.CallOption) (*google_protobuf.Empty, error)
SubscribePipelineInfos(ctx context.Context, in *SubscribePipelineInfosRequest, opts ...grpc.CallOption) (API_SubscribePipelineInfosClient, error)
// Shard rpcs
// Returns the new job info
StartShard(ctx context.Context, in *pachyderm_pps.Job, opts ...grpc.CallOption) (*JobInfo, error)
SucceedShard(ctx context.Context, in *pachyderm_pps.Job, opts ...grpc.CallOption) (*JobInfo, error)
FailShard(ctx context.Context, in *pachyderm_pps.Job, opts ...grpc.CallOption) (*JobInfo, error)
}
func NewAPIClient ¶
func NewAPIClient(cc *grpc.ClientConn) APIClient
type APIServer ¶
type APIServer interface {
// Job rpcs
// job_id cannot be set
// timestamp cannot be set
CreateJobInfo(context.Context, *JobInfo) (*JobInfo, error)
InspectJob(context.Context, *pachyderm_pps.InspectJobRequest) (*JobInfo, error)
// ordered by time, latest to earliest
ListJobInfos(context.Context, *pachyderm_pps.ListJobRequest) (*JobInfos, error)
// should only be called when rolling back if a Job does not start!
DeleteJobInfo(context.Context, *pachyderm_pps.Job) (*google_protobuf.Empty, error)
// JobOutput rpcs
CreateJobOutput(context.Context, *JobOutput) (*google_protobuf.Empty, error)
// JobState rpcs
CreateJobState(context.Context, *JobState) (*google_protobuf.Empty, error)
// Pipeline rpcs
CreatePipelineInfo(context.Context, *PipelineInfo) (*PipelineInfo, error)
GetPipelineInfo(context.Context, *pachyderm_pps.Pipeline) (*PipelineInfo, error)
// ordered by time, latest to earliest
ListPipelineInfos(context.Context, *ListPipelineInfosRequest) (*PipelineInfos, error)
DeletePipelineInfo(context.Context, *pachyderm_pps.Pipeline) (*google_protobuf.Empty, error)
SubscribePipelineInfos(*SubscribePipelineInfosRequest, API_SubscribePipelineInfosServer) error
// Shard rpcs
// Returns the new job info
StartShard(context.Context, *pachyderm_pps.Job) (*JobInfo, error)
SucceedShard(context.Context, *pachyderm_pps.Job) (*JobInfo, error)
FailShard(context.Context, *pachyderm_pps.Job) (*JobInfo, error)
}
type API_SubscribePipelineInfosClient ¶
type API_SubscribePipelineInfosClient interface {
Recv() (*PipelineInfo, error)
grpc.ClientStream
}
type API_SubscribePipelineInfosServer ¶
type API_SubscribePipelineInfosServer interface {
Send(*PipelineInfo) error
grpc.ServerStream
}
type JobInfo ¶
type JobInfo struct {
JobID string `protobuf:"bytes,1,opt,name=job_id,json=jobId" json:"job_id,omitempty"`
Transform *pachyderm_pps.Transform `protobuf:"bytes,2,opt,name=transform" json:"transform,omitempty"`
PipelineName string `protobuf:"bytes,3,opt,name=pipeline_name,json=pipelineName" json:"pipeline_name,omitempty"`
Shards uint64 `protobuf:"varint,4,opt,name=shards" json:"shards,omitempty"`
Inputs []*pachyderm_pps.JobInput `protobuf:"bytes,5,rep,name=inputs" json:"inputs,omitempty"`
ParentJob *pachyderm_pps.Job `protobuf:"bytes,6,opt,name=parent_job,json=parentJob" json:"parent_job,omitempty"`
CreatedAt *google_protobuf1.Timestamp `protobuf:"bytes,7,opt,name=created_at,json=createdAt" json:"created_at,omitempty"`
OutputCommit *pfs.Commit `protobuf:"bytes,8,opt,name=output_commit,json=outputCommit" json:"output_commit,omitempty"`
State pachyderm_pps.JobState `protobuf:"varint,9,opt,name=state,enum=pachyderm.pps.JobState" json:"state,omitempty"`
CommitIndex string `protobuf:"bytes,10,opt,name=commit_index,json=commitIndex" json:"commit_index,omitempty"`
ShardsStarted uint64 `protobuf:"varint,11,opt,name=shards_started,json=shardsStarted" json:"shards_started,omitempty"`
ShardsSucceeded uint64 `protobuf:"varint,12,opt,name=shards_succeeded,json=shardsSucceeded" json:"shards_succeeded,omitempty"`
ShardsFailed uint64 `protobuf:"varint,13,opt,name=shards_failed,json=shardsFailed" json:"shards_failed,omitempty"`
}
func (*JobInfo) Descriptor ¶
func (*JobInfo) GetCreatedAt ¶ added in v1.0.348
func (m *JobInfo) GetCreatedAt() *google_protobuf1.Timestamp
func (*JobInfo) GetInputs ¶
func (m *JobInfo) GetInputs() []*pachyderm_pps.JobInput
func (*JobInfo) GetOutputCommit ¶
func (*JobInfo) GetParentJob ¶
func (m *JobInfo) GetParentJob() *pachyderm_pps.Job
func (*JobInfo) GetTransform ¶
func (m *JobInfo) GetTransform() *pachyderm_pps.Transform
func (*JobInfo) ProtoMessage ¶
func (*JobInfo) ProtoMessage()
type JobInfos ¶
type JobInfos struct {
JobInfo []*JobInfo `protobuf:"bytes,1,rep,name=job_info,json=jobInfo" json:"job_info,omitempty"`
}
func (*JobInfos) Descriptor ¶
func (*JobInfos) GetJobInfo ¶
func (*JobInfos) ProtoMessage ¶
func (*JobInfos) ProtoMessage()
type JobOutput ¶
type JobOutput struct {
JobID string `protobuf:"bytes,1,opt,name=job_id,json=jobId" json:"job_id,omitempty"`
OutputCommit *pfs.Commit `protobuf:"bytes,2,opt,name=output_commit,json=outputCommit" json:"output_commit,omitempty"`
}
func (*JobOutput) Descriptor ¶
func (*JobOutput) GetOutputCommit ¶
func (*JobOutput) ProtoMessage ¶
func (*JobOutput) ProtoMessage()
type JobState ¶
type JobState struct {
JobID string `protobuf:"bytes,1,opt,name=job_id,json=jobId" json:"job_id,omitempty"`
State pachyderm_pps.JobState `protobuf:"varint,2,opt,name=state,enum=pachyderm.pps.JobState" json:"state,omitempty"`
}
func (*JobState) Descriptor ¶
func (*JobState) ProtoMessage ¶
func (*JobState) ProtoMessage()
type ListPipelineInfosRequest ¶
type ListPipelineInfosRequest struct {
Shard *Shard `protobuf:"bytes,1,opt,name=shard" json:"shard,omitempty"`
}
func (*ListPipelineInfosRequest) Descriptor ¶
func (*ListPipelineInfosRequest) Descriptor() ([]byte, []int)
func (*ListPipelineInfosRequest) GetShard ¶
func (m *ListPipelineInfosRequest) GetShard() *Shard
func (*ListPipelineInfosRequest) ProtoMessage ¶
func (*ListPipelineInfosRequest) ProtoMessage()
func (*ListPipelineInfosRequest) Reset ¶
func (m *ListPipelineInfosRequest) Reset()
func (*ListPipelineInfosRequest) String ¶
func (m *ListPipelineInfosRequest) String() string
type PipelineInfo ¶
type PipelineInfo struct {
PipelineName string `protobuf:"bytes,1,opt,name=pipeline_name,json=pipelineName" json:"pipeline_name,omitempty"`
Transform *pachyderm_pps.Transform `protobuf:"bytes,2,opt,name=transform" json:"transform,omitempty"`
Shards uint64 `protobuf:"varint,3,opt,name=shards" json:"shards,omitempty"`
Inputs []*pachyderm_pps.PipelineInput `protobuf:"bytes,4,rep,name=inputs" json:"inputs,omitempty"`
OutputRepo *pfs.Repo `protobuf:"bytes,5,opt,name=output_repo,json=outputRepo" json:"output_repo,omitempty"`
CreatedAt *google_protobuf1.Timestamp `protobuf:"bytes,6,opt,name=created_at,json=createdAt" json:"created_at,omitempty"`
Shard uint64 `protobuf:"varint,7,opt,name=shard" json:"shard,omitempty"`
}
func (*PipelineInfo) Descriptor ¶
func (*PipelineInfo) Descriptor() ([]byte, []int)
func (*PipelineInfo) GetCreatedAt ¶
func (m *PipelineInfo) GetCreatedAt() *google_protobuf1.Timestamp
func (*PipelineInfo) GetInputs ¶
func (m *PipelineInfo) GetInputs() []*pachyderm_pps.PipelineInput
func (*PipelineInfo) GetOutputRepo ¶
func (m *PipelineInfo) GetOutputRepo() *pfs.Repo
func (*PipelineInfo) GetTransform ¶
func (m *PipelineInfo) GetTransform() *pachyderm_pps.Transform
func (*PipelineInfo) ProtoMessage ¶
func (*PipelineInfo) ProtoMessage()
func (*PipelineInfo) Reset ¶
func (m *PipelineInfo) Reset()
func (*PipelineInfo) String ¶
func (m *PipelineInfo) String() string
type PipelineInfos ¶
type PipelineInfos struct {
PipelineInfo []*PipelineInfo `protobuf:"bytes,1,rep,name=pipeline_info,json=pipelineInfo" json:"pipeline_info,omitempty"`
}
func (*PipelineInfos) Descriptor ¶
func (*PipelineInfos) Descriptor() ([]byte, []int)
func (*PipelineInfos) GetPipelineInfo ¶
func (m *PipelineInfos) GetPipelineInfo() []*PipelineInfo
func (*PipelineInfos) ProtoMessage ¶
func (*PipelineInfos) ProtoMessage()
func (*PipelineInfos) Reset ¶
func (m *PipelineInfos) Reset()
func (*PipelineInfos) String ¶
func (m *PipelineInfos) String() string
type Shard ¶
type Shard struct {
Number uint64 `protobuf:"varint,1,opt,name=number" json:"number,omitempty"`
}
As in, sharding
func (*Shard) Descriptor ¶
func (*Shard) ProtoMessage ¶
func (*Shard) ProtoMessage()
type SubscribePipelineInfosRequest ¶
type SubscribePipelineInfosRequest struct {
IncludeInitial bool `protobuf:"varint,1,opt,name=include_initial,json=includeInitial" json:"include_initial,omitempty"`
Shard *Shard `protobuf:"bytes,2,opt,name=shard" json:"shard,omitempty"`
}
func (*SubscribePipelineInfosRequest) Descriptor ¶
func (*SubscribePipelineInfosRequest) Descriptor() ([]byte, []int)
func (*SubscribePipelineInfosRequest) GetShard ¶
func (m *SubscribePipelineInfosRequest) GetShard() *Shard
func (*SubscribePipelineInfosRequest) ProtoMessage ¶
func (*SubscribePipelineInfosRequest) ProtoMessage()
func (*SubscribePipelineInfosRequest) Reset ¶
func (m *SubscribePipelineInfosRequest) Reset()
func (*SubscribePipelineInfosRequest) String ¶
func (m *SubscribePipelineInfosRequest) String() string
Click to show internal directories.
Click to hide internal directories.