Exports feature values from all the entities of a target EntityType.
Endpoint
post
https://{service-endpoint}/v1/{entityType}:exportFeatureValues
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
entityType
string
Required. The resource name of the EntityType from which to export feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}
Request body
The request body contains data with the following structure:
destination
object (FeatureValueDestination
)
Required. Specifies destination location and format.
featureSelector
object (FeatureSelector
)
Required. Selects Features to export values of.
settings[]
object (DestinationFeatureSetting
)
Per-feature export settings.
mode
. Required. The mode in which Feature values are exported. mode
can be only one of the following:
snapshotExport
object (SnapshotExport
)
Exports the latest feature values of all entities of the EntityType within a time range.
fullExport
object (FullExport
)
Exports all historical values of all entities of the EntityType within a time range
Response body
If successful, the response body contains an instance of Operation
.
SnapshotExport
Describes exporting the latest feature values of all entities of the EntityType between [startTime, snapshotTime].
snapshotTime
string (Timestamp
format)
Exports feature values as of this timestamp. If not set, retrieve values as of now. timestamp, if present, must not have higher than millisecond precision.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z"
and "2014-10-02T15:01:23.045123456Z"
.
startTime
string (Timestamp
format)
Excludes feature values with feature generation timestamp before this timestamp. If not set, retrieve oldest values kept in feature Store. timestamp, if present, must not have higher than millisecond precision.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z"
and "2014-10-02T15:01:23.045123456Z"
.
JSON representation |
---|
{ "snapshotTime": string, "startTime": string } |
FullExport
Describes exporting all historical feature values of all entities of the EntityType between [startTime, endTime].
startTime
string (Timestamp
format)
Excludes feature values with feature generation timestamp before this timestamp. If not set, retrieve oldest values kept in feature Store. timestamp, if present, must not have higher than millisecond precision.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z"
and "2014-10-02T15:01:23.045123456Z"
.
endTime
string (Timestamp
format)
Exports feature values as of this timestamp. If not set, retrieve values as of now. timestamp, if present, must not have higher than millisecond precision.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z"
and "2014-10-02T15:01:23.045123456Z"
.
JSON representation |
---|
{ "startTime": string, "endTime": string } |