Adds Firebase resources to the specified existing [Google Cloud Platform (GCP) Project
] (https://cloud.google.com/resource-manager/reference/rest/v1/projects). Since a FirebaseProject is actually also a GCP Project
, a FirebaseProject
has the same underlying GCP identifiers (projectNumber
and projectId
). This allows for easy interop with Google APIs. The result of this call is an Operation
. Poll the Operation
to track the provisioning process by calling GetOperation until done
is true
. When done
is true
, the Operation
has either succeeded or failed. If the Operation
succeeded, its response
is set to a FirebaseProject; if the Operation
failed, its error
is set to a google.rpc.Status. The Operation
is automatically deleted after completion, so there is no need to call DeleteOperation. This method does not modify any billing account information on the underlying GCP Project
. To call AddFirebase
, a project member or service account must have the following permissions (the IAM roles of Editor and Owner contain these permissions): firebase.projects.update
, resourcemanager.projects.get
, serviceusage.services.enable
, and serviceusage.services.get
.
Scopes
You will need authorization for at least one of the following scopes to make a valid call:
- https://www.googleapis.com/auth/cloud-platform
- https://www.googleapis.com/auth/firebase
If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform.
You can set the scope for this method like this: firebase1-beta1 --scope <scope> projects add-firebase ...
Required Scalar Argument
- <project> (string)
- The resource name of the GCP
Project
to which Firebase resources will be added, in the format: projects/PROJECT_IDENTIFIER Refer to theFirebaseProject
name
field for details about PROJECT_IDENTIFIER values. After callingAddFirebase
, the unique Project identifiers (projectNumber
andprojectId
) of the underlying GCPProject
are also the identifiers of the FirebaseProject.
- The resource name of the GCP
Required Request Value
The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.
For example, a structure like this:
AddFirebaseRequest:
location-id: string
can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.
-r . location-id=et
- Deprecated. Instead, to set a Project's default GCP resource location, call
FinalizeDefaultLocation
after you add Firebase resources to the GCPProject
. The ID of the Project's default GCP resource location. The location must be one of the available GCP resource locations.
- Deprecated. Instead, to set a Project's default GCP resource location, call
About Cursors
The cursor position is key to comfortably set complex nested structures. The following rules apply:
- The cursor position is always set relative to the current one, unless the field name starts with the
.
character. Fields can be nested such as in-r f.s.o
. - The cursor position is set relative to the top-level structure if it starts with
.
, e.g.-r .s.s
- You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify
-r struct.sub_struct=bar
. - You can move the cursor one level up by using
..
. Each additional.
moves it up one additional level. E.g....
would go three levels up.
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- 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.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- 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.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").