Method: annotationStores.export

Full name: projects.locations.datasets.annotationStores.export

Export Annotations from the Annotation store. If the request is successful, a detailed response is returned of type ExportAnnotationsResponse, contained in the [response][google.longrunning.Operation.result.response] field when the operation finishes. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see Viewing logs).

HTTP request

POST https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/annotationStores/*}:export

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name of the Annotation store to export annotations to, in the format of projects/{projectId}/locations/{locationId}/datasets/{datasetId}/annotationStores/{annotationStoreId}.

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

  • healthcare.annotationStores.export

Request body

The request body contains data with the following structure:

JSON representation
{

  // Union field destination can be only one of the following:
  "gcsDestination": {
    object(GcsDestination)
  },
  "bigqueryDestination": {
    object(BigQueryDestination)
  }
  // End of list of possible types for union field destination.
}
Fields
Union field destination. Destination for export. destination can be only one of the following:
gcsDestination

object(GcsDestination)

The Cloud Storage destination, which requires the roles/storage.objectAdmin Cloud IAM role.

bigqueryDestination

object(BigQueryDestination)

The BigQuery output destination, which requires two IAM roles: roles/bigquery.dataEditor and roles/bigquery.jobUser.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

GcsDestination

The Cloud Storage location for export.

JSON representation
{
  "uriPrefix": string
}
Fields
uriPrefix

string

The Cloud Storage destination to export to. URI for a Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in uriPrefix.