Class DomainMappingsClient (2.21.0)

Manages domains serving an application.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

DomainMappingsClient(DomainMappingsClient const &)

Copy and move support

Parameter
Name	Description
	`DomainMappingsClient const &`

DomainMappingsClient(DomainMappingsClient &&)

Copy and move support

Parameter
Name	Description
	`DomainMappingsClient &&`

DomainMappingsClient(std::shared_ptr< DomainMappingsConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< DomainMappingsConnection >`
`opts`	`Options`

Operators

operator=(DomainMappingsClient const &)

Copy and move support

Parameter
Name	Description
	`DomainMappingsClient const &`

Returns
Type	Description
`DomainMappingsClient &`

operator=(DomainMappingsClient &&)

Copy and move support

Parameter
Name	Description
	`DomainMappingsClient &&`

Returns
Type	Description
`DomainMappingsClient &`

Functions

ListDomainMappings(google::appengine::v1::ListDomainMappingsRequest, Options)

Lists the domain mappings on an application.

Parameters
Name	Description
`request`	`google::appengine::v1::ListDomainMappingsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.appengine.v1.ListDomainMappingsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::appengine::v1::DomainMapping >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.appengine.v1.DomainMapping, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetDomainMapping(google::appengine::v1::GetDomainMappingRequest const &, Options)

Gets the specified domain mapping.

Parameters
Name	Description
`request`	`google::appengine::v1::GetDomainMappingRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.appengine.v1.GetDomainMappingRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::appengine::v1::DomainMapping >`	the result of the RPC. The response message type (google.appengine.v1.DomainMapping) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateDomainMapping(google::appengine::v1::CreateDomainMappingRequest const &, Options)

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.

Parameters
Name	Description
`request`	`google::appengine::v1::CreateDomainMappingRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.appengine.v1.CreateDomainMappingRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::appengine::v1::DomainMapping > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.appengine.v1.DomainMapping proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateDomainMapping(google::appengine::v1::UpdateDomainMappingRequest const &, Options)

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.

Parameters
Name	Description
`request`	`google::appengine::v1::UpdateDomainMappingRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.appengine.v1.UpdateDomainMappingRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::appengine::v1::DomainMapping > >

DeleteDomainMapping(google::appengine::v1::DeleteDomainMappingRequest const &, Options)

Deletes the specified domain mapping.

A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.

Parameters
Name	Description
`request`	`google::appengine::v1::DeleteDomainMappingRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.appengine.v1.DeleteDomainMappingRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::appengine::v1::OperationMetadataV1 > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.appengine.v1.OperationMetadataV1 proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.