Method: projects.locations.customTargetTypes.list

Lists CustomTargetTypes in a given project and location.

HTTP request

GET https://clouddeploy.googleapis.com/v1/{parent=projects/*/locations/*}/customTargetTypes

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent that owns this collection of custom target types. Format must be projects/{projectId}/locations/{location_name}.

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of CustomTargetType objects to return. The service may return fewer than this value. If unspecified, at most 50 CustomTargetType objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

pageToken

string

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

When paginating, all other provided parameters match the call that provided the page token.

filter

string

Optional. Filter custom target types to be returned. See https://google.aip.dev/160 for more details.

orderBy

string

Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

Request body

The request body must be empty.

Response body

The response object from customTargetTypes.list.

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

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

object (CustomTargetType)

The CustomTargetType objects.

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.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • clouddeploy.customTargetTypes.list

For more information, see the IAM documentation.