Some or all of the information on this page might not apply to Trusted Cloud by S3NS.
Class ApiGatewayServiceConnection (2.29.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 2.29.0keyboard_arrow_down
Functions
virtual options()
Returns
Type Description
Options
virtual ListGateways(google::cloud::apigateway::v1::ListGatewaysRequest)
Parameter
Name Description
request
google::cloud::apigateway::v1::ListGatewaysRequest
Returns
Type Description
StreamRange< google::cloud::apigateway::v1::Gateway >
virtual GetGateway(google::cloud::apigateway::v1::GetGatewayRequest const &)
Parameter
Name Description
request
google::cloud::apigateway::v1::GetGatewayRequest const &
Returns
Type Description
StatusOr< google::cloud::apigateway::v1::Gateway >
virtual CreateGateway(google::cloud::apigateway::v1::CreateGatewayRequest const &)
Parameter
Name Description
request
google::cloud::apigateway::v1::CreateGatewayRequest const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::Gateway > >
virtual CreateGateway(NoAwaitTag, google::cloud::apigateway::v1::CreateGatewayRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::apigateway::v1::CreateGatewayRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual CreateGateway(google::longrunning::Operation const &)
Parameter
Name Description
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::Gateway > >
virtual UpdateGateway(google::cloud::apigateway::v1::UpdateGatewayRequest const &)
Parameter
Name Description
request
google::cloud::apigateway::v1::UpdateGatewayRequest const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::Gateway > >
virtual UpdateGateway(NoAwaitTag, google::cloud::apigateway::v1::UpdateGatewayRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::apigateway::v1::UpdateGatewayRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual UpdateGateway(google::longrunning::Operation const &)
Parameter
Name Description
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::Gateway > >
virtual DeleteGateway(google::cloud::apigateway::v1::DeleteGatewayRequest const &)
Parameter
Name Description
request
google::cloud::apigateway::v1::DeleteGatewayRequest const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::OperationMetadata > >
virtual DeleteGateway(NoAwaitTag, google::cloud::apigateway::v1::DeleteGatewayRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::apigateway::v1::DeleteGatewayRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual DeleteGateway(google::longrunning::Operation const &)
Parameter
Name Description
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::OperationMetadata > >
virtual ListApis(google::cloud::apigateway::v1::ListApisRequest)
Parameter
Name Description
request
google::cloud::apigateway::v1::ListApisRequest
Returns
Type Description
StreamRange< google::cloud::apigateway::v1::Api >
virtual GetApi(google::cloud::apigateway::v1::GetApiRequest const &)
Parameter
Name Description
request
google::cloud::apigateway::v1::GetApiRequest const &
Returns
Type Description
StatusOr< google::cloud::apigateway::v1::Api >
virtual CreateApi(google::cloud::apigateway::v1::CreateApiRequest const &)
Parameter
Name Description
request
google::cloud::apigateway::v1::CreateApiRequest const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::Api > >
virtual CreateApi(NoAwaitTag, google::cloud::apigateway::v1::CreateApiRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::apigateway::v1::CreateApiRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual CreateApi(google::longrunning::Operation const &)
Parameter
Name Description
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::Api > >
virtual UpdateApi(google::cloud::apigateway::v1::UpdateApiRequest const &)
Parameter
Name Description
request
google::cloud::apigateway::v1::UpdateApiRequest const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::Api > >
virtual UpdateApi(NoAwaitTag, google::cloud::apigateway::v1::UpdateApiRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::apigateway::v1::UpdateApiRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual UpdateApi(google::longrunning::Operation const &)
Parameter
Name Description
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::Api > >
virtual DeleteApi(google::cloud::apigateway::v1::DeleteApiRequest const &)
Parameter
Name Description
request
google::cloud::apigateway::v1::DeleteApiRequest const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::OperationMetadata > >
virtual DeleteApi(NoAwaitTag, google::cloud::apigateway::v1::DeleteApiRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::apigateway::v1::DeleteApiRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual DeleteApi(google::longrunning::Operation const &)
Parameter
Name Description
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::OperationMetadata > >
virtual ListApiConfigs(google::cloud::apigateway::v1::ListApiConfigsRequest)
Parameter
Name Description
request
google::cloud::apigateway::v1::ListApiConfigsRequest
Returns
Type Description
StreamRange< google::cloud::apigateway::v1::ApiConfig >
virtual GetApiConfig(google::cloud::apigateway::v1::GetApiConfigRequest const &)
Parameter
Name Description
request
google::cloud::apigateway::v1::GetApiConfigRequest const &
Returns
Type Description
StatusOr< google::cloud::apigateway::v1::ApiConfig >
virtual CreateApiConfig(google::cloud::apigateway::v1::CreateApiConfigRequest const &)
Parameter
Name Description
request
google::cloud::apigateway::v1::CreateApiConfigRequest const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::ApiConfig > >
virtual CreateApiConfig(NoAwaitTag, google::cloud::apigateway::v1::CreateApiConfigRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::apigateway::v1::CreateApiConfigRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual CreateApiConfig(google::longrunning::Operation const &)
Parameter
Name Description
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::ApiConfig > >
virtual UpdateApiConfig(google::cloud::apigateway::v1::UpdateApiConfigRequest const &)
Parameter
Name Description
request
google::cloud::apigateway::v1::UpdateApiConfigRequest const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::ApiConfig > >
virtual UpdateApiConfig(NoAwaitTag, google::cloud::apigateway::v1::UpdateApiConfigRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::apigateway::v1::UpdateApiConfigRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual UpdateApiConfig(google::longrunning::Operation const &)
Parameter
Name Description
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::ApiConfig > >
virtual DeleteApiConfig(google::cloud::apigateway::v1::DeleteApiConfigRequest const &)
Parameter
Name Description
request
google::cloud::apigateway::v1::DeleteApiConfigRequest const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::OperationMetadata > >
virtual DeleteApiConfig(NoAwaitTag, google::cloud::apigateway::v1::DeleteApiConfigRequest const &)
Parameters
Name Description
NoAwaitTag
request
google::cloud::apigateway::v1::DeleteApiConfigRequest const &
Returns
Type Description
StatusOr< google::longrunning::Operation >
virtual DeleteApiConfig(google::longrunning::Operation const &)
Parameter
Name Description
operation
google::longrunning::Operation const &
Returns
Type Description
future< StatusOr< google::cloud::apigateway::v1::OperationMetadata > >
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-09 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-09 UTC."],[[["This document outlines the `ApiGatewayServiceConnection` object, which provides an interface for the `ApiGatewayServiceClient` and allows for custom behaviors to be injected, particularly useful during testing."],["The latest version of the documentation is for 2.37.0-rc, with versions ranging down to 2.11.0 available."],["The interface defines numerous virtual methods, including functions for listing, getting, creating, updating, and deleting gateways, APIs, and API configurations."],["Users can create a concrete instance of the service connection using `MakeApiGatewayServiceConnection()`, and for testing, a mock version is available via `apigateway_v1_mocks::MockApiGatewayServiceConnection`."],["Many functions support asynchronous operations via `google::longrunning::Operation` and also an option to not await the operation through the `NoAwaitTag` parameter."]]],[]]
