Method: projects.locations.connections.search

Returns Top matching Connections for a given query.

HTTP request

GET https://connectors.googleapis.com/v1/{name=projects/*/locations/*/connections}:search

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Parent resource of the Connection, of the form: projects/*/locations/*/connections

Query parameters

Parameters
query

string

Required. The query against which the search needs to be done.
pageSize

integer

Optional. The number of top matching connectors to return
pageToken

string

Optional. pageToken

Request body

The request body must be empty.

Response body

Response message for Connectors.SearchConnections.

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

JSON representation 
{
  "connections": [
    {
      object (SearchConnectionInstance)
    }
  ],
  "unreachable": [
    string
  ],
  "nextPageToken": string
}
Fields
connections[]

object (SearchConnectionInstance)

A list of connectors.
unreachable[]

string

Locations that could not be reached.
nextPageToken

string

Optional. pageToken

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

SearchConnectionInstance

SearchConnectionInstance represents an instance of connector with specific fields

JSON representation 
{
  "connection": {
    object (Connection)
  },
  "entitySchema": {
    object (RuntimeEntitySchema)
  },
  "actionSchema": {
    object (RuntimeActionSchema)
  }
}
Fields
connection

object (Connection)

Output only. Connection details
entitySchema

object (RuntimeEntitySchema)

Output only. Schema of a runtime entity.
actionSchema

object (RuntimeActionSchema)

Output only. Schema of a runtime action.