Method: googleapis.cloudresourcemanager.v1.projects.list

Lists Projects that the caller has the resourcemanager.projects.get permission on and satisfy the specified filter. This method returns Projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method. NOTE: If the request filter contains a parent.type and parent.id and the caller has the resourcemanager.projects.list permission on the parent, the results will be drawn from an alternate index which provides more consistent results. In future versions of this API, this List method will be split into List and Search to properly capture the behavioral difference.

Arguments

Parameters

Parameters
`filter`	`string` Optional. An expression for filtering the results of the request. Filter rules are case insensitive. If multiple fields are included in a filter query, the query will return results that match any of the fields. Some eligible fields for filtering are: + `name` + `id` + `labels.` (where key is the name of a label) + `parent.type` + `parent.id` + `lifecycleState` Some examples of filter queries: \| Query \| Description \| \|------------------\|-----------------------------------------------------\| \| name:how \| The project's name starts with "how". \| \| name:Howl \| The project's name is `Howl` or `howl`. \| \| name:HOWL \| Equivalent to above. \| \| NAME:howl \| Equivalent to above. \| \| labels.color: \| The project has the label `color`. \| \| labels.color:red \| The project's label `color` has the value `red`. \| \| labels.color:red labels.size:big \| The project's label `color` has the value `red` and its label `size` has the value `big`.\| \| lifecycleState:DELETE_REQUESTED \| Only show projects that are pending deletion.\| If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: "parent.type:folder parent.id:123"). In this case an alternate search index is used which provides more consistent results.
`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.

filter

string

Optional. An expression for filtering the results of the request. Filter rules are case insensitive. If multiple fields are included in a filter query, the query will return results that match any of the fields. Some eligible fields for filtering are: + name + id + labels. (where key is the name of a label) + parent.type + parent.id + lifecycleState Some examples of filter queries: | Query | Description | |------------------|-----------------------------------------------------| | name:how | The project's name starts with "how". | | name:Howl | The project's name is Howl or howl. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color: | The project has the label color. | | labels.color:red | The project's label color has the value red. | | labels.color:red labels.size:big | The project's label color has the value red and its label size has the value big.| | lifecycleState:DELETE_REQUESTED | Only show projects that are pending deletion.| If no filter is specified, the call will return projects for which the user has the resourcemanager.projects.get permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the resourcemanager.projects.list permission on the parent and the filter must contain both a parent.type and a parent.id restriction (example: "parent.type:folder parent.id:123"). In this case an alternate search index is used which provides more consistent results.

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.

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.v1.projects.list
    args:
        filter: ...
        pageSize: ...
        pageToken: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.cloudresourcemanager.v1.projects.list",
      "args": {
        "filter": "...",
        "pageSize": "...",
        "pageToken": "..."
      },
      "result": "listResult"
    }
  }
]