Method: projects.locations.collections.dataConnector.connectorRuns.list

Lists the ConnectorRuns of a DataConnector.

HTTP request

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/dataConnector}/connectorRuns

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent DataConnector resource name, such as projects/{project}/locations/{location}/collections/{collectionId}/dataConnector.

If the caller does not have permission to list ConnectorRuns under this DataConnector, regardless of whether or not this DataConnector exists, a PERMISSION_DENIED error is returned.

Query parameters

Parameters
pageSize

integer

Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50.

If this field is negative, an INVALID_ARGUMENT error is returned.
pageToken

string

A page token, received from a previous connectorRuns.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to connectorRuns.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response for DataConnectorService.ListConnectorRuns method.

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

JSON representation 
{
  "connectorRuns": [
    {
      object (ConnectorRun)
    }
  ],
  "nextPageToken": string
}
Fields
connectorRuns[]

object (ConnectorRun)

List of ConnectorRuns.
nextPageToken

string

A token that 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:

  • discoveryengine.connectorRuns.list

For more information, see the IAM documentation.