forked from feast-dev/feast
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathFeatureView_pb2.pyi
More file actions
306 lines (278 loc) · 14.5 KB
/
Copy pathFeatureView_pb2.pyi
File metadata and controls
306 lines (278 loc) · 14.5 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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
"""
@generated by mypy-protobuf. Do not edit manually!
isort:skip_file
Copyright 2020 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.
"""
import builtins
import collections.abc
import feast.core.DataSource_pb2
import feast.core.Feature_pb2
import feast.core.Transformation_pb2
import google.protobuf.descriptor
import google.protobuf.duration_pb2
import google.protobuf.internal.containers
import google.protobuf.internal.enum_type_wrapper
import google.protobuf.message
import google.protobuf.timestamp_pb2
import sys
import typing
if sys.version_info >= (3, 10):
import typing as typing_extensions
else:
import typing_extensions
DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
class _FeatureViewState:
ValueType = typing.NewType("ValueType", builtins.int)
V: typing_extensions.TypeAlias = ValueType
class _FeatureViewStateEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_FeatureViewState.ValueType], builtins.type): # noqa: F821
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
STATE_UNSPECIFIED: _FeatureViewState.ValueType # 0
"""Default value for backward compatibility. Treated as AVAILABLE_ONLINE
for existing feature views that predate the state machine.
"""
CREATED: _FeatureViewState.ValueType # 1
"""Feature view has been registered via feast apply but no data is available."""
GENERATED: _FeatureViewState.ValueType # 2
"""Feature engineering / offline data generation is complete.
The feature view is ready to be materialized.
"""
MATERIALIZING: _FeatureViewState.ValueType # 3
"""Materialization is currently in progress."""
AVAILABLE_ONLINE: _FeatureViewState.ValueType # 4
"""Materialization completed. Features are available in the online store."""
class FeatureViewState(_FeatureViewState, metaclass=_FeatureViewStateEnumTypeWrapper):
"""Lifecycle state of a feature view."""
STATE_UNSPECIFIED: FeatureViewState.ValueType # 0
"""Default value for backward compatibility. Treated as AVAILABLE_ONLINE
for existing feature views that predate the state machine.
"""
CREATED: FeatureViewState.ValueType # 1
"""Feature view has been registered via feast apply but no data is available."""
GENERATED: FeatureViewState.ValueType # 2
"""Feature engineering / offline data generation is complete.
The feature view is ready to be materialized.
"""
MATERIALIZING: FeatureViewState.ValueType # 3
"""Materialization is currently in progress."""
AVAILABLE_ONLINE: FeatureViewState.ValueType # 4
"""Materialization completed. Features are available in the online store."""
global___FeatureViewState = FeatureViewState
class FeatureView(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
SPEC_FIELD_NUMBER: builtins.int
META_FIELD_NUMBER: builtins.int
@property
def spec(self) -> global___FeatureViewSpec:
"""User-specified specifications of this feature view."""
@property
def meta(self) -> global___FeatureViewMeta:
"""System-populated metadata for this feature view."""
def __init__(
self,
*,
spec: global___FeatureViewSpec | None = ...,
meta: global___FeatureViewMeta | None = ...,
) -> None: ...
def HasField(self, field_name: typing_extensions.Literal["meta", b"meta", "spec", b"spec"]) -> builtins.bool: ...
def ClearField(self, field_name: typing_extensions.Literal["meta", b"meta", "spec", b"spec"]) -> None: ...
global___FeatureView = FeatureView
class FeatureViewSpec(google.protobuf.message.Message):
"""Next available id: 20
TODO(adchia): refactor common fields from this and ODFV into separate metadata proto
"""
DESCRIPTOR: google.protobuf.descriptor.Descriptor
class TagsEntry(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
KEY_FIELD_NUMBER: builtins.int
VALUE_FIELD_NUMBER: builtins.int
key: builtins.str
value: builtins.str
def __init__(
self,
*,
key: builtins.str = ...,
value: builtins.str = ...,
) -> None: ...
def ClearField(self, field_name: typing_extensions.Literal["key", b"key", "value", b"value"]) -> None: ...
NAME_FIELD_NUMBER: builtins.int
PROJECT_FIELD_NUMBER: builtins.int
ENTITIES_FIELD_NUMBER: builtins.int
FEATURES_FIELD_NUMBER: builtins.int
TAGS_FIELD_NUMBER: builtins.int
TTL_FIELD_NUMBER: builtins.int
BATCH_SOURCE_FIELD_NUMBER: builtins.int
ONLINE_FIELD_NUMBER: builtins.int
STREAM_SOURCE_FIELD_NUMBER: builtins.int
DESCRIPTION_FIELD_NUMBER: builtins.int
OWNER_FIELD_NUMBER: builtins.int
ENTITY_COLUMNS_FIELD_NUMBER: builtins.int
OFFLINE_FIELD_NUMBER: builtins.int
SOURCE_VIEWS_FIELD_NUMBER: builtins.int
FEATURE_TRANSFORMATION_FIELD_NUMBER: builtins.int
MODE_FIELD_NUMBER: builtins.int
ENABLE_VALIDATION_FIELD_NUMBER: builtins.int
VERSION_FIELD_NUMBER: builtins.int
ORG_FIELD_NUMBER: builtins.int
DISABLED_FIELD_NUMBER: builtins.int
name: builtins.str
"""Name of the feature view. Must be unique. Not updated."""
project: builtins.str
"""Name of Feast project that this feature view belongs to."""
@property
def entities(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
"""List of names of entities associated with this feature view."""
@property
def features(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[feast.core.Feature_pb2.FeatureSpecV2]:
"""List of specifications for each feature defined as part of this feature view."""
@property
def tags(self) -> google.protobuf.internal.containers.ScalarMap[builtins.str, builtins.str]:
"""User defined metadata"""
@property
def ttl(self) -> google.protobuf.duration_pb2.Duration:
"""Features in this feature view can only be retrieved from online serving
younger than ttl. Ttl is measured as the duration of time between
the feature's event timestamp and when the feature is retrieved
Feature values outside ttl will be returned as unset values and indicated to end user
"""
@property
def batch_source(self) -> feast.core.DataSource_pb2.DataSource:
"""Batch/Offline DataSource where this view can retrieve offline feature data.
Optional: if not set, the feature view has no associated batch data source (e.g. purely derived views).
"""
online: builtins.bool
"""Whether these features should be served online or not
This is also used to determine whether the features should be written to the online store
"""
@property
def stream_source(self) -> feast.core.DataSource_pb2.DataSource:
"""Streaming DataSource from where this view can consume "online" feature data.
Optional: only required for streaming feature views.
"""
description: builtins.str
"""Description of the feature view."""
owner: builtins.str
"""Owner of the feature view."""
@property
def entity_columns(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[feast.core.Feature_pb2.FeatureSpecV2]:
"""List of specifications for each entity defined as part of this feature view."""
offline: builtins.bool
"""Whether these features should be written to the offline store"""
@property
def source_views(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___FeatureViewSpec]: ...
@property
def feature_transformation(self) -> feast.core.Transformation_pb2.FeatureTransformationV2:
"""Feature transformation for batch feature views"""
mode: builtins.str
"""The transformation mode (e.g., "python", "pandas", "spark", "sql", "ray")"""
enable_validation: builtins.bool
"""Whether schema validation is enabled during materialization"""
version: builtins.str
"""User-specified version pin (e.g. "latest", "v2", "version2")"""
org: builtins.str
"""Organizational unit that owns this feature view (e.g. "ads", "search")."""
disabled: builtins.bool
"""Whether this feature view is disabled for serving and materialization.
When true, the feature view will not serve online features or be materialized.
Defaults to false (enabled) for backward compatibility.
"""
def __init__(
self,
*,
name: builtins.str = ...,
project: builtins.str = ...,
entities: collections.abc.Iterable[builtins.str] | None = ...,
features: collections.abc.Iterable[feast.core.Feature_pb2.FeatureSpecV2] | None = ...,
tags: collections.abc.Mapping[builtins.str, builtins.str] | None = ...,
ttl: google.protobuf.duration_pb2.Duration | None = ...,
batch_source: feast.core.DataSource_pb2.DataSource | None = ...,
online: builtins.bool = ...,
stream_source: feast.core.DataSource_pb2.DataSource | None = ...,
description: builtins.str = ...,
owner: builtins.str = ...,
entity_columns: collections.abc.Iterable[feast.core.Feature_pb2.FeatureSpecV2] | None = ...,
offline: builtins.bool = ...,
source_views: collections.abc.Iterable[global___FeatureViewSpec] | None = ...,
feature_transformation: feast.core.Transformation_pb2.FeatureTransformationV2 | None = ...,
mode: builtins.str = ...,
enable_validation: builtins.bool = ...,
version: builtins.str = ...,
org: builtins.str = ...,
disabled: builtins.bool = ...,
) -> None: ...
def HasField(self, field_name: typing_extensions.Literal["batch_source", b"batch_source", "feature_transformation", b"feature_transformation", "stream_source", b"stream_source", "ttl", b"ttl"]) -> builtins.bool: ...
def ClearField(self, field_name: typing_extensions.Literal["batch_source", b"batch_source", "description", b"description", "disabled", b"disabled", "enable_validation", b"enable_validation", "entities", b"entities", "entity_columns", b"entity_columns", "feature_transformation", b"feature_transformation", "features", b"features", "mode", b"mode", "name", b"name", "offline", b"offline", "online", b"online", "org", b"org", "owner", b"owner", "project", b"project", "source_views", b"source_views", "stream_source", b"stream_source", "tags", b"tags", "ttl", b"ttl", "version", b"version"]) -> None: ...
global___FeatureViewSpec = FeatureViewSpec
class FeatureViewMeta(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
CREATED_TIMESTAMP_FIELD_NUMBER: builtins.int
LAST_UPDATED_TIMESTAMP_FIELD_NUMBER: builtins.int
MATERIALIZATION_INTERVALS_FIELD_NUMBER: builtins.int
CURRENT_VERSION_NUMBER_FIELD_NUMBER: builtins.int
VERSION_ID_FIELD_NUMBER: builtins.int
STATE_FIELD_NUMBER: builtins.int
@property
def created_timestamp(self) -> google.protobuf.timestamp_pb2.Timestamp:
"""Time where this Feature View is created"""
@property
def last_updated_timestamp(self) -> google.protobuf.timestamp_pb2.Timestamp:
"""Time where this Feature View is last updated"""
@property
def materialization_intervals(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___MaterializationInterval]:
"""List of pairs (start_time, end_time) for which this feature view has been materialized."""
current_version_number: builtins.int
"""The current version number of this feature view in the version history."""
version_id: builtins.str
"""Auto-generated UUID identifying this specific version."""
state: global___FeatureViewState.ValueType
"""Lifecycle state of this feature view."""
def __init__(
self,
*,
created_timestamp: google.protobuf.timestamp_pb2.Timestamp | None = ...,
last_updated_timestamp: google.protobuf.timestamp_pb2.Timestamp | None = ...,
materialization_intervals: collections.abc.Iterable[global___MaterializationInterval] | None = ...,
current_version_number: builtins.int = ...,
version_id: builtins.str = ...,
state: global___FeatureViewState.ValueType = ...,
) -> None: ...
def HasField(self, field_name: typing_extensions.Literal["created_timestamp", b"created_timestamp", "last_updated_timestamp", b"last_updated_timestamp"]) -> builtins.bool: ...
def ClearField(self, field_name: typing_extensions.Literal["created_timestamp", b"created_timestamp", "current_version_number", b"current_version_number", "last_updated_timestamp", b"last_updated_timestamp", "materialization_intervals", b"materialization_intervals", "state", b"state", "version_id", b"version_id"]) -> None: ...
global___FeatureViewMeta = FeatureViewMeta
class MaterializationInterval(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
START_TIME_FIELD_NUMBER: builtins.int
END_TIME_FIELD_NUMBER: builtins.int
@property
def start_time(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
@property
def end_time(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
def __init__(
self,
*,
start_time: google.protobuf.timestamp_pb2.Timestamp | None = ...,
end_time: google.protobuf.timestamp_pb2.Timestamp | None = ...,
) -> None: ...
def HasField(self, field_name: typing_extensions.Literal["end_time", b"end_time", "start_time", b"start_time"]) -> builtins.bool: ...
def ClearField(self, field_name: typing_extensions.Literal["end_time", b"end_time", "start_time", b"start_time"]) -> None: ...
global___MaterializationInterval = MaterializationInterval
class FeatureViewList(google.protobuf.message.Message):
DESCRIPTOR: google.protobuf.descriptor.Descriptor
FEATUREVIEWS_FIELD_NUMBER: builtins.int
@property
def featureviews(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___FeatureView]: ...
def __init__(
self,
*,
featureviews: collections.abc.Iterable[global___FeatureView] | None = ...,
) -> None: ...
def ClearField(self, field_name: typing_extensions.Literal["featureviews", b"featureviews"]) -> None: ...
global___FeatureViewList = FeatureViewList