Method: projects.locations.dataAgents.list

Lists DataAgents in a given project and location.

HTTP request


GET https://geminidataanalytics.googleapis.com/v1beta/{parent=projects/*/locations/*}/dataAgents

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Parent value for ListDataAgentsRequest.

Query parameters

Parameters
pageSize

integer

Optional. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken

string

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

When paginating, all other parameters provided to dataAgents.list must match the call that provided the page token. The service may return fewer than this value.
filter

string

Optional. Filtering results. See AIP-160 for syntax.
orderBy

string

Optional. User specification for how to order the results.
showDeleted

boolean

Optional. If true, the list results will include soft-deleted DataAgents. Defaults to false.

Request body

The request body must be empty.

Response body

Message for response to listing DataAgents.

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

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

object (DataAgent)

The list of DataAgent.
nextPageToken

string

The next page token or empty if none.
unreachable[]

string

Unordered list. Locations that could not be reached.

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:

  • geminidataanalytics.dataAgents.list

For more information, see the IAM documentation.