Method: projects.locations.datasets.export

Exports data from a Dataset.

HTTP request

POST https://{service-endpoint}/v1/{name}:export

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

Path parameters

Parameters
name

string

Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}

Request body

The request body contains data with the following structure:

JSON representation
{
  "exportConfig": {
    object (ExportDataConfig)
  }
}
Fields
exportConfig

object (ExportDataConfig)

Required. The desired output location.

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 name resource:

  • aiplatform.datasets.export

For more information, see the IAM documentation.

ExportDataConfig

Describes what part of the Dataset is to be exported, the destination of the export and how to export.

JSON representation
{
  "annotationsFilter": string,
  "gcsDestination": {
    object (GcsDestination)
  }
}
Fields
annotationsFilter

string

A filter on Annotations of the Dataset. Only Annotations on to-be-exported DataItems(specified by [data_items_filter][]) that match this filter will be exported. The filter syntax is the same as in annotations.list.

gcsDestination

object (GcsDestination)

The Google Cloud Storage location where the output is to be written to. In the given directory a new directory will be created with name: export-data-<dataset-display-name>-<timestamp-of-export-call> where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All export output will be written into that directory. Inside that directory, annotations with the same schema will be grouped into sub directories which are named with the corresponding annotations' schema title. Inside these sub directories, a schema.yaml will be created to describe the output format.