Method: projects.locations.providers.list

List providers.

HTTP request

GET https://eventarc.googleapis.com/v1/{parent=projects/*/locations/*}/providers

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent of the provider to get.

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

  • eventarc.providers.list

Query parameters

Parameters
pageSize

integer

The maximum number of providers to return on each page.

pageToken

string

The page token; provide the value from the nextPageToken field in a previous providers.list call to retrieve the subsequent page.

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

orderBy

string

The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting oder is ascending. To specify descending order for a field, append a desc suffix; for example: name desc, _id.

filter

string

The filter field that the list request will filter on.

Request body

The request body must be empty.

Response body

The response message for the providers.list method.

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

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

object (Provider)

The requested providers, up to the number specified in pageSize.

nextPageToken

string

A page token that can be sent to providers.list to request the next page. If this is empty, then there are no more pages.

unreachable[]

string

Unreachable resources, if any.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.