GoogleApi.CloudResourceManager.V1.Api.Projects.cloudresourcemanager_projects_list

You're seeing just the function cloudresourcemanager_projects_list, go back to GoogleApi.CloudResourceManager.V1.Api.Projects module for more information.
Link to this function

cloudresourcemanager_projects_list(connection, optional_params \\ [], opts \\ [])

View Source

Specs

cloudresourcemanager_projects_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.CloudResourceManager.V1.Model.ListProjectsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.CloudResourceManager.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - 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 strings: | Filter | 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 : : : labelsize 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 (type: integer()) - 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 (type: String.t) - Optional. A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudResourceManager.V1.Model.ListProjectsResponse{}} on success
  • {:error, info} on failure