Method: projects.locations.integrations.search

Searches and returns the list of integrations in the specified project.

HTTP request

GET https://integrations.googleapis.com/v1/{parent=projects/*/locations/*}/integrations:search

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Project and location from which the integrations should be listed. Format: projects/*/locations/*/resources/integrations

Query parameters

Parameters
query

string

Required. The user query
filter

string

Optional. The pre-filter to be applied to the search. This should follow the expressions defined in https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata. For example, "status:ANY("ACTIVE")" will return all the resources whose status contains the "ACTIVE".
pageSize

integer

Optional. The maximum number of results to return. The service may return fewer than this value. If unspecified, at most 10 results will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken

string

Optional. A page token, received from a previous integrations.search call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to integrations.search must match the call that provided the page token.
enableNaturalLanguageQueryUnderstanding

boolean

Optional. Whether to enable natural language query understanding.

Request body

The request body must be empty.

Response body

Response for integrations.search.

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

JSON representation 
{
  "integrations": [
    {
      object (IntegrationSearchResult)
    }
  ],
  "nextPageToken": string
}
Fields
integrations[]

object (IntegrationSearchResult)

The list of integrations that match the search criteria.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

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

  • integrations.integrations.list

For more information, see the IAM documentation.

IntegrationSearchResult

The integration search result with integration level information.

JSON representation 
{
  "name": string,
  "id": string,
  "creator": string,
  "description": string,
  "status": enum (IntegrationState),
  "region": string,
  "createTime": string,
  "version": string
}
Fields
name

string

The integration document metadata.
id

string

The integration id.
creator

string

The creator of the integration version.
description

string

The description of the integration version.
status

enum (IntegrationState)

Output only. The status of the integration version.
region

string

The region of the integration version.
createTime

string (Timestamp format)

Output only. The create time of the integration version.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
version

string

The version of the integration version.