Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4d1153db18a3edf86c5bb83149b4f1c0ba95f810 / . / docs / dyn / firebase_v1beta1.availableProjects.html
blob: f0847c96437aff5c2887a9bb969c45ec4b745d7c [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="firebase_v1beta1.html">Firebase Management API</a> . <a href="firebase_v1beta1.availableProjects.html">availableProjects</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]81 <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Lists each [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/resource-manager/reference/rest/v1/projects) that can have Firebase resources added to it. A Project will only be listed if: - The caller has sufficient [Google IAM](https://cloud.google.com/iam) permissions to call AddFirebase. - The Project is not already a FirebaseProject. - The Project is not in an Organization which has policies that prevent Firebase resources from being added. </p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]93 <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <pre>Lists each [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/resource-manager/reference/rest/v1/projects) that can have Firebase resources added to it. A Project will only be listed if: - The caller has sufficient [Google IAM](https://cloud.google.com/iam) permissions to call AddFirebase. - The Project is not already a FirebaseProject. - The Project is not in an Organization which has policies that prevent Firebase resources from being added.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]95
96Args:
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]97 pageSize: integer, The maximum number of 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]98 pageToken: string, Token returned from a previous call to `ListAvailableProjects` indicating where in the set of Projects to resume listing.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]99 x__xgafv: string, V1 error format.
100 Allowed values
101 1 - v1 error format
102 2 - v2 error format
103
104Returns:
105 An object of the form:
106
107 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]108 &quot;nextPageToken&quot;: &quot;A String&quot;, # If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent calls to `ListAvailableProjects` to find the next group of Projects. Page tokens are short-lived and should not be persisted.
109 &quot;projectInfo&quot;: [ # The list of GCP `Projects` which can have Firebase resources added to them.
110 { # A reference to a Google Cloud Platform (GCP) `Project`.
111 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name of the GCP `Project`, for example: `My App`
112 &quot;locationId&quot;: &quot;A String&quot;, # The ID of the Project&#x27;s default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). Not all Projects will have this field populated. If it is not populated, it means that the Project does not yet have a default GCP resource location. To set a Project&#x27;s default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.
113 &quot;project&quot;: &quot;A String&quot;, # The resource name of the GCP `Project` to which Firebase resources can be added, in the format: projects/PROJECT_IDENTIFIER Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
114 },
115 ],
116}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117</div>
118
119<div class="method">
120 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
121 <pre>Retrieves the next page of results.
122
123Args:
124 previous_request: The request for the previous page. (required)
125 previous_response: The response from the request for the previous page. (required)
126
127Returns:
128 A request object that you can call &#x27;execute()&#x27; on to request the next
129 page. Returns None if there are no more items in the collection.
130 </pre>
131</div>
132
133</body></html>