Class SqlUsersServiceClient (2.20.0)

Version 2.20.0

• 2.32.0-rc (latest)
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

Cloud SQL users service.

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

SqlUsersServiceClient(SqlUsersServiceClient const &)

Copy and move support

Parameter
Name	Description
	SqlUsersServiceClient const &

SqlUsersServiceClient(SqlUsersServiceClient &&)

Copy and move support

Parameter
Name	Description
	SqlUsersServiceClient &&

SqlUsersServiceClient(std::shared_ptr< SqlUsersServiceConnection >, Options)

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

Operators

operator=(SqlUsersServiceClient const &)

Copy and move support

Parameter
Name	Description
	SqlUsersServiceClient const &

Returns
Type	Description
SqlUsersServiceClient &

operator=(SqlUsersServiceClient &&)

Copy and move support

Parameter
Name	Description
	SqlUsersServiceClient &&

Returns
Type	Description
SqlUsersServiceClient &

Functions

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

Deletes a user from a Cloud SQL instance.

Parameters
Name	Description
request	google::cloud::sql::v1::SqlUsersDeleteRequest 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.SqlUsersDeleteRequest. 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::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::SqlUsersGetRequest const &, Options)

Retrieves a resource containing information about a user.

Parameters
Name	Description
request	google::cloud::sql::v1::SqlUsersGetRequest 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.SqlUsersGetRequest. 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::sql::v1::User >	the result of the RPC. The response message type (google.cloud.sql.v1.User) 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::SqlUsersInsertRequest const &, Options)

Creates a new user in a Cloud SQL instance.

Parameters
Name	Description
request	google::cloud::sql::v1::SqlUsersInsertRequest 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.SqlUsersInsertRequest. 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::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.

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

Lists users in the specified Cloud SQL instance.

Parameters
Name	Description
request	google::cloud::sql::v1::SqlUsersListRequest 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.SqlUsersListRequest. 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::sql::v1::UsersListResponse >	the result of the RPC. The response message type (google.cloud.sql.v1.UsersListResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Update(google::cloud::sql::v1::SqlUsersUpdateRequest const &, Options)

Updates an existing user in a Cloud SQL instance.

Parameters
Name	Description
request	google::cloud::sql::v1::SqlUsersUpdateRequest 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.SqlUsersUpdateRequest. 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::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.