blob: dad5bf4c194f8944494e506407bc6bdcf40c6582 [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="firebasestorage_v1beta.html">Cloud Storage for Firebase API</a> . <a href="firebasestorage_v1beta.projects.html">projects</a> . <a href="firebasestorage_v1beta.projects.buckets.html">buckets</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#addFirebase">addFirebase(bucket, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Links a Google Cloud Storage bucket to a Firebase project.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a single linked storage bucket.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the linked storage buckets for a project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#removeFirebase">removeFirebase(bucket, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Unlinks a linked Google Cloud Storage bucket from a Firebase project.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="addFirebase">addFirebase(bucket, body=None, x__xgafv=None)</code>
<pre>Links a Google Cloud Storage bucket to a Firebase project.
Args:
bucket: string, Required. Resource name of the bucket, mirrors the ID of the underlying Google Cloud Storage bucket, `projects/{project_number}/buckets/{bucket_id}`. (required)
body: object, The request body.
The object takes the form of:
{ # The request used to link a Google Cloud Storage bucket to a Firebase project.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A storage bucket and its relation to a parent Firebase project.
&quot;location&quot;: &quot;A String&quot;, # Output only. Location of the storage bucket.
&quot;name&quot;: &quot;A String&quot;, # Resource name of the bucket.
&quot;reconciling&quot;: True or False, # Output only. Represents whether a bucket is being moved to a new location, in which case reconciling is set to true.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a single linked storage bucket.
Args:
name: string, Required. Resource name of the bucket, mirrors the ID of the underlying Google Cloud Storage bucket, `projects/{project_number}/buckets/{bucket_id}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A storage bucket and its relation to a parent Firebase project.
&quot;location&quot;: &quot;A String&quot;, # Output only. Location of the storage bucket.
&quot;name&quot;: &quot;A String&quot;, # Resource name of the bucket.
&quot;reconciling&quot;: True or False, # Output only. Represents whether a bucket is being moved to a new location, in which case reconciling is set to true.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the linked storage buckets for a project.
Args:
parent: string, Required. Resource name of the parent Firebase project, `projects/{project_number}`. (required)
pageSize: integer, The maximum number of buckets to return. If not set, the server will use a reasonable default.
pageToken: string, A page token, received from a previous `ListBuckets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBuckets` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response returned by `ListBuckets`.
&quot;buckets&quot;: [ # The list of linked buckets.
{ # A storage bucket and its relation to a parent Firebase project.
&quot;location&quot;: &quot;A String&quot;, # Output only. Location of the storage bucket.
&quot;name&quot;: &quot;A String&quot;, # Resource name of the bucket.
&quot;reconciling&quot;: True or False, # Output only. Represents whether a bucket is being moved to a new location, in which case reconciling is set to true.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="removeFirebase">removeFirebase(bucket, body=None, x__xgafv=None)</code>
<pre>Unlinks a linked Google Cloud Storage bucket from a Firebase project.
Args:
bucket: string, Required. Resource name of the bucket, mirrors the ID of the underlying Google Cloud Storage bucket, `projects/{project_number}/buckets/{bucket_id}`. (required)
body: object, The request body.
The object takes the form of:
{ # The request used to unlink a Google Cloud Storage bucket from a Firebase project.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
</body></html>