Patch
|
|||||
|
|
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
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
Input
This building block consumes 13 input parameters
Name | Format | Description |
---|---|---|
appsId Required |
STRING |
Part of |
domainMappingsId Required |
STRING |
Part of |
updateMask |
ANY |
Standard field mask for the set of fields to be updated |
id |
STRING |
Relative name of the domain serving the application. Example: example.com |
resourceRecords[] |
OBJECT |
A DNS resource record |
resourceRecords[].name |
STRING |
Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www' |
resourceRecords[].type |
ENUMERATION |
Resource record type. Example: AAAA |
resourceRecords[].rrdata |
STRING |
Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) |
name |
STRING |
Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly |
sslSettings |
OBJECT |
SSL configuration for a DomainMapping resource |
sslSettings.certificateId |
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 |
sslSettings.sslManagementType |
ENUMERATION |
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 |
sslSettings.pendingManagedCertificateId |
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 |
= Parameter name
= Format
appsId STRING Required Part of |
domainMappingsId STRING Required Part of |
updateMask ANY Standard field mask for the set of fields to be updated |
id STRING Relative name of the domain serving the application. Example: example.com |
resourceRecords[] OBJECT A DNS resource record |
resourceRecords[].name STRING Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www' |
resourceRecords[].type ENUMERATION Resource record type. Example: AAAA |
resourceRecords[].rrdata STRING Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) |
name STRING Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly |
sslSettings OBJECT SSL configuration for a DomainMapping resource |
sslSettings.certificateId 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 |
sslSettings.sslManagementType ENUMERATION 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 |
sslSettings.pendingManagedCertificateId 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 |
Output
This building block provides 11 output parameters
Name | Format | Description |
---|---|---|
error |
OBJECT |
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) |
error.code |
INTEGER |
The status code, which should be an enum value of google.rpc.Code |
error.message |
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 |
error.details[] |
OBJECT |
|
error.details[].customKey.value |
ANY |
|
metadata |
OBJECT |
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 |
metadata.customKey.value |
ANY |
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 |
done |
BOOLEAN |
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 |
response |
OBJECT |
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 |
response.customKey.value |
ANY |
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 |
name |
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} |
= Parameter name
= Format
error OBJECT 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) |
error.code INTEGER The status code, which should be an enum value of google.rpc.Code |
error.message 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 |
error.details[] OBJECT |
error.details[].customKey.value ANY |
metadata OBJECT 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 |
metadata.customKey.value ANY 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 |
done BOOLEAN 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 |
response OBJECT 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 |
response.customKey.value ANY 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 |
name 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} |