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_v1.html">App Engine Admin API</a> . <a href="appengine_v1.apps.html">apps</a> . <a href="appengine_v1.apps.domainMappings.html">domainMappings</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(appsId, body=None, overrideStrategy=None, x__xgafv=None)</a></code></p> 82<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> 83<p class="toc_element"> 84 <code><a href="#delete">delete(appsId, domainMappingsId, x__xgafv=None)</a></code></p> 85<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> 86<p class="toc_element"> 87 <code><a href="#get">get(appsId, domainMappingsId, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets the specified domain mapping.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(appsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists the domain mappings on an application.</p> 92<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(appsId, domainMappingsId, body=None, updateMask=None, x__xgafv=None)</a></code></p> 97<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> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(appsId, body=None, overrideStrategy=None, x__xgafv=None)</code> 106 <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. 107 108Args: 109 appsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # A domain serving an App Engine application. 114 "id": "A String", # Relative name of the domain serving the application. Example: example.com. 115 "name": "A String", # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly 116 "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 117 { # A DNS resource record. 118 "name": "A String", # Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'. 119 "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). 120 "type": "A String", # Resource record type. Example: AAAA. 121 }, 122 ], 123 "sslSettings": { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. 124 "certificateId": "A String", # 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 SslManagementType.MANUAL 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. 125 "pendingManagedCertificateId": "A String", # ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly 126 "sslManagementType": "A String", # SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain. 127 }, 128} 129 130 overrideStrategy: string, Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected. 131 Allowed values 132 UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY - Strategy unspecified. Defaults to STRICT. 133 STRICT - Overrides not allowed. If a mapping already exists for the specified domain, the request will return an ALREADY_EXISTS (409). 134 OVERRIDE - Overrides allowed. If a mapping already exists for the specified domain, the request will overwrite it. Note that this might stop another Google product from serving. For example, if the domain is mapped to another App Engine application, that app will no longer serve from that domain. 135 x__xgafv: string, V1 error format. 136 Allowed values 137 1 - v1 error format 138 2 - v2 error format 139 140Returns: 141 An object of the form: 142 143 { # This resource represents a long-running operation that is the result of a network API call. 144 "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. 145 "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). 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. 146 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 147 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 148 { 149 "a_key": "", # Properties of the object. Contains field @type with type URL. 150 }, 151 ], 152 "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. 153 }, 154 "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. 155 "a_key": "", # Properties of the object. Contains field @type with type URL. 156 }, 157 "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 be a resource name ending with operations/{unique_id}. 158 "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. 159 "a_key": "", # Properties of the object. Contains field @type with type URL. 160 }, 161}</pre> 162</div> 163 164<div class="method"> 165 <code class="details" id="delete">delete(appsId, domainMappingsId, x__xgafv=None)</code> 166 <pre>Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource. 167 168Args: 169 appsId: string, Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com. (required) 170 domainMappingsId: string, Part of `name`. See documentation of `appsId`. (required) 171 x__xgafv: string, V1 error format. 172 Allowed values 173 1 - v1 error format 174 2 - v2 error format 175 176Returns: 177 An object of the form: 178 179 { # This resource represents a long-running operation that is the result of a network API call. 180 "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. 181 "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). 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. 182 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 183 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 184 { 185 "a_key": "", # Properties of the object. Contains field @type with type URL. 186 }, 187 ], 188 "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. 189 }, 190 "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. 191 "a_key": "", # Properties of the object. Contains field @type with type URL. 192 }, 193 "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 be a resource name ending with operations/{unique_id}. 194 "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. 195 "a_key": "", # Properties of the object. Contains field @type with type URL. 196 }, 197}</pre> 198</div> 199 200<div class="method"> 201 <code class="details" id="get">get(appsId, domainMappingsId, x__xgafv=None)</code> 202 <pre>Gets the specified domain mapping. 203 204Args: 205 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com. (required) 206 domainMappingsId: string, Part of `name`. See documentation of `appsId`. (required) 207 x__xgafv: string, V1 error format. 208 Allowed values 209 1 - v1 error format 210 2 - v2 error format 211 212Returns: 213 An object of the form: 214 215 { # A domain serving an App Engine application. 216 "id": "A String", # Relative name of the domain serving the application. Example: example.com. 217 "name": "A String", # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly 218 "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 219 { # A DNS resource record. 220 "name": "A String", # Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'. 221 "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). 222 "type": "A String", # Resource record type. Example: AAAA. 223 }, 224 ], 225 "sslSettings": { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. 226 "certificateId": "A String", # 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 SslManagementType.MANUAL 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. 227 "pendingManagedCertificateId": "A String", # ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly 228 "sslManagementType": "A String", # SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain. 229 }, 230}</pre> 231</div> 232 233<div class="method"> 234 <code class="details" id="list">list(appsId, pageSize=None, pageToken=None, x__xgafv=None)</code> 235 <pre>Lists the domain mappings on an application. 236 237Args: 238 appsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required) 239 pageSize: integer, Maximum results to return per page. 240 pageToken: string, Continuation token for fetching the next page of results. 241 x__xgafv: string, V1 error format. 242 Allowed values 243 1 - v1 error format 244 2 - v2 error format 245 246Returns: 247 An object of the form: 248 249 { # Response message for DomainMappings.ListDomainMappings. 250 "domainMappings": [ # The domain mappings for the application. 251 { # A domain serving an App Engine application. 252 "id": "A String", # Relative name of the domain serving the application. Example: example.com. 253 "name": "A String", # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly 254 "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 255 { # A DNS resource record. 256 "name": "A String", # Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'. 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 }, 260 ], 261 "sslSettings": { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. 262 "certificateId": "A String", # 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 SslManagementType.MANUAL 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. 263 "pendingManagedCertificateId": "A String", # ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly 264 "sslManagementType": "A String", # SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain. 265 }, 266 }, 267 ], 268 "nextPageToken": "A String", # Continuation token for fetching the next page of results. 269}</pre> 270</div> 271 272<div class="method"> 273 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 274 <pre>Retrieves the next page of results. 275 276Args: 277 previous_request: The request for the previous page. (required) 278 previous_response: The response from the request for the previous page. (required) 279 280Returns: 281 A request object that you can call 'execute()' on to request the next 282 page. Returns None if there are no more items in the collection. 283 </pre> 284</div> 285 286<div class="method"> 287 <code class="details" id="patch">patch(appsId, domainMappingsId, body=None, updateMask=None, x__xgafv=None)</code> 288 <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. 289 290Args: 291 appsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com. (required) 292 domainMappingsId: string, Part of `name`. See documentation of `appsId`. (required) 293 body: object, The request body. 294 The object takes the form of: 295 296{ # A domain serving an App Engine application. 297 "id": "A String", # Relative name of the domain serving the application. Example: example.com. 298 "name": "A String", # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly 299 "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 300 { # A DNS resource record. 301 "name": "A String", # Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'. 302 "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). 303 "type": "A String", # Resource record type. Example: AAAA. 304 }, 305 ], 306 "sslSettings": { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL. 307 "certificateId": "A String", # 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 SslManagementType.MANUAL 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. 308 "pendingManagedCertificateId": "A String", # ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly 309 "sslManagementType": "A String", # SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain. 310 }, 311} 312 313 updateMask: string, Required. Standard field mask for the set of fields to be updated. 314 x__xgafv: string, V1 error format. 315 Allowed values 316 1 - v1 error format 317 2 - v2 error format 318 319Returns: 320 An object of the form: 321 322 { # This resource represents a long-running operation that is the result of a network API call. 323 "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. 324 "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). 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. 325 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 326 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 327 { 328 "a_key": "", # Properties of the object. Contains field @type with type URL. 329 }, 330 ], 331 "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. 332 }, 333 "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. 334 "a_key": "", # Properties of the object. Contains field @type with type URL. 335 }, 336 "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 be a resource name ending with operations/{unique_id}. 337 "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. 338 "a_key": "", # Properties of the object. Contains field @type with type URL. 339 }, 340}</pre> 341</div> 342 343</body></html>