Method: projects.datasets.exportData

Exports data and annotations from dataset.

HTTP request

POST https://datalabeling.googleapis.com/v1beta1/{name=projects/*/datasets/*}:exportData

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

Authorization requires the following Google IAM permission on the specified resource name:

  • datalabeling.datasets.export

Request body

The request body contains data with the following structure:

JSON representation 
{
  "annotatedDataset": string,
  "filter": string,
  "outputConfig": {
    object (OutputConfig)
  },
  "userEmailAddress": string
}
Fields
annotatedDataset

string

Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}

filter

string

Optional. Filter is not supported at this moment.

outputConfig

object (OutputConfig)

Required. Specify the output destination.

userEmailAddress

string

Email of the user who started the export task and should be notified by email. If empty no notification will be sent.

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.

OutputConfig

The configuration of output data.

JSON representation 
{

  // Union field destination can be only one of the following:
  "gcsDestination": {
    object (GcsDestination)
  },
  "gcsFolderDestination": {
    object (GcsFolderDestination)
  }
  // End of list of possible types for union field destination.
}
Fields
Union field destination. Required. Location to output data to. destination can be only one of the following:
gcsDestination

object (GcsDestination)

Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation.

gcsFolderDestination

object (GcsFolderDestination)

Output to a folder in Cloud Storage. Should be used for image segmentation labeling output.

GcsDestination

Export destination of the data.Only gcs path is allowed in outputUri.

JSON representation 
{
  "outputUri": string,
  "mimeType": string
}
Fields
outputUri

string

Required. The output uri of destination file.

mimeType

string

Required. The format of the gcs destination. Only "text/csv" and "application/json" are supported.

GcsFolderDestination

Export folder destination of the data.

JSON representation 
{
  "outputFolderUri": string
}
Fields
outputFolderUri

string

Required. Cloud Storage directory to export data to.