Method: projects.locations.featurestores.entityTypes.exportFeatureValues

Exports Feature values from all the entities of a target EntityType.

HTTP request

POST https://{service-endpoint}/v1/{entityType}:exportFeatureValues

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

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:

JSON representation
{
  "destination": {
    object (FeatureValueDestination)
  },
  "featureSelector": {
    object (FeatureSelector)
  },
  "settings": [
    {
      object (DestinationFeatureSetting)
    }
  ],

  // Union field mode can be only one of the following:
  "snapshotExport": {
    object (SnapshotExport)
  },
  "fullExport": {
    object (FullExport)
  }
  // End of list of possible types for union field mode.
}
Fields
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.

Union field 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.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the entityType resource:

  • aiplatform.entityTypes.exportFeatureValues

For more information, see the IAM documentation.

SnapshotExport

Describes exporting the latest Feature values of all entities of the EntityType between [startTime, snapshotTime].

JSON representation
{
  "snapshotTime": string,
  "startTime": string
}
Fields
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".

FullExport

Describes exporting all historical Feature values of all entities of the EntityType between [startTime, endTime].

JSON representation
{
  "startTime": string,
  "endTime": string
}
Fields
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".