google_api_firebase

v0.3.0

google_api_firebase v0.3.0 GoogleApi.Firebase.V1beta1.Api.AvailableProjects View Source

API calls for all endpoints tagged AvailableProjects.

Link to this section Summary

Functions

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

Returns a list of [Google Cloud Platform (GCP) Projects] (https://cloud.google.com/resource-manager/reference/rest/v1/projects) that are available to have Firebase resources added to them.

Link to this section Functions

Link to this function

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

View Source 
firebase_available_projects_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Firebase.V1beta1.Model.ListAvailableProjectsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Returns a list of [Google Cloud Platform (GCP) Projects] (https://cloud.google.com/resource-manager/reference/rest/v1/projects) that are available to have Firebase resources added to them.



A GCP `Project` will only be returned if:

  1. The caller has sufficient [Google IAM](https://cloud.google.com/iam) permissions to call AddFirebase.

  2. The GCP `Project` is not already a FirebaseProject.

  3. The GCP `Project` is not in an Organization which has policies that prevent Firebase resources from being added.

Parameters

  • connection (type: GoogleApi.Firebase.V1beta1.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").
    • :pageSize (type: integer()) - The maximum number of GCP Projects to return in the response.

      The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.

      This value cannot be negative.
    • :pageToken (type: String.t) - Token returned from a previous call to ListAvailableProjects indicating where in the set of GCP Projects to resume listing.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Firebase.V1beta1.Model.ListAvailableProjectsResponse{}} on success
  • {:error, info} on failure