Class CertificateManagerClient (2.33.0-rc)

API Overview.

Certificates Manager API allows customers to see and manage all their TLS certificates.

Certificates Manager API service provides methods to manage certificates, group them into collections, and create serving configuration that can be easily applied to other Cloud resources e.g. Target Proxies.

Data Model

The Certificates Manager service exposes the following resources:

  • Certificate that describes a single TLS certificate.
  • CertificateMap that describes a collection of certificates that can be attached to a target resource.
  • CertificateMapEntry that describes a single configuration entry that consists of a SNI and a group of certificates. It's a subresource of CertificateMap.

Certificate, CertificateMap and CertificateMapEntry IDs have to fully match the regexp [a-z0-9-]{1,63}. In other words,

  • only lower case letters, digits, and hyphen are allowed
  • length of the resource ID has to be in [1,63] range.

Provides methods to manage Cloud Certificate Manager entities.

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

CertificateManagerClient(CertificateManagerClient const &)

Copy and move support

Parameter
Name Description
CertificateManagerClient const &

CertificateManagerClient(CertificateManagerClient &&)

Copy and move support

Parameter
Name Description
CertificateManagerClient &&

CertificateManagerClient(std::shared_ptr< CertificateManagerConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< CertificateManagerConnection >
opts Options

Operators

operator=(CertificateManagerClient const &)

Copy and move support

Parameter
Name Description
CertificateManagerClient const &
Returns
Type Description
CertificateManagerClient &

operator=(CertificateManagerClient &&)

Copy and move support

Parameter
Name Description
CertificateManagerClient &&
Returns
Type Description
CertificateManagerClient &

Functions

ListCertificates(std::string const &, Options)

Lists Certificates in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location from which the certificate should be listed, specified in the format projects/*/locations/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::certificatemanager::v1::Certificate >

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.cloud.certificatemanager.v1.Certificate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListCertificates(google::cloud::certificatemanager::v1::ListCertificatesRequest, Options)

Lists Certificates in a given project and location.

Parameters
Name Description
request google::cloud::certificatemanager::v1::ListCertificatesRequest

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.cloud.certificatemanager.v1.ListCertificatesRequest. 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::cloud::certificatemanager::v1::Certificate >

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.cloud.certificatemanager.v1.Certificate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetCertificate(std::string const &, Options)

Gets details of a single Certificate.

Parameters
Name Description
name std::string const &

Required. A name of the certificate to describe. Must be in the format projects/*/locations/*/certificates/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::certificatemanager::v1::Certificate >

the result of the RPC. The response message type (google.cloud.certificatemanager.v1.Certificate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetCertificate(google::cloud::certificatemanager::v1::GetCertificateRequest const &, Options)

Gets details of a single Certificate.

Parameters
Name Description
request google::cloud::certificatemanager::v1::GetCertificateRequest 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.cloud.certificatemanager.v1.GetCertificateRequest. 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::cloud::certificatemanager::v1::Certificate >

the result of the RPC. The response message type (google.cloud.certificatemanager.v1.Certificate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateCertificate(std::string const &, google::cloud::certificatemanager::v1::Certificate const &, std::string const &, Options)

Creates a new Certificate in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the certificate. Must be in the format projects/*/locations/*.

certificate google::cloud::certificatemanager::v1::Certificate const &

Required. A definition of the certificate to create.

certificate_id std::string const &

Required. A user-provided name of the certificate.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::Certificate > >

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.cloud.certificatemanager.v1.Certificate proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCertificate(NoAwaitTag, std::string const &, google::cloud::certificatemanager::v1::Certificate const &, std::string const &, Options)

Creates a new Certificate in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
certificate google::cloud::certificatemanager::v1::Certificate const &
certificate_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateCertificate(google::cloud::certificatemanager::v1::CreateCertificateRequest const &, Options)

Creates a new Certificate in a given project and location.

Parameters
Name Description
request google::cloud::certificatemanager::v1::CreateCertificateRequest 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.cloud.certificatemanager.v1.CreateCertificateRequest. 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::cloud::certificatemanager::v1::Certificate > >

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.cloud.certificatemanager.v1.Certificate proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCertificate(NoAwaitTag, google::cloud::certificatemanager::v1::CreateCertificateRequest const &, Options)

Creates a new Certificate in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::certificatemanager::v1::CreateCertificateRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateCertificate(google::longrunning::Operation const &, Options)

Creates a new Certificate in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::Certificate > >

UpdateCertificate(google::cloud::certificatemanager::v1::Certificate const &, google::protobuf::FieldMask const &, Options)

Updates a Certificate.

Parameters
Name Description
certificate google::cloud::certificatemanager::v1::Certificate const &

Required. A definition of the certificate to update.

update_mask google::protobuf::FieldMask const &

Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::Certificate > >

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.cloud.certificatemanager.v1.Certificate proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateCertificate(NoAwaitTag, google::cloud::certificatemanager::v1::Certificate const &, google::protobuf::FieldMask const &, Options)

Updates a Certificate.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
certificate google::cloud::certificatemanager::v1::Certificate const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateCertificate(google::cloud::certificatemanager::v1::UpdateCertificateRequest const &, Options)

Updates a Certificate.

Parameters
Name Description
request google::cloud::certificatemanager::v1::UpdateCertificateRequest 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.cloud.certificatemanager.v1.UpdateCertificateRequest. 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::cloud::certificatemanager::v1::Certificate > >

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.cloud.certificatemanager.v1.Certificate proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateCertificate(NoAwaitTag, google::cloud::certificatemanager::v1::UpdateCertificateRequest const &, Options)

Updates a Certificate.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::certificatemanager::v1::UpdateCertificateRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateCertificate(google::longrunning::Operation const &, Options)

Updates a Certificate.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::Certificate > >

DeleteCertificate(std::string const &, Options)

Deletes a single Certificate.

Parameters
Name Description
name std::string const &

Required. A name of the certificate to delete. Must be in the format projects/*/locations/*/certificates/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::OperationMetadata > >

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.cloud.certificatemanager.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCertificate(NoAwaitTag, std::string const &, Options)

Deletes a single Certificate.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteCertificate(google::cloud::certificatemanager::v1::DeleteCertificateRequest const &, Options)

Deletes a single Certificate.

Parameters
Name Description
request google::cloud::certificatemanager::v1::DeleteCertificateRequest 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.cloud.certificatemanager.v1.DeleteCertificateRequest. 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::cloud::certificatemanager::v1::OperationMetadata > >

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.cloud.certificatemanager.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCertificate(NoAwaitTag, google::cloud::certificatemanager::v1::DeleteCertificateRequest const &, Options)

Deletes a single Certificate.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::certificatemanager::v1::DeleteCertificateRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteCertificate(google::longrunning::Operation const &, Options)

Deletes a single Certificate.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::OperationMetadata > >

ListCertificateMaps(std::string const &, Options)

Lists CertificateMaps in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location from which the certificate maps should be listed, specified in the format projects/*/locations/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::certificatemanager::v1::CertificateMap >

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.cloud.certificatemanager.v1.CertificateMap, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListCertificateMaps(google::cloud::certificatemanager::v1::ListCertificateMapsRequest, Options)

Lists CertificateMaps in a given project and location.

Parameters
Name Description
request google::cloud::certificatemanager::v1::ListCertificateMapsRequest

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.cloud.certificatemanager.v1.ListCertificateMapsRequest. 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::cloud::certificatemanager::v1::CertificateMap >

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.cloud.certificatemanager.v1.CertificateMap, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetCertificateMap(std::string const &, Options)

Gets details of a single CertificateMap.

Parameters
Name Description
name std::string const &

Required. A name of the certificate map to describe. Must be in the format projects/*/locations/*/certificateMaps/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::certificatemanager::v1::CertificateMap >

the result of the RPC. The response message type (google.cloud.certificatemanager.v1.CertificateMap) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetCertificateMap(google::cloud::certificatemanager::v1::GetCertificateMapRequest const &, Options)

Gets details of a single CertificateMap.

Parameters
Name Description
request google::cloud::certificatemanager::v1::GetCertificateMapRequest 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.cloud.certificatemanager.v1.GetCertificateMapRequest. 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::cloud::certificatemanager::v1::CertificateMap >

the result of the RPC. The response message type (google.cloud.certificatemanager.v1.CertificateMap) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateCertificateMap(std::string const &, google::cloud::certificatemanager::v1::CertificateMap const &, std::string const &, Options)

Creates a new CertificateMap in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the certificate map. Must be in the format projects/*/locations/*.

certificate_map google::cloud::certificatemanager::v1::CertificateMap const &

Required. A definition of the certificate map to create.

certificate_map_id std::string const &

Required. A user-provided name of the certificate map.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::CertificateMap > >

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.cloud.certificatemanager.v1.CertificateMap proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCertificateMap(NoAwaitTag, std::string const &, google::cloud::certificatemanager::v1::CertificateMap const &, std::string const &, Options)

Creates a new CertificateMap in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
certificate_map google::cloud::certificatemanager::v1::CertificateMap const &
certificate_map_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateCertificateMap(google::cloud::certificatemanager::v1::CreateCertificateMapRequest const &, Options)

Creates a new CertificateMap in a given project and location.

Parameters
Name Description
request google::cloud::certificatemanager::v1::CreateCertificateMapRequest 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.cloud.certificatemanager.v1.CreateCertificateMapRequest. 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::cloud::certificatemanager::v1::CertificateMap > >

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.cloud.certificatemanager.v1.CertificateMap proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCertificateMap(NoAwaitTag, google::cloud::certificatemanager::v1::CreateCertificateMapRequest const &, Options)

Creates a new CertificateMap in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::certificatemanager::v1::CreateCertificateMapRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateCertificateMap(google::longrunning::Operation const &, Options)

Creates a new CertificateMap in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::CertificateMap > >

UpdateCertificateMap(google::cloud::certificatemanager::v1::CertificateMap const &, google::protobuf::FieldMask const &, Options)

Updates a CertificateMap.

Parameters
Name Description
certificate_map google::cloud::certificatemanager::v1::CertificateMap const &

Required. A definition of the certificate map to update.

update_mask google::protobuf::FieldMask const &

Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::CertificateMap > >

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.cloud.certificatemanager.v1.CertificateMap proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateCertificateMap(NoAwaitTag, google::cloud::certificatemanager::v1::CertificateMap const &, google::protobuf::FieldMask const &, Options)

Updates a CertificateMap.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
certificate_map google::cloud::certificatemanager::v1::CertificateMap const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateCertificateMap(google::cloud::certificatemanager::v1::UpdateCertificateMapRequest const &, Options)

Updates a CertificateMap.

Parameters
Name Description
request google::cloud::certificatemanager::v1::UpdateCertificateMapRequest 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.cloud.certificatemanager.v1.UpdateCertificateMapRequest. 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::cloud::certificatemanager::v1::CertificateMap > >

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.cloud.certificatemanager.v1.CertificateMap proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateCertificateMap(NoAwaitTag, google::cloud::certificatemanager::v1::UpdateCertificateMapRequest const &, Options)

Updates a CertificateMap.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::certificatemanager::v1::UpdateCertificateMapRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateCertificateMap(google::longrunning::Operation const &, Options)

Updates a CertificateMap.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::CertificateMap > >

DeleteCertificateMap(std::string const &, Options)

Deletes a single CertificateMap.

A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method.

Parameters
Name Description
name std::string const &

Required. A name of the certificate map to delete. Must be in the format projects/*/locations/*/certificateMaps/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::OperationMetadata > >

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.cloud.certificatemanager.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCertificateMap(NoAwaitTag, std::string const &, Options)

Deletes a single CertificateMap.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteCertificateMap(google::cloud::certificatemanager::v1::DeleteCertificateMapRequest const &, Options)

Deletes a single CertificateMap.

A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method.

Parameters
Name Description
request google::cloud::certificatemanager::v1::DeleteCertificateMapRequest 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.cloud.certificatemanager.v1.DeleteCertificateMapRequest. 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::cloud::certificatemanager::v1::OperationMetadata > >

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.cloud.certificatemanager.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCertificateMap(NoAwaitTag, google::cloud::certificatemanager::v1::DeleteCertificateMapRequest const &, Options)

Deletes a single CertificateMap.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::certificatemanager::v1::DeleteCertificateMapRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteCertificateMap(google::longrunning::Operation const &, Options)

Deletes a single CertificateMap.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::OperationMetadata > >

ListCertificateMapEntries(std::string const &, Options)

Lists CertificateMapEntries in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project, location and certificate map from which the certificate map entries should be listed, specified in the format projects/*/locations/*/certificateMaps/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::certificatemanager::v1::CertificateMapEntry >

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.cloud.certificatemanager.v1.CertificateMapEntry, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListCertificateMapEntries(google::cloud::certificatemanager::v1::ListCertificateMapEntriesRequest, Options)

Lists CertificateMapEntries in a given project and location.

Parameters
Name Description
request google::cloud::certificatemanager::v1::ListCertificateMapEntriesRequest

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.cloud.certificatemanager.v1.ListCertificateMapEntriesRequest. 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::cloud::certificatemanager::v1::CertificateMapEntry >

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.cloud.certificatemanager.v1.CertificateMapEntry, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetCertificateMapEntry(std::string const &, Options)

Gets details of a single CertificateMapEntry.

Parameters
Name Description
name std::string const &

Required. A name of the certificate map entry to describe. Must be in the format projects/*/locations/*/certificateMaps/*/certificateMapEntries/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::certificatemanager::v1::CertificateMapEntry >

the result of the RPC. The response message type (google.cloud.certificatemanager.v1.CertificateMapEntry) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetCertificateMapEntry(google::cloud::certificatemanager::v1::GetCertificateMapEntryRequest const &, Options)

Gets details of a single CertificateMapEntry.

Parameters
Name Description
request google::cloud::certificatemanager::v1::GetCertificateMapEntryRequest 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.cloud.certificatemanager.v1.GetCertificateMapEntryRequest. 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::cloud::certificatemanager::v1::CertificateMapEntry >

the result of the RPC. The response message type (google.cloud.certificatemanager.v1.CertificateMapEntry) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateCertificateMapEntry(std::string const &, google::cloud::certificatemanager::v1::CertificateMapEntry const &, std::string const &, Options)

Creates a new CertificateMapEntry in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the certificate map entry. Must be in the format projects/*/locations/*/certificateMaps/*.

certificate_map_entry google::cloud::certificatemanager::v1::CertificateMapEntry const &

Required. A definition of the certificate map entry to create.

certificate_map_entry_id std::string const &

Required. A user-provided name of the certificate map entry.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::CertificateMapEntry > >

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.cloud.certificatemanager.v1.CertificateMapEntry proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCertificateMapEntry(NoAwaitTag, std::string const &, google::cloud::certificatemanager::v1::CertificateMapEntry const &, std::string const &, Options)

Creates a new CertificateMapEntry in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
certificate_map_entry google::cloud::certificatemanager::v1::CertificateMapEntry const &
certificate_map_entry_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateCertificateMapEntry(google::cloud::certificatemanager::v1::CreateCertificateMapEntryRequest const &, Options)

Creates a new CertificateMapEntry in a given project and location.

Parameters
Name Description
request google::cloud::certificatemanager::v1::CreateCertificateMapEntryRequest 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.cloud.certificatemanager.v1.CreateCertificateMapEntryRequest. 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::cloud::certificatemanager::v1::CertificateMapEntry > >

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.cloud.certificatemanager.v1.CertificateMapEntry proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCertificateMapEntry(NoAwaitTag, google::cloud::certificatemanager::v1::CreateCertificateMapEntryRequest const &, Options)

Creates a new CertificateMapEntry in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::certificatemanager::v1::CreateCertificateMapEntryRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateCertificateMapEntry(google::longrunning::Operation const &, Options)

Creates a new CertificateMapEntry in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::CertificateMapEntry > >

UpdateCertificateMapEntry(google::cloud::certificatemanager::v1::CertificateMapEntry const &, google::protobuf::FieldMask const &, Options)

Updates a CertificateMapEntry.

Parameters
Name Description
certificate_map_entry google::cloud::certificatemanager::v1::CertificateMapEntry const &

Required. A definition of the certificate map entry to create map entry.

update_mask google::protobuf::FieldMask const &

Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::CertificateMapEntry > >

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.cloud.certificatemanager.v1.CertificateMapEntry proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateCertificateMapEntry(NoAwaitTag, google::cloud::certificatemanager::v1::CertificateMapEntry const &, google::protobuf::FieldMask const &, Options)

Updates a CertificateMapEntry.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
certificate_map_entry google::cloud::certificatemanager::v1::CertificateMapEntry const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateCertificateMapEntry(google::cloud::certificatemanager::v1::UpdateCertificateMapEntryRequest const &, Options)

Updates a CertificateMapEntry.

Parameters
Name Description
request google::cloud::certificatemanager::v1::UpdateCertificateMapEntryRequest 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.cloud.certificatemanager.v1.UpdateCertificateMapEntryRequest. 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::cloud::certificatemanager::v1::CertificateMapEntry > >

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.cloud.certificatemanager.v1.CertificateMapEntry proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateCertificateMapEntry(NoAwaitTag, google::cloud::certificatemanager::v1::UpdateCertificateMapEntryRequest const &, Options)

Updates a CertificateMapEntry.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::certificatemanager::v1::UpdateCertificateMapEntryRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateCertificateMapEntry(google::longrunning::Operation const &, Options)

Updates a CertificateMapEntry.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::CertificateMapEntry > >

DeleteCertificateMapEntry(std::string const &, Options)

Deletes a single CertificateMapEntry.

Parameters
Name Description
name std::string const &

Required. A name of the certificate map entry to delete. Must be in the format projects/*/locations/*/certificateMaps/*/certificateMapEntries/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::OperationMetadata > >

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.cloud.certificatemanager.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCertificateMapEntry(NoAwaitTag, std::string const &, Options)

Deletes a single CertificateMapEntry.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteCertificateMapEntry(google::cloud::certificatemanager::v1::DeleteCertificateMapEntryRequest const &, Options)

Deletes a single CertificateMapEntry.

Parameters
Name Description
request google::cloud::certificatemanager::v1::DeleteCertificateMapEntryRequest 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.cloud.certificatemanager.v1.DeleteCertificateMapEntryRequest. 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::cloud::certificatemanager::v1::OperationMetadata > >

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.cloud.certificatemanager.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCertificateMapEntry(NoAwaitTag, google::cloud::certificatemanager::v1::DeleteCertificateMapEntryRequest const &, Options)

Deletes a single CertificateMapEntry.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::certificatemanager::v1::DeleteCertificateMapEntryRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteCertificateMapEntry(google::longrunning::Operation const &, Options)

Deletes a single CertificateMapEntry.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::OperationMetadata > >

ListDnsAuthorizations(std::string const &, Options)

Lists DnsAuthorizations in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location from which the dns authorizations should be listed, specified in the format projects/*/locations/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::certificatemanager::v1::DnsAuthorization >

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.cloud.certificatemanager.v1.DnsAuthorization, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDnsAuthorizations(google::cloud::certificatemanager::v1::ListDnsAuthorizationsRequest, Options)

Lists DnsAuthorizations in a given project and location.

Parameters
Name Description
request google::cloud::certificatemanager::v1::ListDnsAuthorizationsRequest

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.cloud.certificatemanager.v1.ListDnsAuthorizationsRequest. 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::cloud::certificatemanager::v1::DnsAuthorization >

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.cloud.certificatemanager.v1.DnsAuthorization, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetDnsAuthorization(std::string const &, Options)

Gets details of a single DnsAuthorization.

Parameters
Name Description
name std::string const &

Required. A name of the dns authorization to describe. Must be in the format projects/*/locations/*/dnsAuthorizations/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::certificatemanager::v1::DnsAuthorization >

the result of the RPC. The response message type (google.cloud.certificatemanager.v1.DnsAuthorization) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetDnsAuthorization(google::cloud::certificatemanager::v1::GetDnsAuthorizationRequest const &, Options)

Gets details of a single DnsAuthorization.

Parameters
Name Description
request google::cloud::certificatemanager::v1::GetDnsAuthorizationRequest 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.cloud.certificatemanager.v1.GetDnsAuthorizationRequest. 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::cloud::certificatemanager::v1::DnsAuthorization >

the result of the RPC. The response message type (google.cloud.certificatemanager.v1.DnsAuthorization) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateDnsAuthorization(std::string const &, google::cloud::certificatemanager::v1::DnsAuthorization const &, std::string const &, Options)

Creates a new DnsAuthorization in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the dns authorization. Must be in the format projects/*/locations/*.

dns_authorization google::cloud::certificatemanager::v1::DnsAuthorization const &

Required. A definition of the dns authorization to create.

dns_authorization_id std::string const &

Required. A user-provided name of the dns authorization.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::DnsAuthorization > >

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.cloud.certificatemanager.v1.DnsAuthorization proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateDnsAuthorization(NoAwaitTag, std::string const &, google::cloud::certificatemanager::v1::DnsAuthorization const &, std::string const &, Options)

Creates a new DnsAuthorization in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
dns_authorization google::cloud::certificatemanager::v1::DnsAuthorization const &
dns_authorization_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateDnsAuthorization(google::cloud::certificatemanager::v1::CreateDnsAuthorizationRequest const &, Options)

Creates a new DnsAuthorization in a given project and location.

Parameters
Name Description
request google::cloud::certificatemanager::v1::CreateDnsAuthorizationRequest 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.cloud.certificatemanager.v1.CreateDnsAuthorizationRequest. 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::cloud::certificatemanager::v1::DnsAuthorization > >

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.cloud.certificatemanager.v1.DnsAuthorization proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateDnsAuthorization(NoAwaitTag, google::cloud::certificatemanager::v1::CreateDnsAuthorizationRequest const &, Options)

Creates a new DnsAuthorization in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::certificatemanager::v1::CreateDnsAuthorizationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateDnsAuthorization(google::longrunning::Operation const &, Options)

Creates a new DnsAuthorization in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::DnsAuthorization > >

UpdateDnsAuthorization(google::cloud::certificatemanager::v1::DnsAuthorization const &, google::protobuf::FieldMask const &, Options)

Updates a DnsAuthorization.

Parameters
Name Description
dns_authorization google::cloud::certificatemanager::v1::DnsAuthorization const &

Required. A definition of the dns authorization to update.

update_mask google::protobuf::FieldMask const &

Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::DnsAuthorization > >

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.cloud.certificatemanager.v1.DnsAuthorization proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateDnsAuthorization(NoAwaitTag, google::cloud::certificatemanager::v1::DnsAuthorization const &, google::protobuf::FieldMask const &, Options)

Updates a DnsAuthorization.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
dns_authorization google::cloud::certificatemanager::v1::DnsAuthorization const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateDnsAuthorization(google::cloud::certificatemanager::v1::UpdateDnsAuthorizationRequest const &, Options)

Updates a DnsAuthorization.

Parameters
Name Description
request google::cloud::certificatemanager::v1::UpdateDnsAuthorizationRequest 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.cloud.certificatemanager.v1.UpdateDnsAuthorizationRequest. 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::cloud::certificatemanager::v1::DnsAuthorization > >

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.cloud.certificatemanager.v1.DnsAuthorization proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateDnsAuthorization(NoAwaitTag, google::cloud::certificatemanager::v1::UpdateDnsAuthorizationRequest const &, Options)

Updates a DnsAuthorization.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::certificatemanager::v1::UpdateDnsAuthorizationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateDnsAuthorization(google::longrunning::Operation const &, Options)

Updates a DnsAuthorization.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::DnsAuthorization > >

DeleteDnsAuthorization(std::string const &, Options)

Deletes a single DnsAuthorization.

Parameters
Name Description
name std::string const &

Required. A name of the dns authorization to delete. Must be in the format projects/*/locations/*/dnsAuthorizations/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::OperationMetadata > >

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.cloud.certificatemanager.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteDnsAuthorization(NoAwaitTag, std::string const &, Options)

Deletes a single DnsAuthorization.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteDnsAuthorization(google::cloud::certificatemanager::v1::DeleteDnsAuthorizationRequest const &, Options)

Deletes a single DnsAuthorization.

Parameters
Name Description
request google::cloud::certificatemanager::v1::DeleteDnsAuthorizationRequest 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.cloud.certificatemanager.v1.DeleteDnsAuthorizationRequest. 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::cloud::certificatemanager::v1::OperationMetadata > >

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.cloud.certificatemanager.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteDnsAuthorization(NoAwaitTag, google::cloud::certificatemanager::v1::DeleteDnsAuthorizationRequest const &, Options)

Deletes a single DnsAuthorization.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::certificatemanager::v1::DeleteDnsAuthorizationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteDnsAuthorization(google::longrunning::Operation const &, Options)

Deletes a single DnsAuthorization.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::OperationMetadata > >

ListCertificateIssuanceConfigs(std::string const &, Options)

Lists CertificateIssuanceConfigs in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location from which the certificate should be listed, specified in the format projects/*/locations/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::certificatemanager::v1::CertificateIssuanceConfig >

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.cloud.certificatemanager.v1.CertificateIssuanceConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListCertificateIssuanceConfigs(google::cloud::certificatemanager::v1::ListCertificateIssuanceConfigsRequest, Options)

Lists CertificateIssuanceConfigs in a given project and location.

Parameters
Name Description
request google::cloud::certificatemanager::v1::ListCertificateIssuanceConfigsRequest

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.cloud.certificatemanager.v1.ListCertificateIssuanceConfigsRequest. 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::cloud::certificatemanager::v1::CertificateIssuanceConfig >

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.cloud.certificatemanager.v1.CertificateIssuanceConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetCertificateIssuanceConfig(std::string const &, Options)

Gets details of a single CertificateIssuanceConfig.

Parameters
Name Description
name std::string const &

Required. A name of the certificate issuance config to describe. Must be in the format projects/*/locations/*/certificateIssuanceConfigs/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::certificatemanager::v1::CertificateIssuanceConfig >

the result of the RPC. The response message type (google.cloud.certificatemanager.v1.CertificateIssuanceConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetCertificateIssuanceConfig(google::cloud::certificatemanager::v1::GetCertificateIssuanceConfigRequest const &, Options)

Gets details of a single CertificateIssuanceConfig.

Parameters
Name Description
request google::cloud::certificatemanager::v1::GetCertificateIssuanceConfigRequest 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.cloud.certificatemanager.v1.GetCertificateIssuanceConfigRequest. 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::cloud::certificatemanager::v1::CertificateIssuanceConfig >

the result of the RPC. The response message type (google.cloud.certificatemanager.v1.CertificateIssuanceConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateCertificateIssuanceConfig(std::string const &, google::cloud::certificatemanager::v1::CertificateIssuanceConfig const &, std::string const &, Options)

Creates a new CertificateIssuanceConfig in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the certificate issuance config. Must be in the format projects/*/locations/*.

certificate_issuance_config google::cloud::certificatemanager::v1::CertificateIssuanceConfig const &

Required. A definition of the certificate issuance config to create.

certificate_issuance_config_id std::string const &

Required. A user-provided name of the certificate config.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::CertificateIssuanceConfig > >

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.cloud.certificatemanager.v1.CertificateIssuanceConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCertificateIssuanceConfig(NoAwaitTag, std::string const &, google::cloud::certificatemanager::v1::CertificateIssuanceConfig const &, std::string const &, Options)

Creates a new CertificateIssuanceConfig in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
certificate_issuance_config google::cloud::certificatemanager::v1::CertificateIssuanceConfig const &
certificate_issuance_config_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateCertificateIssuanceConfig(google::cloud::certificatemanager::v1::CreateCertificateIssuanceConfigRequest const &, Options)

Creates a new CertificateIssuanceConfig in a given project and location.

Parameters
Name Description
request google::cloud::certificatemanager::v1::CreateCertificateIssuanceConfigRequest 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.cloud.certificatemanager.v1.CreateCertificateIssuanceConfigRequest. 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::cloud::certificatemanager::v1::CertificateIssuanceConfig > >

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.cloud.certificatemanager.v1.CertificateIssuanceConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCertificateIssuanceConfig(NoAwaitTag, google::cloud::certificatemanager::v1::CreateCertificateIssuanceConfigRequest const &, Options)

Creates a new CertificateIssuanceConfig in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::certificatemanager::v1::CreateCertificateIssuanceConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateCertificateIssuanceConfig(google::longrunning::Operation const &, Options)

Creates a new CertificateIssuanceConfig in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::CertificateIssuanceConfig > >

DeleteCertificateIssuanceConfig(std::string const &, Options)

Deletes a single CertificateIssuanceConfig.

Parameters
Name Description
name std::string const &

Required. A name of the certificate issuance config to delete. Must be in the format projects/*/locations/*/certificateIssuanceConfigs/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::OperationMetadata > >

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.cloud.certificatemanager.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCertificateIssuanceConfig(NoAwaitTag, std::string const &, Options)

Deletes a single CertificateIssuanceConfig.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteCertificateIssuanceConfig(google::cloud::certificatemanager::v1::DeleteCertificateIssuanceConfigRequest const &, Options)

Deletes a single CertificateIssuanceConfig.

Parameters
Name Description
request google::cloud::certificatemanager::v1::DeleteCertificateIssuanceConfigRequest 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.cloud.certificatemanager.v1.DeleteCertificateIssuanceConfigRequest. 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::cloud::certificatemanager::v1::OperationMetadata > >

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.cloud.certificatemanager.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCertificateIssuanceConfig(NoAwaitTag, google::cloud::certificatemanager::v1::DeleteCertificateIssuanceConfigRequest const &, Options)

Deletes a single CertificateIssuanceConfig.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::certificatemanager::v1::DeleteCertificateIssuanceConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteCertificateIssuanceConfig(google::longrunning::Operation const &, Options)

Deletes a single CertificateIssuanceConfig.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::OperationMetadata > >

ListTrustConfigs(std::string const &, Options)

Lists TrustConfigs in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location from which the TrustConfigs should be listed, specified in the format projects/*/locations/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::certificatemanager::v1::TrustConfig >

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.cloud.certificatemanager.v1.TrustConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTrustConfigs(google::cloud::certificatemanager::v1::ListTrustConfigsRequest, Options)

Lists TrustConfigs in a given project and location.

Parameters
Name Description
request google::cloud::certificatemanager::v1::ListTrustConfigsRequest

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.cloud.certificatemanager.v1.ListTrustConfigsRequest. 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::cloud::certificatemanager::v1::TrustConfig >

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.cloud.certificatemanager.v1.TrustConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetTrustConfig(std::string const &, Options)

Gets details of a single TrustConfig.

Parameters
Name Description
name std::string const &

Required. A name of the TrustConfig to describe. Must be in the format projects/*/locations/*/trustConfigs/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::certificatemanager::v1::TrustConfig >

the result of the RPC. The response message type (google.cloud.certificatemanager.v1.TrustConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetTrustConfig(google::cloud::certificatemanager::v1::GetTrustConfigRequest const &, Options)

Gets details of a single TrustConfig.

Parameters
Name Description
request google::cloud::certificatemanager::v1::GetTrustConfigRequest 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.cloud.certificatemanager.v1.GetTrustConfigRequest. 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::cloud::certificatemanager::v1::TrustConfig >

the result of the RPC. The response message type (google.cloud.certificatemanager.v1.TrustConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateTrustConfig(std::string const &, google::cloud::certificatemanager::v1::TrustConfig const &, std::string const &, Options)

Creates a new TrustConfig in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent resource of the TrustConfig. Must be in the format projects/*/locations/*.

trust_config google::cloud::certificatemanager::v1::TrustConfig const &

Required. A definition of the TrustConfig to create.

trust_config_id std::string const &

Required. A user-provided name of the TrustConfig. Must match the regexp [a-z0-9-]{1,63}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::TrustConfig > >

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.cloud.certificatemanager.v1.TrustConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateTrustConfig(NoAwaitTag, std::string const &, google::cloud::certificatemanager::v1::TrustConfig const &, std::string const &, Options)

Creates a new TrustConfig in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
parent std::string const &
trust_config google::cloud::certificatemanager::v1::TrustConfig const &
trust_config_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateTrustConfig(google::cloud::certificatemanager::v1::CreateTrustConfigRequest const &, Options)

Creates a new TrustConfig in a given project and location.

Parameters
Name Description
request google::cloud::certificatemanager::v1::CreateTrustConfigRequest 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.cloud.certificatemanager.v1.CreateTrustConfigRequest. 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::cloud::certificatemanager::v1::TrustConfig > >

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.cloud.certificatemanager.v1.TrustConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateTrustConfig(NoAwaitTag, google::cloud::certificatemanager::v1::CreateTrustConfigRequest const &, Options)

Creates a new TrustConfig in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::certificatemanager::v1::CreateTrustConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateTrustConfig(google::longrunning::Operation const &, Options)

Creates a new TrustConfig in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::TrustConfig > >

UpdateTrustConfig(google::cloud::certificatemanager::v1::TrustConfig const &, google::protobuf::FieldMask const &, Options)

Updates a TrustConfig.

Parameters
Name Description
trust_config google::cloud::certificatemanager::v1::TrustConfig const &

Required. A definition of the TrustConfig to update.

update_mask google::protobuf::FieldMask const &

Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::TrustConfig > >

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.cloud.certificatemanager.v1.TrustConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateTrustConfig(NoAwaitTag, google::cloud::certificatemanager::v1::TrustConfig const &, google::protobuf::FieldMask const &, Options)

Updates a TrustConfig.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
trust_config google::cloud::certificatemanager::v1::TrustConfig const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateTrustConfig(google::cloud::certificatemanager::v1::UpdateTrustConfigRequest const &, Options)

Updates a TrustConfig.

Parameters
Name Description
request google::cloud::certificatemanager::v1::UpdateTrustConfigRequest 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.cloud.certificatemanager.v1.UpdateTrustConfigRequest. 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::cloud::certificatemanager::v1::TrustConfig > >

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.cloud.certificatemanager.v1.TrustConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateTrustConfig(NoAwaitTag, google::cloud::certificatemanager::v1::UpdateTrustConfigRequest const &, Options)

Updates a TrustConfig.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::certificatemanager::v1::UpdateTrustConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateTrustConfig(google::longrunning::Operation const &, Options)

Updates a TrustConfig.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::TrustConfig > >

DeleteTrustConfig(std::string const &, Options)

Deletes a single TrustConfig.

Parameters
Name Description
name std::string const &

Required. A name of the TrustConfig to delete. Must be in the format projects/*/locations/*/trustConfigs/*.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::OperationMetadata > >

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.cloud.certificatemanager.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteTrustConfig(NoAwaitTag, std::string const &, Options)

Deletes a single TrustConfig.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteTrustConfig(google::cloud::certificatemanager::v1::DeleteTrustConfigRequest const &, Options)

Deletes a single TrustConfig.

Parameters
Name Description
request google::cloud::certificatemanager::v1::DeleteTrustConfigRequest 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.cloud.certificatemanager.v1.DeleteTrustConfigRequest. 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::cloud::certificatemanager::v1::OperationMetadata > >

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.cloud.certificatemanager.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteTrustConfig(NoAwaitTag, google::cloud::certificatemanager::v1::DeleteTrustConfigRequest const &, Options)

Deletes a single TrustConfig.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::certificatemanager::v1::DeleteTrustConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteTrustConfig(google::longrunning::Operation const &, Options)

Deletes a single TrustConfig.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::certificatemanager::v1::OperationMetadata > >

ListLocations(google::cloud::location::ListLocationsRequest, Options)

Lists information about the supported locations for this service.

Parameters
Name Description
request google::cloud::location::ListLocationsRequest

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.cloud.location.ListLocationsRequest. 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::cloud::location::Location >

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.cloud.location.Location, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetLocation(google::cloud::location::GetLocationRequest const &, Options)

Gets information about a location.

Parameters
Name Description
request google::cloud::location::GetLocationRequest 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.cloud.location.GetLocationRequest. 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::cloud::location::Location >

the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListOperations(std::string const &, std::string const &, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name Description
name std::string const &

The name of the operation's parent resource.

filter std::string const &

The standard list filter.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::longrunning::Operation >

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.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListOperations(google::longrunning::ListOperationsRequest, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name Description
request google::longrunning::ListOperationsRequest

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.longrunning.ListOperationsRequest. 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::longrunning::Operation >

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.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
name std::string const &

The name of the operation resource.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::longrunning::Operation >

the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetOperation(google::longrunning::GetOperationRequest const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
request google::longrunning::GetOperationRequest 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.longrunning.GetOperationRequest. 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::longrunning::Operation >

the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteOperation(std::string const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
name std::string const &

The name of the operation resource to be deleted.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request google::longrunning::DeleteOperationRequest 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.longrunning.DeleteOperationRequest. 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
Status

a Status object. If the request failed, the status contains the details of the failure.

CancelOperation(std::string const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
name std::string const &

The name of the operation resource to be cancelled.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

CancelOperation(google::longrunning::CancelOperationRequest const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
request google::longrunning::CancelOperationRequest 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.longrunning.CancelOperationRequest. 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
Status

a Status object. If the request failed, the status contains the details of the failure.