Method: projects.locations.sampleQuerySets.sampleQueries.import

Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted.

Note: It is possible for a subset of the SampleQuerys to be successfully imported.

HTTP request

POST https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/sampleQuerySets/*}/sampleQueries:import

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent sample query set resource name, such as projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a PERMISSION_DENIED error is returned.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "errorConfig": {
    object (ImportErrorConfig)
  },

  // Union field source can be only one of the following:
  "inlineSource": {
    object (InlineSource)
  },
  "gcsSource": {
    object (GcsSource)
  },
  "bigquerySource": {
    object (BigQuerySource)
  }
  // End of list of possible types for union field source.
}
Fields
errorConfig

object (ImportErrorConfig)

The desired location of errors incurred during the Import.
Union field source. The source of the sample queries. source can be only one of the following:
inlineSource

object (InlineSource)

The Inline source for sample query entries.
gcsSource

object (GcsSource)

Cloud Storage location for the input content.
bigquerySource

object (BigQuerySource)

BigQuery input source.

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-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.sampleQueries.import

For more information, see the IAM documentation.

InlineSource

The inline source for SampleQuerys.

JSON representation 
{
  "sampleQueries": [
    {
      object (SampleQuery)
    }
  ]
}
Fields
sampleQueries[]

object (SampleQuery)

Required. A list of SampleQuerys to import. Max of 1000 items.