blob: 1a739e2732eb1cbf66e3a9b9e26d385b21e753fe [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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="appengine_v1alpha.html">App Engine Admin API</a> . <a href="appengine_v1alpha.apps.html">apps</a> . <a href="appengine_v1alpha.apps.domainMappings.html">domainMappings</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#create">create(appsId, body=None, overrideStrategy=None, noManagedCertificate=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<p class="firstline">Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(appsId, domainMappingsId, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.</p>
83<p class="toc_element">
84 <code><a href="#get">get(appsId, domainMappingsId, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets the specified domain mapping.</p>
86<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070087 <code><a href="#list">list(appsId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Lists the domain mappings on an application.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070093 <code><a href="#patch">patch(appsId, domainMappingsId, body=None, noManagedCertificate=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="firstline">Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.</p>
95<h3>Method Details</h3>
96<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070097 <code class="details" id="create">create(appsId, body=None, overrideStrategy=None, noManagedCertificate=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070098 <pre>Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.
99
100Args:
101 appsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700103 The object takes the form of:
104
105{ # A domain serving an App Engine application.
Bu Sun Kim65020912020-05-20 12:08:20 -0700106 &quot;name&quot;: &quot;A String&quot;, # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
107 &quot;sslSettings&quot;: { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
108 &quot;isManagedCertificate&quot;: True or False, # Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly
109 &quot;certificateId&quot;: &quot;A String&quot;, # ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.
110 },
111 &quot;id&quot;: &quot;A String&quot;, # Relative name of the domain serving the application. Example: example.com.
112 &quot;resourceRecords&quot;: [ # The resource records required to configure this domain mapping. These records must be added to the domain&#x27;s DNS configuration in order to serve the application via this domain mapping.@OutputOnly
113 { # A DNS resource record.
114 &quot;name&quot;: &quot;A String&quot;, # Relative name of the object affected by this record. Only applicable for CNAME records. Example: &#x27;www&#x27;.
115 &quot;type&quot;: &quot;A String&quot;, # Resource record type. Example: AAAA.
116 &quot;rrdata&quot;: &quot;A String&quot;, # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700117 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700118 ],
119}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700120
121 overrideStrategy: string, Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.
122 noManagedCertificate: boolean, Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manaually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated.
123 x__xgafv: string, V1 error format.
124 Allowed values
125 1 - v1 error format
126 2 - v2 error format
127
128Returns:
129 An object of the form:
130
131 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700132 &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}.
133 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700134 &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.
135 &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 Kim715bd7f2019-06-14 16:50:42 -0700136 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700137 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700138 },
139 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700140 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700141 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700142 &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.
143 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700144 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700145 &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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700146 &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.
147 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
148 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="delete">delete(appsId, domainMappingsId, x__xgafv=None)</code>
154 <pre>Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.
155
156Args:
157 appsId: string, Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com. (required)
158 domainMappingsId: string, Part of `name`. See documentation of `appsId`. (required)
159 x__xgafv: string, V1 error format.
160 Allowed values
161 1 - v1 error format
162 2 - v2 error format
163
164Returns:
165 An object of the form:
166
167 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700168 &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}.
169 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700170 &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.
171 &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 Kim715bd7f2019-06-14 16:50:42 -0700172 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700173 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700174 },
175 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700176 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700177 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700178 &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.
179 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700180 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700181 &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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700182 &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.
183 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
184 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700185 }</pre>
186</div>
187
188<div class="method">
189 <code class="details" id="get">get(appsId, domainMappingsId, x__xgafv=None)</code>
190 <pre>Gets the specified domain mapping.
191
192Args:
193 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com. (required)
194 domainMappingsId: string, Part of `name`. See documentation of `appsId`. (required)
195 x__xgafv: string, V1 error format.
196 Allowed values
197 1 - v1 error format
198 2 - v2 error format
199
200Returns:
201 An object of the form:
202
203 { # A domain serving an App Engine application.
Bu Sun Kim65020912020-05-20 12:08:20 -0700204 &quot;name&quot;: &quot;A String&quot;, # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
205 &quot;sslSettings&quot;: { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
206 &quot;isManagedCertificate&quot;: True or False, # Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly
207 &quot;certificateId&quot;: &quot;A String&quot;, # ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.
208 },
209 &quot;id&quot;: &quot;A String&quot;, # Relative name of the domain serving the application. Example: example.com.
210 &quot;resourceRecords&quot;: [ # The resource records required to configure this domain mapping. These records must be added to the domain&#x27;s DNS configuration in order to serve the application via this domain mapping.@OutputOnly
211 { # A DNS resource record.
212 &quot;name&quot;: &quot;A String&quot;, # Relative name of the object affected by this record. Only applicable for CNAME records. Example: &#x27;www&#x27;.
213 &quot;type&quot;: &quot;A String&quot;, # Resource record type. Example: AAAA.
214 &quot;rrdata&quot;: &quot;A String&quot;, # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700215 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700216 ],
217 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700218</div>
219
220<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700221 <code class="details" id="list">list(appsId, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700222 <pre>Lists the domain mappings on an application.
223
224Args:
225 appsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700226 pageToken: string, Continuation token for fetching the next page of results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700227 pageSize: integer, Maximum results to return per page.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700228 x__xgafv: string, V1 error format.
229 Allowed values
230 1 - v1 error format
231 2 - v2 error format
232
233Returns:
234 An object of the form:
235
236 { # Response message for DomainMappings.ListDomainMappings.
Bu Sun Kim65020912020-05-20 12:08:20 -0700237 &quot;domainMappings&quot;: [ # The domain mappings for the application.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700238 { # A domain serving an App Engine application.
Bu Sun Kim65020912020-05-20 12:08:20 -0700239 &quot;name&quot;: &quot;A String&quot;, # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
240 &quot;sslSettings&quot;: { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
241 &quot;isManagedCertificate&quot;: True or False, # Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly
242 &quot;certificateId&quot;: &quot;A String&quot;, # ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700243 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700244 &quot;id&quot;: &quot;A String&quot;, # Relative name of the domain serving the application. Example: example.com.
245 &quot;resourceRecords&quot;: [ # The resource records required to configure this domain mapping. These records must be added to the domain&#x27;s DNS configuration in order to serve the application via this domain mapping.@OutputOnly
246 { # A DNS resource record.
247 &quot;name&quot;: &quot;A String&quot;, # Relative name of the object affected by this record. Only applicable for CNAME records. Example: &#x27;www&#x27;.
248 &quot;type&quot;: &quot;A String&quot;, # Resource record type. Example: AAAA.
249 &quot;rrdata&quot;: &quot;A String&quot;, # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
250 },
251 ],
252 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700253 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700254 &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token for fetching the next page of results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700255 }</pre>
256</div>
257
258<div class="method">
259 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
260 <pre>Retrieves the next page of results.
261
262Args:
263 previous_request: The request for the previous page. (required)
264 previous_response: The response from the request for the previous page. (required)
265
266Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700267 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700268 page. Returns None if there are no more items in the collection.
269 </pre>
270</div>
271
272<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700273 <code class="details" id="patch">patch(appsId, domainMappingsId, body=None, noManagedCertificate=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700274 <pre>Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.
275
276Args:
277 appsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com. (required)
278 domainMappingsId: string, Part of `name`. See documentation of `appsId`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700279 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700280 The object takes the form of:
281
282{ # A domain serving an App Engine application.
Bu Sun Kim65020912020-05-20 12:08:20 -0700283 &quot;name&quot;: &quot;A String&quot;, # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
284 &quot;sslSettings&quot;: { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
285 &quot;isManagedCertificate&quot;: True or False, # Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly
286 &quot;certificateId&quot;: &quot;A String&quot;, # ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.
287 },
288 &quot;id&quot;: &quot;A String&quot;, # Relative name of the domain serving the application. Example: example.com.
289 &quot;resourceRecords&quot;: [ # The resource records required to configure this domain mapping. These records must be added to the domain&#x27;s DNS configuration in order to serve the application via this domain mapping.@OutputOnly
290 { # A DNS resource record.
291 &quot;name&quot;: &quot;A String&quot;, # Relative name of the object affected by this record. Only applicable for CNAME records. Example: &#x27;www&#x27;.
292 &quot;type&quot;: &quot;A String&quot;, # Resource record type. Example: AAAA.
293 &quot;rrdata&quot;: &quot;A String&quot;, # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700294 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700295 ],
296}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700297
298 noManagedCertificate: boolean, Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated. Only applicable if ssl_settings.certificate_id is specified in the update mask.
Bu Sun Kim65020912020-05-20 12:08:20 -0700299 updateMask: string, Standard field mask for the set of fields to be updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700300 x__xgafv: string, V1 error format.
301 Allowed values
302 1 - v1 error format
303 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700304
305Returns:
306 An object of the form:
307
308 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700309 &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}.
310 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700311 &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.
312 &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 Kim715bd7f2019-06-14 16:50:42 -0700313 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700314 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700315 },
316 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700317 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700318 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700319 &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.
320 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700321 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700322 &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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700323 &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.
324 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
325 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700326 }</pre>
327</div>
328
329</body></html>