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="appengine_v1beta.html">Google App Engine Admin API</a> . <a href="appengine_v1beta.apps.html">apps</a> . <a href="appengine_v1beta.apps.domainMappings.html">domainMappings</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#create">create(appsId, body, x__xgafv=None)</a></code></p>
79<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">
87  <code><a href="#list">list(appsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88<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">
93  <code><a href="#patch">patch(appsId, domainMappingsId, body, updateMask=None, x__xgafv=None)</a></code></p>
94<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">
97    <code class="details" id="create">create(appsId, body, x__xgafv=None)</code>
98  <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)
102  body: object, The request body. (required)
103    The object takes the form of:
104
105{ # A domain serving an App Engine application.
106    "sslSettings": { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
107      "certificateId": "A String", # ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.
108    },
109    "id": "A String", # Relative name of the domain serving the application. Example: example.com.
110    "name": "A String", # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
111    "resourceRecords": [ # The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
112      { # A DNS resource record.
113        "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
114        "type": "A String", # Resource record type. Example: AAAA.
115        "name": "A String", # Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
116      },
117    ],
118  }
119
120  x__xgafv: string, V1 error format.
121    Allowed values
122      1 - v1 error format
123      2 - v2 error format
124
125Returns:
126  An object of the form:
127
128    { # This resource represents a long-running operation that is the result of a network API call.
129    "metadata": { # 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.
130      "a_key": "", # Properties of the object. Contains field @type with type URL.
131    },
132    "error": { # 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). The error model is designed to be: # The error result of the operation in case of failure or cancellation.
133        # Simple to use and understand for most users
134        # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
135        # Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
136        # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
137        # Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
138        # Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
139        # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
140      "message": "A String", # 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.
141      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
142      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
143        {
144          "a_key": "", # Properties of the object. Contains field @type with type URL.
145        },
146      ],
147    },
148    "done": 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.
149    "response": { # 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.
150      "a_key": "", # Properties of the object. Contains field @type with type URL.
151    },
152    "name": "A String", # 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 have the format of operations/some/unique/name.
153  }</pre>
154</div>
155
156<div class="method">
157    <code class="details" id="delete">delete(appsId, domainMappingsId, x__xgafv=None)</code>
158  <pre>Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.
159
160Args:
161  appsId: string, Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com. (required)
162  domainMappingsId: string, Part of `name`. See documentation of `appsId`. (required)
163  x__xgafv: string, V1 error format.
164    Allowed values
165      1 - v1 error format
166      2 - v2 error format
167
168Returns:
169  An object of the form:
170
171    { # This resource represents a long-running operation that is the result of a network API call.
172    "metadata": { # 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.
173      "a_key": "", # Properties of the object. Contains field @type with type URL.
174    },
175    "error": { # 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). The error model is designed to be: # The error result of the operation in case of failure or cancellation.
176        # Simple to use and understand for most users
177        # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
178        # Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
179        # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
180        # Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
181        # Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
182        # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
183      "message": "A String", # 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.
184      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
185      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
186        {
187          "a_key": "", # Properties of the object. Contains field @type with type URL.
188        },
189      ],
190    },
191    "done": 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.
192    "response": { # 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.
193      "a_key": "", # Properties of the object. Contains field @type with type URL.
194    },
195    "name": "A String", # 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 have the format of operations/some/unique/name.
196  }</pre>
197</div>
198
199<div class="method">
200    <code class="details" id="get">get(appsId, domainMappingsId, x__xgafv=None)</code>
201  <pre>Gets the specified domain mapping.
202
203Args:
204  appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com. (required)
205  domainMappingsId: string, Part of `name`. See documentation of `appsId`. (required)
206  x__xgafv: string, V1 error format.
207    Allowed values
208      1 - v1 error format
209      2 - v2 error format
210
211Returns:
212  An object of the form:
213
214    { # A domain serving an App Engine application.
215      "sslSettings": { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
216        "certificateId": "A String", # ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.
217      },
218      "id": "A String", # Relative name of the domain serving the application. Example: example.com.
219      "name": "A String", # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
220      "resourceRecords": [ # The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
221        { # A DNS resource record.
222          "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
223          "type": "A String", # Resource record type. Example: AAAA.
224          "name": "A String", # Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
225        },
226      ],
227    }</pre>
228</div>
229
230<div class="method">
231    <code class="details" id="list">list(appsId, pageSize=None, pageToken=None, x__xgafv=None)</code>
232  <pre>Lists the domain mappings on an application.
233
234Args:
235  appsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required)
236  pageSize: integer, Maximum results to return per page.
237  pageToken: string, Continuation token for fetching the next page of results.
238  x__xgafv: string, V1 error format.
239    Allowed values
240      1 - v1 error format
241      2 - v2 error format
242
243Returns:
244  An object of the form:
245
246    { # Response message for DomainMappings.ListDomainMappings.
247    "nextPageToken": "A String", # Continuation token for fetching the next page of results.
248    "domainMappings": [ # The domain mappings for the application.
249      { # A domain serving an App Engine application.
250          "sslSettings": { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
251            "certificateId": "A String", # ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.
252          },
253          "id": "A String", # Relative name of the domain serving the application. Example: example.com.
254          "name": "A String", # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
255          "resourceRecords": [ # The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
256            { # A DNS resource record.
257              "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
258              "type": "A String", # Resource record type. Example: AAAA.
259              "name": "A String", # Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
260            },
261          ],
262        },
263    ],
264  }</pre>
265</div>
266
267<div class="method">
268    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
269  <pre>Retrieves the next page of results.
270
271Args:
272  previous_request: The request for the previous page. (required)
273  previous_response: The response from the request for the previous page. (required)
274
275Returns:
276  A request object that you can call 'execute()' on to request the next
277  page. Returns None if there are no more items in the collection.
278    </pre>
279</div>
280
281<div class="method">
282    <code class="details" id="patch">patch(appsId, domainMappingsId, body, updateMask=None, x__xgafv=None)</code>
283  <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.
284
285Args:
286  appsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com. (required)
287  domainMappingsId: string, Part of `name`. See documentation of `appsId`. (required)
288  body: object, The request body. (required)
289    The object takes the form of:
290
291{ # A domain serving an App Engine application.
292    "sslSettings": { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
293      "certificateId": "A String", # ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.
294    },
295    "id": "A String", # Relative name of the domain serving the application. Example: example.com.
296    "name": "A String", # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
297    "resourceRecords": [ # The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
298      { # A DNS resource record.
299        "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
300        "type": "A String", # Resource record type. Example: AAAA.
301        "name": "A String", # Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
302      },
303    ],
304  }
305
306  updateMask: string, Standard field mask for the set of fields to be updated.
307  x__xgafv: string, V1 error format.
308    Allowed values
309      1 - v1 error format
310      2 - v2 error format
311
312Returns:
313  An object of the form:
314
315    { # This resource represents a long-running operation that is the result of a network API call.
316    "metadata": { # 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.
317      "a_key": "", # Properties of the object. Contains field @type with type URL.
318    },
319    "error": { # 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). The error model is designed to be: # The error result of the operation in case of failure or cancellation.
320        # Simple to use and understand for most users
321        # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:
322        # Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
323        # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
324        # Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
325        # Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
326        # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
327      "message": "A String", # 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.
328      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
329      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
330        {
331          "a_key": "", # Properties of the object. Contains field @type with type URL.
332        },
333      ],
334    },
335    "done": 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.
336    "response": { # 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.
337      "a_key": "", # Properties of the object. Contains field @type with type URL.
338    },
339    "name": "A String", # 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 have the format of operations/some/unique/name.
340  }</pre>
341</div>
342
343</body></html>