Method: projects.locations.privateConnections.list

Retrieves a list of private connections in a given project and location.

HTTP request

GET https://datamigration.googleapis.com/v1/{parent}/privateConnections

Path parameters

Parameters
parent

string

Required. The parent that owns the collection of private connections.

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

  • datamigration.privateconnections.list

Query parameters

Parameters
pageSize

integer

Maximum number of private connections to return. If unspecified, at most 50 private connections that are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

pageToken

string

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

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

filter

string

A filter expression that filters private connections listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list private connections created this year by specifying createTime %gt; 2021-01-01T00:00:00.000000000Z.

orderBy

string

Order by fields for the result.

Request body

The request body must be empty.

Response body

Response message for 'privateConnections.list' request.

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

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

object (PrivateConnection)

List of private connections.

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.