| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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"> |
| 78 | <code><a href="#list">list(pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Returns a list of [Google Cloud Platform (GCP) `Projects`]</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 82 | <p class="firstline">Retrieves the next page of results.</p> |
| 83 | <h3>Method Details</h3> |
| 84 | <div class="method"> |
| 85 | <code class="details" id="list">list(pageToken=None, pageSize=None, x__xgafv=None)</code> |
| 86 | <pre>Returns a list of [Google Cloud Platform (GCP) `Projects`] |
| 87 | (https://cloud.google.com/resource-manager/reference/rest/v1/projects) |
| 88 | that are available to have Firebase resources added to them. |
| 89 | <br> |
| 90 | <br>A GCP `Project` will only be returned if: |
| 91 | <ol> |
| 92 | <li><p>The caller has sufficient |
| 93 | [Google IAM](https://cloud.google.com/iam) permissions to call |
| 94 | AddFirebase.</p></li> |
| 95 | <li><p>The GCP `Project` is not already a FirebaseProject.</p></li> |
| 96 | <li><p>The GCP `Project` is not in an Organization which has policies |
| 97 | that prevent Firebase resources from being added.</p></li> |
| 98 | </ol> |
| 99 | |
| 100 | Args: |
| 101 | pageToken: string, Token returned from a previous call to `ListAvailableProjects` |
| 102 | indicating where in the set of GCP `Projects` to resume listing. |
| 103 | pageSize: integer, The maximum number of GCP `Projects` to return in the response. |
| 104 | <br> |
| 105 | <br>The server may return fewer than this value at its discretion. |
| 106 | If no value is specified (or too large a value is specified), the server |
| 107 | will impose its own limit. |
| 108 | <br> |
| 109 | <br>This value cannot be negative. |
| 110 | x__xgafv: string, V1 error format. |
| 111 | Allowed values |
| 112 | 1 - v1 error format |
| 113 | 2 - v2 error format |
| 114 | |
| 115 | Returns: |
| 116 | An object of the form: |
| 117 | |
| 118 | { |
| 119 | "nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token |
| 120 | # is returned. If the string is empty, then this response is the last page of |
| 121 | # results. |
| 122 | # <br> |
| 123 | # <br>This token can be used in a subsequent calls to `ListAvailableProjects` |
| 124 | # to find the next group of GCP `Projects`. |
| 125 | # <br> |
| 126 | # <br>Page tokens are short-lived and should not be persisted. |
| 127 | "projectInfo": [ # The list of GCP `Projects` which can have Firebase resources added to them. |
| 128 | { # A reference to a Google Cloud Platform (GCP) `Project`. |
| 129 | "displayName": "A String", # The user-assigned display name of the GCP `Project`, for example: |
| 130 | # <code>My App</code> |
| 131 | "locationId": "A String", # The ID of the project's default GCP resource location. The location is one |
| 132 | # of the available |
| 133 | # [GCP resource |
| 134 | # locations](https://firebase.google.com/docs/projects/locations). <br> <br> |
| 135 | # Not all projects will have this field populated. If it is not populated, it |
| 136 | # means that the project does not yet have a default GCP resource location. |
| 137 | # To set your project's default GCP resource location, call |
| 138 | # [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you |
| 139 | # add Firebase resources to your project. |
| 140 | "project": "A String", # The resource name of the GCP `Project` to which Firebase resources can be |
| 141 | # added, in the format: |
| 142 | # <br><code>projects/<var>projectId</var></code> |
| 143 | }, |
| 144 | ], |
| 145 | }</pre> |
| 146 | </div> |
| 147 | |
| 148 | <div class="method"> |
| 149 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 150 | <pre>Retrieves the next page of results. |
| 151 | |
| 152 | Args: |
| 153 | previous_request: The request for the previous page. (required) |
| 154 | previous_response: The response from the request for the previous page. (required) |
| 155 | |
| 156 | Returns: |
| 157 | A request object that you can call 'execute()' on to request the next |
| 158 | page. Returns None if there are no more items in the collection. |
| 159 | </pre> |
| 160 | </div> |
| 161 | |
| 162 | </body></html> |