blob: 84393665ee202db851045882496b97c384e66372 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<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.projects.html">projects</a> . <a href="firebase_v1beta1.projects.iosApps.html">iosApps</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070081 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070082<p class="firstline">Requests the creation of a new IosApp in the specified FirebaseProject. The result of this call is an `Operation` which can be used to track the provisioning process. The `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070083<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085<p class="firstline">Gets the specified IosApp.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070086<p class="toc_element">
87 <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets the configuration artifact associated with the specified IosApp.</p>
89<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -080090 <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091<p class="firstline">Lists each IosApp associated with the specified FirebaseProject. The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a `pageToken`.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070092<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097<p class="firstline">Updates the attributes of the specified IosApp.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070098<h3>Method Details</h3>
99<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700106 <pre>Requests the creation of a new IosApp in the specified FirebaseProject. The result of this call is an `Operation` which can be used to track the provisioning process. The `Operation` is automatically deleted after completion, so there is no need to call `DeleteOperation`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700107
108Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700109 parent: string, The resource name of the parent FirebaseProject in which to create an IosApp, in the format: projects/PROJECT_IDENTIFIER/iosApps Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700110 body: object, The request body.
111 The object takes the form of:
112
113{ # Details of a Firebase App for iOS.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800114 &quot;bundleId&quot;: &quot;A String&quot;, # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
115 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name for the `IosApp`.
116 &quot;projectId&quot;: &quot;A String&quot;, # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`.
117 &quot;appStoreId&quot;: &quot;A String&quot;, # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
118 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier for the `IosApp`. This identifier should be treated as an opaque token, as the data format is not specified.
119 &quot;name&quot;: &quot;A String&quot;, # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).
120 }
Bu Sun Kim65020912020-05-20 12:08:20 -0700121
122 x__xgafv: string, V1 error format.
123 Allowed values
124 1 - v1 error format
125 2 - v2 error format
126
127Returns:
128 An object of the form:
129
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700130 { # This resource represents a long-running operation that is the result of a network API call.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700131 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800132 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700133 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim65020912020-05-20 12:08:20 -0700134 {
135 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
136 },
137 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700138 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700139 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800140 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700141 &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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700142 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
143 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700144 &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.
145 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
146 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800147 &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}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700148 }</pre>
149</div>
150
151<div class="method">
152 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700153 <pre>Gets the specified IosApp.
Bu Sun Kim65020912020-05-20 12:08:20 -0700154
155Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700156 name: string, The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: projects/-/iosApps/APP_ID Refer to the `IosApp` [`name`](../projects.iosApps#IosApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700157 x__xgafv: string, V1 error format.
158 Allowed values
159 1 - v1 error format
160 2 - v2 error format
161
162Returns:
163 An object of the form:
164
165 { # Details of a Firebase App for iOS.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800166 &quot;bundleId&quot;: &quot;A String&quot;, # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
167 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name for the `IosApp`.
168 &quot;projectId&quot;: &quot;A String&quot;, # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`.
169 &quot;appStoreId&quot;: &quot;A String&quot;, # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
170 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier for the `IosApp`. This identifier should be treated as an opaque token, as the data format is not specified.
171 &quot;name&quot;: &quot;A String&quot;, # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).
172 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700173</div>
174
175<div class="method">
176 <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
177 <pre>Gets the configuration artifact associated with the specified IosApp.
178
179Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700180 name: string, The resource name of the App configuration to download, in the format: projects/PROJECT_IDENTIFIER/iosApps/APP_ID/config Since an APP_ID is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format: projects/-/iosApps/APP_ID Refer to the `IosApp` [`name`](../projects.iosApps#IosApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700181 x__xgafv: string, V1 error format.
182 Allowed values
183 1 - v1 error format
184 2 - v2 error format
185
186Returns:
187 An object of the form:
188
189 { # Configuration metadata of a single Firebase App for iOS.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700190 &quot;configFileContents&quot;: &quot;A String&quot;, # The content of the XML configuration file.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700191 &quot;configFilename&quot;: &quot;A String&quot;, # The filename that the configuration artifact for the `IosApp` is typically saved as. For example: `GoogleService-Info.plist`
Bu Sun Kim65020912020-05-20 12:08:20 -0700192 }</pre>
193</div>
194
195<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800196 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700197 <pre>Lists each IosApp associated with the specified FirebaseProject. The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a `pageToken`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700198
199Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700200 parent: string, The resource name of the parent FirebaseProject for which to list each associated IosApp, in the format: projects/PROJECT_IDENTIFIER/iosApps Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700201 pageToken: string, Token returned from a previous call to `ListIosApps` indicating where in the set of Apps to resume listing.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800202 pageSize: integer, The maximum number of Apps to return in the response. The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.
Bu Sun Kim65020912020-05-20 12:08:20 -0700203 x__xgafv: string, V1 error format.
204 Allowed values
205 1 - v1 error format
206 2 - v2 error format
207
208Returns:
209 An object of the form:
210
211 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700212 &quot;apps&quot;: [ # List of each `IosApp` associated with the specified `FirebaseProject`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700213 { # Details of a Firebase App for iOS.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800214 &quot;bundleId&quot;: &quot;A String&quot;, # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
215 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name for the `IosApp`.
216 &quot;projectId&quot;: &quot;A String&quot;, # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`.
217 &quot;appStoreId&quot;: &quot;A String&quot;, # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
218 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier for the `IosApp`. This identifier should be treated as an opaque token, as the data format is not specified.
219 &quot;name&quot;: &quot;A String&quot;, # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).
220 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700221 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800222 &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 call to `ListIosApps` to find the next group of Apps. Page tokens are short-lived and should not be persisted.
Bu Sun Kim65020912020-05-20 12:08:20 -0700223 }</pre>
224</div>
225
226<div class="method">
227 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
228 <pre>Retrieves the next page of results.
229
230Args:
231 previous_request: The request for the previous page. (required)
232 previous_response: The response from the request for the previous page. (required)
233
234Returns:
235 A request object that you can call &#x27;execute()&#x27; on to request the next
236 page. Returns None if there are no more items in the collection.
237 </pre>
238</div>
239
240<div class="method">
241 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700242 <pre>Updates the attributes of the specified IosApp.
Bu Sun Kim65020912020-05-20 12:08:20 -0700243
244Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700245 name: string, The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)). (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700246 body: object, The request body.
247 The object takes the form of:
248
249{ # Details of a Firebase App for iOS.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800250 &quot;bundleId&quot;: &quot;A String&quot;, # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
251 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name for the `IosApp`.
252 &quot;projectId&quot;: &quot;A String&quot;, # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`.
253 &quot;appStoreId&quot;: &quot;A String&quot;, # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
254 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier for the `IosApp`. This identifier should be treated as an opaque token, as the data format is not specified.
255 &quot;name&quot;: &quot;A String&quot;, # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).
256 }
Bu Sun Kim65020912020-05-20 12:08:20 -0700257
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700258 updateMask: string, Specifies which fields to update. Note that the fields `name`, `appId`, `projectId`, and `bundleId` are all immutable.
Bu Sun Kim65020912020-05-20 12:08:20 -0700259 x__xgafv: string, V1 error format.
260 Allowed values
261 1 - v1 error format
262 2 - v2 error format
263
264Returns:
265 An object of the form:
266
267 { # Details of a Firebase App for iOS.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800268 &quot;bundleId&quot;: &quot;A String&quot;, # Immutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
269 &quot;displayName&quot;: &quot;A String&quot;, # The user-assigned display name for the `IosApp`.
270 &quot;projectId&quot;: &quot;A String&quot;, # Immutable. A user-assigned unique identifier of the parent FirebaseProject for the `IosApp`.
271 &quot;appStoreId&quot;: &quot;A String&quot;, # The automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
272 &quot;appId&quot;: &quot;A String&quot;, # Immutable. The globally unique, Firebase-assigned identifier for the `IosApp`. This identifier should be treated as an opaque token, as the data format is not specified.
273 &quot;name&quot;: &quot;A String&quot;, # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project&#x27;s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google&#x27;s [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).
274 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700275</div>
276
277</body></html>