Method: googleapis.cloudresourcemanager.v3.projects.list

Lists projects that are direct children of the specified folder or organization resource. list() provides a strongly consistent view of the projects underneath the specified parent resource. list() returns projects sorted based upon the (ascending) lexical ordering of their display_name. The caller must have resourcemanager.projects.list permission on the identified parent.

Arguments

Parameters
pageSize

integer (int32 format)

Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default.

pageToken

string

Optional. A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.

parent

string

Required. The name of the parent resource to list projects under. For example, setting this field to 'folders/1234' would list all projects directly under that folder.

showDeleted

boolean

Optional. Indicate that projects in the DELETE_REQUESTED state should also be returned. Normally only ACTIVE projects are returned.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of ListProjectsResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- list:
    call: googleapis.cloudresourcemanager.v3.projects.list
    args:
        pageSize: ...
        pageToken: ...
        parent: ...
        showDeleted: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.cloudresourcemanager.v3.projects.list",
      "args": {
        "pageSize": "...",
        "pageToken": "...",
        "parent": "...",
        "showDeleted": "..."
      },
      "result": "listResult"
    }
  }
]