Method: projects.locations.connectionProfiles.list

Use this method to list connection profiles created in a project and location.

HTTP request

GET https://datastream.googleapis.com/v1/{parent}/connectionProfiles

Path parameters

Parameters
parent

string

Required. The parent that owns the collection of connection profiles.

Authorization requires the following IAM permission on the specified resource parent:

  • datastream.connectionProfiles.list

Query parameters

Parameters
pageSize

integer

Maximum number of connection profiles to return. If unspecified, at most 50 connection profiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken

string

Page token received from a previous connectionProfiles.list call. Provide this to retrieve the subsequent page.

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

filter

string

Filter request.

orderBy

string

Order by fields for the result.

Request body

The request body must be empty.

Response body

Response message for listing connection profiles.

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

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

object (ConnectionProfile)

List of connection profiles.

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.

unreachable[]

string

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.