List sync operations

You can view the list of data sync operations executed for a specific feature view. This can be useful if you want to verify whether the data sync is being successfully synced from the BigQuery data source, or whether data sync is in progress for the feature view.

Before you begin

Authenticate to Vertex AI, unless you've done so already.

To use the REST API samples on this page in a local development environment, you use the credentials you provide to the gcloud CLI.

    Install the Google Cloud CLI. After installation, initialize the Google Cloud CLI by running the following command: 

    gcloud init

    If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

For more information, see Authenticate for using REST in the Google Cloud authentication documentation.

List sync operations in a feature view

Use the following sample to view a list of all sync operations executed for a feature view.

REST

To view the list of data sync operations in a FeatureView instance, send a GET request by using the featureViewSyncs.list method.

Before using any of the request data, make the following replacements:

  • LOCATION_ID: Region where the online store is located, such as us-central1.
  • PROJECT_ID: Your project ID.
  • FEATUREONLINESTORE_NAME: The name of the online store containing the feature view.
  • FEATUREVIEW_NAME: The name of the feature view for which you want to view the list of data sync operations.

HTTP method and URL: 

GET https://LOCATION_ID-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/featureOnlineStores/FEATUREONLINESTORE_NAME/featureViews/FEATUREVIEW_NAME/featureViewSyncs

To send your request, choose one of these options:

curl

Execute the following command: 

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION_ID-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/featureOnlineStores/FEATUREONLINESTORE_NAME/featureViews/FEATUREVIEW_NAME/featureViewSyncs"

PowerShell

Execute the following command: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION_ID-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/featureOnlineStores/FEATUREONLINESTORE_NAME/featureViews/FEATUREVIEW_NAME/featureViewSyncs" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{
  "featureViewSyncs": [
    {
      "name": "PROJECT_ID/locations/LOCATION_ID/featureOnlineStores/FEATUREONLINESTORE_NAME/featureViews/FEATUREVIEW_NAME/featureViewSyncs/OPERATION_ID_1",
      "createTime": "2023-09-11T15:33:24.906716Z",
      "dataTransfer": {
        "endTime": "2023-09-11T15:33:43.615598Z"
      },
      "finalStatus": {
        "code": 13
      },
      "runTime": {
        "endTime": "2023-09-11T15:33:43.615598Z"
      }
    },
    {
      "name": "PROJECT_ID/locations/LOCATION_ID/featureOnlineStores/FEATUREONLINESTORE_NAME/featureViews/FEATUREVIEW_NAME/featureViewSyncs/OPERATION_ID_2",
      "createTime": "2023-09-06T23:48:00.670844Z",
      "dataTransfer": {
        "endTime": "2023-09-06T23:48:19.086848Z"
      },
      "finalStatus": {
        "code": 13
      },
      "runTime": {
        "endTime": "2023-09-06T23:48:19.086848Z"
      }
    }
  ]
}

What's next