blob: ce8e35839d4cece4f5316fc172d8de659a6b1668 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="firebase_v1beta1.html">Firebase Management API</a> . <a href="firebase_v1beta1.projects.html">projects</a> . <a href="firebase_v1beta1.projects.defaultLocation.html">defaultLocation</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#finalize">finalize(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the default Google Cloud Platform (GCP) resource location for the</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="finalize">finalize(parent, body=None, x__xgafv=None)</code>
<pre>Sets the default Google Cloud Platform (GCP) resource location for the
specified FirebaseProject.
&lt;br&gt;
&lt;br&gt;This method creates an App Engine application with a
[default Cloud Storage
bucket](https://cloud.google.com/appengine/docs/standard/python/googlecloudstorageclient/setting-up-cloud-storage#activating_a_cloud_storage_bucket),
located in the specified
[`location_id`](#body.request_body.FIELDS.location_id).
This location must be one of the available
[GCP resource
locations](https://firebase.google.com/docs/projects/locations). &lt;br&gt;
&lt;br&gt;After the default GCP resource location is finalized, or if it was
already set, it cannot be changed. The default GCP resource location for
the specified FirebaseProject might already be set because either the
GCP `Project` already has an App Engine application or
`FinalizeDefaultLocation` was previously called with a specified
`location_id`. Any new calls to `FinalizeDefaultLocation` with a
&lt;em&gt;different&lt;/em&gt; specified `location_id` will return a 409 error.
&lt;br&gt;
&lt;br&gt;The result of this call is an [`Operation`](../../v1beta1/operations),
which can be used to track the provisioning process. The
[`response`](../../v1beta1/operations#Operation.FIELDS.response) type of
the `Operation` is google.protobuf.Empty.
&lt;br&gt;
&lt;br&gt;The `Operation` can be polled by its `name` using
GetOperation until `done` is
true. When `done` is true, the `Operation` has either succeeded or failed.
If the `Operation` has succeeded, its
[`response`](../../v1beta1/operations#Operation.FIELDS.response) will be
set to a google.protobuf.Empty; if the `Operation` has failed, its
`error` will be set to a google.rpc.Status. The `Operation` is
automatically deleted after completion, so there is no need to call
DeleteOperation.
&lt;br&gt;
&lt;br&gt;All fields listed in the [request body](#request-body) are required.
&lt;br&gt;
&lt;br&gt;To call `FinalizeDefaultLocation`, a member must be an Owner
of the project.
Args:
parent: string, The resource name of the Project for which the default GCP resource
location will be set, in the format:
&lt;br&gt;&lt;code&gt;projects/&lt;var&gt;PROJECT_NUMBER&lt;/var&gt;&lt;/code&gt; (required)
body: object, The request body.
The object takes the form of:
{
&quot;locationId&quot;: &quot;A String&quot;, # The ID of the default GCP resource location for the Project. The location
# must be one of the available
# [GCP resource
# locations](https://firebase.google.com/docs/projects/locations).
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a
# network API call.
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
},
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
&quot;response&quot;: { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
# methods, the response should have the type `XxxResponse`, where `Xxx`
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
}</pre>
</div>
</body></html>