forked from feast-dev/feast
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathJobService.proto
More file actions
175 lines (139 loc) · 4.81 KB
/
Copy pathJobService.proto
File metadata and controls
175 lines (139 loc) · 4.81 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
//
// Copyright 2018 The Feast Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
syntax = "proto3";
package feast.core;
option go_package = "github.com/feast-dev/feast/sdk/go/protos/feast/core";
option java_outer_classname = "JobServiceProto";
option java_package = "feast.proto.core";
import "google/protobuf/timestamp.proto";
import "feast/core/DataSource.proto";
service JobService {
// Start job to ingest data from offline store into online store
rpc StartOfflineToOnlineIngestionJob (StartOfflineToOnlineIngestionJobRequest) returns (StartOfflineToOnlineIngestionJobResponse);
// Produce a training dataset, return a job id that will provide a file reference
rpc GetHistoricalFeatures (GetHistoricalFeaturesRequest) returns (GetHistoricalFeaturesResponse);
// Start job to ingest data from stream into online store
rpc StartStreamToOnlineIngestionJob (StartStreamToOnlineIngestionJobRequest) returns (StartStreamToOnlineIngestionJobResponse);
// List all types of jobs
rpc ListJobs (ListJobsRequest) returns (ListJobsResponse);
// Cancel a single job
rpc CancelJob (CancelJobRequest) returns (CancelJobResponse);
// Get details of a single job
rpc GetJob (GetJobRequest) returns (GetJobResponse);
}
enum JobType {
INVALID_JOB = 0;
BATCH_INGESTION_JOB = 1;
STREAM_INGESTION_JOB = 2;
RETRIEVAL_JOB = 4;
}
enum JobStatus {
JOB_STATUS_INVALID = 0;
// The Job has be registered and waiting to get scheduled to run
JOB_STATUS_PENDING = 1;
// The Job is currently processing its task
JOB_STATUS_RUNNING = 2;
// The Job has successfully completed its task
JOB_STATUS_DONE = 3;
// The Job has encountered an error while processing its task
JOB_STATUS_ERROR = 4;
}
message Job {
// Identifier of the Job
string id = 1;
// Type of the Job
JobType type = 2;
// Current job status
JobStatus status = 3;
// Deterministic hash of the Job
string hash = 8;
message RetrievalJobMeta {
string output_location = 4;
}
message OfflineToOnlineMeta {
}
message StreamToOnlineMeta {
}
// JobType specific metadata on the job
oneof meta {
RetrievalJobMeta retrieval = 5;
OfflineToOnlineMeta batch_ingestion = 6;
StreamToOnlineMeta stream_ingestion = 7;
}
}
// Ingest data from offline store into online store
message StartOfflineToOnlineIngestionJobRequest {
// Feature table to ingest
string project = 1;
string table_name = 2;
// Start of time range for source data from offline store
google.protobuf.Timestamp start_date = 3;
// End of time range for source data from offline store
google.protobuf.Timestamp end_date = 4;
}
message StartOfflineToOnlineIngestionJobResponse {
// Job ID assigned by Feast
string id = 1;
}
message GetHistoricalFeaturesRequest {
// List of feature references that are being retrieved
repeated string feature_refs = 1;
// Batch DataSource that can be used to obtain entity values for historical retrieval.
// For each entity value, a feature value will be retrieved for that value/timestamp
// Only 'BATCH_*' source types are supported.
// Currently only BATCH_FILE source type is supported.
DataSource entity_source = 2;
// Optional field to specify project name override. If specified, uses the
// given project for retrieval. Overrides the projects specified in
// Feature References if both are specified.
string project = 3;
// Specifies the path in a bucket to write the exported feature data files
// Export to AWS S3 - s3://path/to/features
// Export to GCP GCS - gs://path/to/features
string output_location = 4;
// Specify format name for output, eg. parquet
string output_format = 5;
}
message GetHistoricalFeaturesResponse {
// Export Job with ID assigned by Feast
string id = 1;
string output_file_uri = 2;
}
message StartStreamToOnlineIngestionJobRequest {
// Feature table to ingest
string project = 1;
string table_name = 2;
}
message StartStreamToOnlineIngestionJobResponse {
// Job ID assigned by Feast
string id = 1;
}
message ListJobsRequest {
bool include_terminated = 1;
}
message ListJobsResponse {
repeated Job jobs = 1;
}
message GetJobRequest {
string job_id = 1;
}
message GetJobResponse {
Job job = 1;
}
message CancelJobRequest{
string job_id = 1;
}
message CancelJobResponse {}