Documentation ¶
Overview ¶
Package pps is a generated protocol buffer package.
It is generated from these files:
client/pps/pps.proto
It has these top-level messages:
Transform Job Method JobInput JobInfo JobInfos Pipeline PipelineInput PipelineInfo PipelineInfos CreateJobRequest InspectJobRequest ListJobRequest GetLogsRequest CreatePipelineRequest InspectPipelineRequest ListPipelineRequest DeletePipelineRequest
Index ¶
- Variables
- func RegisterAPIServer(s *grpc.Server, srv APIServer)
- type APIClient
- type APIServer
- type API_GetLogsClient
- type API_GetLogsServer
- type CreateJobRequest
- func (*CreateJobRequest) Descriptor() ([]byte, []int)
- func (m *CreateJobRequest) GetInputs() []*JobInput
- func (m *CreateJobRequest) GetParentJob() *Job
- func (m *CreateJobRequest) GetPipeline() *Pipeline
- func (m *CreateJobRequest) GetTransform() *Transform
- func (*CreateJobRequest) ProtoMessage()
- func (m *CreateJobRequest) Reset()
- func (m *CreateJobRequest) String() string
- type CreatePipelineRequest
- func (*CreatePipelineRequest) Descriptor() ([]byte, []int)
- func (m *CreatePipelineRequest) GetInputs() []*PipelineInput
- func (m *CreatePipelineRequest) GetPipeline() *Pipeline
- func (m *CreatePipelineRequest) GetTransform() *Transform
- func (*CreatePipelineRequest) ProtoMessage()
- func (m *CreatePipelineRequest) Reset()
- func (m *CreatePipelineRequest) String() string
- type DeletePipelineRequest
- type GetLogsRequest
- type InspectJobRequest
- type InspectPipelineRequest
- type Job
- type JobInfo
- func (*JobInfo) Descriptor() ([]byte, []int)
- func (m *JobInfo) GetCreatedAt() *google_protobuf1.Timestamp
- func (m *JobInfo) GetInputs() []*JobInput
- func (m *JobInfo) GetJob() *Job
- func (m *JobInfo) GetOutputCommit() *pfs.Commit
- func (m *JobInfo) GetParentJob() *Job
- func (m *JobInfo) GetPipeline() *Pipeline
- func (m *JobInfo) GetTransform() *Transform
- func (*JobInfo) ProtoMessage()
- func (m *JobInfo) Reset()
- func (m *JobInfo) String() string
- type JobInfos
- type JobInput
- type JobState
- type ListJobRequest
- type ListPipelineRequest
- type Method
- type Partition
- type Pipeline
- type PipelineInfo
- func (*PipelineInfo) Descriptor() ([]byte, []int)
- func (m *PipelineInfo) GetCreatedAt() *google_protobuf1.Timestamp
- func (m *PipelineInfo) GetInputs() []*PipelineInput
- func (m *PipelineInfo) GetJobCounts() map[int32]int32
- func (m *PipelineInfo) GetOutputRepo() *pfs.Repo
- func (m *PipelineInfo) GetPipeline() *Pipeline
- func (m *PipelineInfo) GetTransform() *Transform
- func (*PipelineInfo) ProtoMessage()
- func (m *PipelineInfo) Reset()
- func (m *PipelineInfo) String() string
- type PipelineInfos
- type PipelineInput
- type PipelineState
- type Transform
Constants ¶
This section is empty.
Variables ¶
View Source
var JobState_name = map[int32]string{
0: "JOB_PULLING",
1: "JOB_RUNNING",
2: "JOB_FAILURE",
3: "JOB_SUCCESS",
}
View Source
var JobState_value = map[string]int32{
"JOB_PULLING": 0,
"JOB_RUNNING": 1,
"JOB_FAILURE": 2,
"JOB_SUCCESS": 3,
}
View Source
var Partition_name = map[int32]string{
0: "BLOCK",
1: "FILE",
2: "REPO",
}
View Source
var Partition_value = map[string]int32{
"BLOCK": 0,
"FILE": 1,
"REPO": 2,
}
View Source
var PipelineState_name = map[int32]string{
0: "PIPELINE_IDLE",
1: "PIPELINE_RUNNING",
2: "PIPELINE_RESTARTING",
3: "PIPELINE_FAILURE",
}
View Source
var PipelineState_value = map[string]int32{
"PIPELINE_IDLE": 0,
"PIPELINE_RUNNING": 1,
"PIPELINE_RESTARTING": 2,
"PIPELINE_FAILURE": 3,
}
Functions ¶
func RegisterAPIServer ¶
Types ¶
type APIClient ¶
type APIClient interface { CreateJob(ctx context.Context, in *CreateJobRequest, opts ...grpc.CallOption) (*Job, error) InspectJob(ctx context.Context, in *InspectJobRequest, opts ...grpc.CallOption) (*JobInfo, error) ListJob(ctx context.Context, in *ListJobRequest, opts ...grpc.CallOption) (*JobInfos, error) GetLogs(ctx context.Context, in *GetLogsRequest, opts ...grpc.CallOption) (API_GetLogsClient, error) CreatePipeline(ctx context.Context, in *CreatePipelineRequest, opts ...grpc.CallOption) (*google_protobuf.Empty, error) InspectPipeline(ctx context.Context, in *InspectPipelineRequest, opts ...grpc.CallOption) (*PipelineInfo, error) ListPipeline(ctx context.Context, in *ListPipelineRequest, opts ...grpc.CallOption) (*PipelineInfos, error) DeletePipeline(ctx context.Context, in *DeletePipelineRequest, opts ...grpc.CallOption) (*google_protobuf.Empty, error) // DeleteAll deletes everything DeleteAll(ctx context.Context, in *google_protobuf.Empty, opts ...grpc.CallOption) (*google_protobuf.Empty, error) }
func NewAPIClient ¶
func NewAPIClient(cc *grpc.ClientConn) APIClient
type APIServer ¶
type APIServer interface { CreateJob(context.Context, *CreateJobRequest) (*Job, error) InspectJob(context.Context, *InspectJobRequest) (*JobInfo, error) ListJob(context.Context, *ListJobRequest) (*JobInfos, error) GetLogs(*GetLogsRequest, API_GetLogsServer) error CreatePipeline(context.Context, *CreatePipelineRequest) (*google_protobuf.Empty, error) InspectPipeline(context.Context, *InspectPipelineRequest) (*PipelineInfo, error) ListPipeline(context.Context, *ListPipelineRequest) (*PipelineInfos, error) DeletePipeline(context.Context, *DeletePipelineRequest) (*google_protobuf.Empty, error) // DeleteAll deletes everything DeleteAll(context.Context, *google_protobuf.Empty) (*google_protobuf.Empty, error) }
type API_GetLogsClient ¶
type API_GetLogsClient interface { Recv() (*google_protobuf2.BytesValue, error) grpc.ClientStream }
type API_GetLogsServer ¶
type API_GetLogsServer interface { Send(*google_protobuf2.BytesValue) error grpc.ServerStream }
type CreateJobRequest ¶
type CreateJobRequest struct { Transform *Transform `protobuf:"bytes,1,opt,name=transform" json:"transform,omitempty"` Pipeline *Pipeline `protobuf:"bytes,2,opt,name=pipeline" json:"pipeline,omitempty"` Parallelism uint64 `protobuf:"varint,3,opt,name=parallelism" json:"parallelism,omitempty"` Inputs []*JobInput `protobuf:"bytes,4,rep,name=inputs" json:"inputs,omitempty"` ParentJob *Job `protobuf:"bytes,5,opt,name=parent_job,json=parentJob" json:"parent_job,omitempty"` Force bool `protobuf:"varint,6,opt,name=force" json:"force,omitempty"` }
func (*CreateJobRequest) Descriptor ¶
func (*CreateJobRequest) Descriptor() ([]byte, []int)
func (*CreateJobRequest) GetInputs ¶
func (m *CreateJobRequest) GetInputs() []*JobInput
func (*CreateJobRequest) GetParentJob ¶
func (m *CreateJobRequest) GetParentJob() *Job
func (*CreateJobRequest) GetPipeline ¶
func (m *CreateJobRequest) GetPipeline() *Pipeline
func (*CreateJobRequest) GetTransform ¶
func (m *CreateJobRequest) GetTransform() *Transform
func (*CreateJobRequest) ProtoMessage ¶
func (*CreateJobRequest) ProtoMessage()
func (*CreateJobRequest) Reset ¶
func (m *CreateJobRequest) Reset()
func (*CreateJobRequest) String ¶
func (m *CreateJobRequest) String() string
type CreatePipelineRequest ¶
type CreatePipelineRequest struct { Pipeline *Pipeline `protobuf:"bytes,1,opt,name=pipeline" json:"pipeline,omitempty"` Transform *Transform `protobuf:"bytes,2,opt,name=transform" json:"transform,omitempty"` Parallelism uint64 `protobuf:"varint,3,opt,name=parallelism" json:"parallelism,omitempty"` Inputs []*PipelineInput `protobuf:"bytes,4,rep,name=inputs" json:"inputs,omitempty"` }
func (*CreatePipelineRequest) Descriptor ¶
func (*CreatePipelineRequest) Descriptor() ([]byte, []int)
func (*CreatePipelineRequest) GetInputs ¶
func (m *CreatePipelineRequest) GetInputs() []*PipelineInput
func (*CreatePipelineRequest) GetPipeline ¶
func (m *CreatePipelineRequest) GetPipeline() *Pipeline
func (*CreatePipelineRequest) GetTransform ¶
func (m *CreatePipelineRequest) GetTransform() *Transform
func (*CreatePipelineRequest) ProtoMessage ¶
func (*CreatePipelineRequest) ProtoMessage()
func (*CreatePipelineRequest) Reset ¶
func (m *CreatePipelineRequest) Reset()
func (*CreatePipelineRequest) String ¶
func (m *CreatePipelineRequest) String() string
type DeletePipelineRequest ¶
type DeletePipelineRequest struct {
Pipeline *Pipeline `protobuf:"bytes,1,opt,name=pipeline" json:"pipeline,omitempty"`
}
func (*DeletePipelineRequest) Descriptor ¶
func (*DeletePipelineRequest) Descriptor() ([]byte, []int)
func (*DeletePipelineRequest) GetPipeline ¶
func (m *DeletePipelineRequest) GetPipeline() *Pipeline
func (*DeletePipelineRequest) ProtoMessage ¶
func (*DeletePipelineRequest) ProtoMessage()
func (*DeletePipelineRequest) Reset ¶
func (m *DeletePipelineRequest) Reset()
func (*DeletePipelineRequest) String ¶
func (m *DeletePipelineRequest) String() string
type GetLogsRequest ¶
type GetLogsRequest struct {
Job *Job `protobuf:"bytes,1,opt,name=job" json:"job,omitempty"`
}
func (*GetLogsRequest) Descriptor ¶
func (*GetLogsRequest) Descriptor() ([]byte, []int)
func (*GetLogsRequest) GetJob ¶
func (m *GetLogsRequest) GetJob() *Job
func (*GetLogsRequest) ProtoMessage ¶
func (*GetLogsRequest) ProtoMessage()
func (*GetLogsRequest) Reset ¶
func (m *GetLogsRequest) Reset()
func (*GetLogsRequest) String ¶
func (m *GetLogsRequest) String() string
type InspectJobRequest ¶
type InspectJobRequest struct { Job *Job `protobuf:"bytes,1,opt,name=job" json:"job,omitempty"` BlockState bool `protobuf:"varint,2,opt,name=block_state,json=blockState" json:"block_state,omitempty"` }
func (*InspectJobRequest) Descriptor ¶
func (*InspectJobRequest) Descriptor() ([]byte, []int)
func (*InspectJobRequest) GetJob ¶
func (m *InspectJobRequest) GetJob() *Job
func (*InspectJobRequest) ProtoMessage ¶
func (*InspectJobRequest) ProtoMessage()
func (*InspectJobRequest) Reset ¶
func (m *InspectJobRequest) Reset()
func (*InspectJobRequest) String ¶
func (m *InspectJobRequest) String() string
type InspectPipelineRequest ¶
type InspectPipelineRequest struct {
Pipeline *Pipeline `protobuf:"bytes,1,opt,name=pipeline" json:"pipeline,omitempty"`
}
func (*InspectPipelineRequest) Descriptor ¶
func (*InspectPipelineRequest) Descriptor() ([]byte, []int)
func (*InspectPipelineRequest) GetPipeline ¶
func (m *InspectPipelineRequest) GetPipeline() *Pipeline
func (*InspectPipelineRequest) ProtoMessage ¶
func (*InspectPipelineRequest) ProtoMessage()
func (*InspectPipelineRequest) Reset ¶
func (m *InspectPipelineRequest) Reset()
func (*InspectPipelineRequest) String ¶
func (m *InspectPipelineRequest) String() string
type Job ¶
type Job struct {
ID string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
}
func (*Job) Descriptor ¶
func (*Job) ProtoMessage ¶
func (*Job) ProtoMessage()
type JobInfo ¶
type JobInfo struct { Job *Job `protobuf:"bytes,1,opt,name=job" json:"job,omitempty"` Transform *Transform `protobuf:"bytes,2,opt,name=transform" json:"transform,omitempty"` Pipeline *Pipeline `protobuf:"bytes,3,opt,name=pipeline" json:"pipeline,omitempty"` Parallelism uint64 `protobuf:"varint,4,opt,name=parallelism" json:"parallelism,omitempty"` Inputs []*JobInput `protobuf:"bytes,5,rep,name=inputs" json:"inputs,omitempty"` ParentJob *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 JobState `protobuf:"varint,9,opt,name=state,enum=pachyderm.pps.JobState" json:"state,omitempty"` }
func (*JobInfo) Descriptor ¶
func (*JobInfo) GetCreatedAt ¶ added in v1.0.348
func (m *JobInfo) GetCreatedAt() *google_protobuf1.Timestamp
func (*JobInfo) GetOutputCommit ¶
func (*JobInfo) GetParentJob ¶
func (*JobInfo) GetPipeline ¶
func (*JobInfo) GetTransform ¶
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 JobInput ¶
type JobInput struct { Commit *pfs.Commit `protobuf:"bytes,1,opt,name=commit" json:"commit,omitempty"` Method *Method `protobuf:"bytes,2,opt,name=method" json:"method,omitempty"` }
func (*JobInput) Descriptor ¶
func (*JobInput) ProtoMessage ¶
func (*JobInput) ProtoMessage()
type ListJobRequest ¶
type ListJobRequest struct { Pipeline *Pipeline `protobuf:"bytes,1,opt,name=pipeline" json:"pipeline,omitempty"` InputCommit []*pfs.Commit `protobuf:"bytes,2,rep,name=input_commit,json=inputCommit" json:"input_commit,omitempty"` }
func (*ListJobRequest) Descriptor ¶
func (*ListJobRequest) Descriptor() ([]byte, []int)
func (*ListJobRequest) GetInputCommit ¶
func (m *ListJobRequest) GetInputCommit() []*pfs.Commit
func (*ListJobRequest) GetPipeline ¶
func (m *ListJobRequest) GetPipeline() *Pipeline
func (*ListJobRequest) ProtoMessage ¶
func (*ListJobRequest) ProtoMessage()
func (*ListJobRequest) Reset ¶
func (m *ListJobRequest) Reset()
func (*ListJobRequest) String ¶
func (m *ListJobRequest) String() string
type ListPipelineRequest ¶
type ListPipelineRequest struct { }
func (*ListPipelineRequest) Descriptor ¶
func (*ListPipelineRequest) Descriptor() ([]byte, []int)
func (*ListPipelineRequest) ProtoMessage ¶
func (*ListPipelineRequest) ProtoMessage()
func (*ListPipelineRequest) Reset ¶
func (m *ListPipelineRequest) Reset()
func (*ListPipelineRequest) String ¶
func (m *ListPipelineRequest) String() string
type Method ¶
type Method struct { Partition Partition `protobuf:"varint,1,opt,name=partition,enum=pachyderm.pps.Partition" json:"partition,omitempty"` Incremental bool `protobuf:"varint,2,opt,name=incremental" json:"incremental,omitempty"` }
func (*Method) Descriptor ¶
func (*Method) ProtoMessage ¶
func (*Method) ProtoMessage()
type Pipeline ¶
type Pipeline struct {
Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
}
func (*Pipeline) Descriptor ¶
func (*Pipeline) ProtoMessage ¶
func (*Pipeline) ProtoMessage()
type PipelineInfo ¶
type PipelineInfo struct { Pipeline *Pipeline `protobuf:"bytes,1,opt,name=pipeline" json:"pipeline,omitempty"` Transform *Transform `protobuf:"bytes,2,opt,name=transform" json:"transform,omitempty"` Parallelism uint64 `protobuf:"varint,3,opt,name=parallelism" json:"parallelism,omitempty"` Inputs []*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"` State PipelineState `protobuf:"varint,7,opt,name=state,enum=pachyderm.pps.PipelineState" json:"state,omitempty"` RecentError string `protobuf:"bytes,8,opt,name=recent_error,json=recentError" json:"recent_error,omitempty"` JobCounts map[int32]int32 `` /* 157-byte string literal not displayed */ }
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() []*PipelineInput
func (*PipelineInfo) GetJobCounts ¶
func (m *PipelineInfo) GetJobCounts() map[int32]int32
func (*PipelineInfo) GetOutputRepo ¶
func (m *PipelineInfo) GetOutputRepo() *pfs.Repo
func (*PipelineInfo) GetPipeline ¶
func (m *PipelineInfo) GetPipeline() *Pipeline
func (*PipelineInfo) GetTransform ¶
func (m *PipelineInfo) GetTransform() *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 PipelineInput ¶
type PipelineInput struct { Repo *pfs.Repo `protobuf:"bytes,1,opt,name=repo" json:"repo,omitempty"` Method *Method `protobuf:"bytes,2,opt,name=method" json:"method,omitempty"` }
func (*PipelineInput) Descriptor ¶
func (*PipelineInput) Descriptor() ([]byte, []int)
func (*PipelineInput) GetMethod ¶
func (m *PipelineInput) GetMethod() *Method
func (*PipelineInput) GetRepo ¶
func (m *PipelineInput) GetRepo() *pfs.Repo
func (*PipelineInput) ProtoMessage ¶
func (*PipelineInput) ProtoMessage()
func (*PipelineInput) Reset ¶
func (m *PipelineInput) Reset()
func (*PipelineInput) String ¶
func (m *PipelineInput) String() string
type PipelineState ¶
type PipelineState int32
const ( // When the pipeline is not ready to be triggered by commits. // This happens when either 1) a pipeline has been created but not yet picked // up by a PPS server, or 2) the pipeline does not have any inputs and is meant // to be triggered manually PipelineState_PIPELINE_IDLE PipelineState = 0 // After this pipeline is picked up by a pachd node. This is the normal // state of a pipeline. PipelineState_PIPELINE_RUNNING PipelineState = 1 // After some error caused runPipeline to exit, but before the pipeline is // re-run. This is when the exponential backoff is in effect. PipelineState_PIPELINE_RESTARTING PipelineState = 2 // We have retried too many times and we have given up on this pipeline. PipelineState_PIPELINE_FAILURE PipelineState = 3 )
func (PipelineState) EnumDescriptor ¶
func (PipelineState) EnumDescriptor() ([]byte, []int)
func (PipelineState) String ¶
func (x PipelineState) String() string
type Transform ¶
type Transform struct { Image string `protobuf:"bytes,1,opt,name=image" json:"image,omitempty"` Cmd []string `protobuf:"bytes,2,rep,name=cmd" json:"cmd,omitempty"` Stdin []string `protobuf:"bytes,3,rep,name=stdin" json:"stdin,omitempty"` AcceptReturnCode []int64 `protobuf:"varint,4,rep,name=accept_return_code,json=acceptReturnCode" json:"accept_return_code,omitempty"` Debug bool `protobuf:"varint,5,opt,name=debug" json:"debug,omitempty"` }
func (*Transform) Descriptor ¶
func (*Transform) ProtoMessage ¶
func (*Transform) ProtoMessage()
Click to show internal directories.
Click to hide internal directories.