Method: projects.locations.retrieval.retrieveBigQueryTableSuggestedDescriptions

Retrieves BigQuery table schema with suggested table and column descriptions.

HTTP request

POST https://geminidataanalytics.googleapis.com/v1alpha/{parent=projects/*/locations/*}/retrieval:retrieveBigQueryTableSuggestedDescriptions

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Parent value for RetrieveBigQueryTableSuggestedDescriptionsRequest. Pattern: projects/{project}/locations/{location} For location, use "global" for now. Regional location value will be supported in the future.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "directLookup": [
    {
      object (DirectLookup)
    }
  ]
}
Fields
directLookup[]

object (DirectLookup)

Optional. A list of direct lookup parameters.

Response body

Response for retrieving BigQuery table schema with suggested table and column descriptions. Columns are sorted by default BigQuery table schema order.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "tableCandidates": [
    {
      object (TableCandidate)
    }
  ]
}
Fields
tableCandidates[]

object (TableCandidate)

List of retrieved candidates with their bundled metadata.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.