Class ApiKeysConnection (2.28.0)

Version 2.28.0

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 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

The ApiKeysConnection object for ApiKeysClient.

This interface defines virtual methods for each of the user-facing overload sets in ApiKeysClient. This allows users to inject custom behavior (e.g., with a Google Mock object) when writing tests that use objects of type ApiKeysClient.

To create a concrete instance, see MakeApiKeysConnection().

For mocking, see apikeys_v2_mocks::MockApiKeysConnection.

Functions

virtual options()

Returns
Type	Description
Options

virtual CreateKey(google::api::apikeys::v2::CreateKeyRequest const &)

Parameter
Name	Description
request	google::api::apikeys::v2::CreateKeyRequest const &

Returns
Type	Description
future< StatusOr< google::api::apikeys::v2::Key > >

virtual CreateKey(NoAwaitTag, google::api::apikeys::v2::CreateKeyRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::api::apikeys::v2::CreateKeyRequest const &

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

virtual CreateKey(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::api::apikeys::v2::Key > >

virtual ListKeys(google::api::apikeys::v2::ListKeysRequest)

Parameter
Name	Description
request	google::api::apikeys::v2::ListKeysRequest

Returns
Type	Description
StreamRange< google::api::apikeys::v2::Key >

virtual GetKey(google::api::apikeys::v2::GetKeyRequest const &)

Parameter
Name	Description
request	google::api::apikeys::v2::GetKeyRequest const &

Returns
Type	Description
StatusOr< google::api::apikeys::v2::Key >

virtual GetKeyString(google::api::apikeys::v2::GetKeyStringRequest const &)

Parameter
Name	Description
request	google::api::apikeys::v2::GetKeyStringRequest const &

Returns
Type	Description
StatusOr< google::api::apikeys::v2::GetKeyStringResponse >

virtual UpdateKey(google::api::apikeys::v2::UpdateKeyRequest const &)

Parameter
Name	Description
request	google::api::apikeys::v2::UpdateKeyRequest const &

Returns
Type	Description
future< StatusOr< google::api::apikeys::v2::Key > >

virtual UpdateKey(NoAwaitTag, google::api::apikeys::v2::UpdateKeyRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::api::apikeys::v2::UpdateKeyRequest const &

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

virtual UpdateKey(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::api::apikeys::v2::Key > >

virtual DeleteKey(google::api::apikeys::v2::DeleteKeyRequest const &)

Parameter
Name	Description
request	google::api::apikeys::v2::DeleteKeyRequest const &

Returns
Type	Description
future< StatusOr< google::api::apikeys::v2::Key > >

virtual DeleteKey(NoAwaitTag, google::api::apikeys::v2::DeleteKeyRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::api::apikeys::v2::DeleteKeyRequest const &

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

virtual DeleteKey(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::api::apikeys::v2::Key > >

virtual UndeleteKey(google::api::apikeys::v2::UndeleteKeyRequest const &)

Parameter
Name	Description
request	google::api::apikeys::v2::UndeleteKeyRequest const &

Returns
Type	Description
future< StatusOr< google::api::apikeys::v2::Key > >

virtual UndeleteKey(NoAwaitTag, google::api::apikeys::v2::UndeleteKeyRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::api::apikeys::v2::UndeleteKeyRequest const &

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

virtual UndeleteKey(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::api::apikeys::v2::Key > >

virtual LookupKey(google::api::apikeys::v2::LookupKeyRequest const &)

Parameter
Name	Description
request	google::api::apikeys::v2::LookupKeyRequest const &

Returns
Type	Description
StatusOr< google::api::apikeys::v2::LookupKeyResponse >