Class SqlSslCertsServiceClient (2.20.0-rc)

Service to manage SSL certs for Cloud SQL instances.

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

SqlSslCertsServiceClient(SqlSslCertsServiceClient const &)

Copy and move support

Parameter
NameDescription
SqlSslCertsServiceClient const &

SqlSslCertsServiceClient(SqlSslCertsServiceClient &&)

Copy and move support

Parameter
NameDescription
SqlSslCertsServiceClient &&

SqlSslCertsServiceClient(std::shared_ptr< SqlSslCertsServiceConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< SqlSslCertsServiceConnection >
opts Options

Operators

operator=(SqlSslCertsServiceClient const &)

Copy and move support

Parameter
NameDescription
SqlSslCertsServiceClient const &
Returns
TypeDescription
SqlSslCertsServiceClient &

operator=(SqlSslCertsServiceClient &&)

Copy and move support

Parameter
NameDescription
SqlSslCertsServiceClient &&
Returns
TypeDescription
SqlSslCertsServiceClient &

Functions

Delete(google::cloud::sql::v1::SqlSslCertsDeleteRequest const &, Options)

Deletes the SSL certificate.

For First Generation instances, the certificate remains valid until the instance is restarted.

Parameters
NameDescription
request google::cloud::sql::v1::SqlSslCertsDeleteRequest 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.sql.v1.SqlSslCertsDeleteRequest. 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
TypeDescription
StatusOr< google::cloud::sql::v1::Operation >

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

Get(google::cloud::sql::v1::SqlSslCertsGetRequest const &, Options)

Retrieves a particular SSL certificate.

Does not include the private key (required for usage). The private key must be saved from the response to initial creation.

Parameters
NameDescription
request google::cloud::sql::v1::SqlSslCertsGetRequest 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.sql.v1.SqlSslCertsGetRequest. 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
TypeDescription
StatusOr< google::cloud::sql::v1::SslCert >

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

Insert(google::cloud::sql::v1::SqlSslCertsInsertRequest const &, Options)

Creates an SSL certificate and returns it along with the private key and server certificate authority.

The new certificate will not be usable until the instance is restarted.

Parameters
NameDescription
request google::cloud::sql::v1::SqlSslCertsInsertRequest 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.sql.v1.SqlSslCertsInsertRequest. 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
TypeDescription
StatusOr< google::cloud::sql::v1::SslCertsInsertResponse >

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

List(google::cloud::sql::v1::SqlSslCertsListRequest const &, Options)

Lists all of the current SSL certificates for the instance.

Parameters
NameDescription
request google::cloud::sql::v1::SqlSslCertsListRequest 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.sql.v1.SqlSslCertsListRequest. 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
TypeDescription
StatusOr< google::cloud::sql::v1::SslCertsListResponse >

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