Class ApiGatewayServiceClient (2.21.0)

The API Gateway Service is the interface for managing API Gateways.

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

ApiGatewayServiceClient(ApiGatewayServiceClient const &)

Copy and move support

Parameter
Name	Description
	`ApiGatewayServiceClient const &`

ApiGatewayServiceClient(ApiGatewayServiceClient &&)

Copy and move support

Parameter
Name	Description
	`ApiGatewayServiceClient &&`

ApiGatewayServiceClient(std::shared_ptr< ApiGatewayServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< ApiGatewayServiceConnection >`
`opts`	`Options`

Operators

operator=(ApiGatewayServiceClient const &)

Copy and move support

Parameter
Name	Description
	`ApiGatewayServiceClient const &`

Returns
Type	Description
`ApiGatewayServiceClient &`

operator=(ApiGatewayServiceClient &&)

Copy and move support

Parameter
Name	Description
	`ApiGatewayServiceClient &&`

Returns
Type	Description
`ApiGatewayServiceClient &`

Functions

ListGateways(std::string const &, Options)

Lists Gateways in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource of the Gateway, of the form: `projects//locations/`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::apigateway::v1::Gateway >

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

ListGateways(google::cloud::apigateway::v1::ListGatewaysRequest, Options)

Lists Gateways in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::apigateway::v1::ListGatewaysRequest` 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.apigateway.v1.ListGatewaysRequest. 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::apigateway::v1::Gateway >

GetGateway(std::string const &, Options)

Gets details of a single Gateway.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the form: `projects//locations//gateways/*`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::apigateway::v1::Gateway >`	the result of the RPC. The response message type (google.cloud.apigateway.v1.Gateway) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetGateway(google::cloud::apigateway::v1::GetGatewayRequest const &, Options)

Gets details of a single Gateway.

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

CreateGateway(std::string const &, google::cloud::apigateway::v1::Gateway const &, std::string const &, Options)

Creates a new Gateway in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource of the Gateway, of the form: `projects//locations/`
`gateway`	`google::cloud::apigateway::v1::Gateway const &` Required. Gateway resource.
`gateway_id`	`std::string const &` Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::apigateway::v1::Gateway > >

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

CreateGateway(google::cloud::apigateway::v1::CreateGatewayRequest const &, Options)

Creates a new Gateway in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::apigateway::v1::CreateGatewayRequest 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.apigateway.v1.CreateGatewayRequest. 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::apigateway::v1::Gateway > >

UpdateGateway(google::cloud::apigateway::v1::Gateway const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Gateway.

Parameters
Name	Description
`gateway`	`google::cloud::apigateway::v1::Gateway const &` Required. Gateway resource.
`update_mask`	`google::protobuf::FieldMask const &` Field mask is used to specify the fields to be overwritten in the Gateway resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::apigateway::v1::Gateway > >

UpdateGateway(google::cloud::apigateway::v1::UpdateGatewayRequest const &, Options)

Updates the parameters of a single Gateway.

Parameters
Name	Description
`request`	`google::cloud::apigateway::v1::UpdateGatewayRequest 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.apigateway.v1.UpdateGatewayRequest. 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::apigateway::v1::Gateway > >

DeleteGateway(std::string const &, Options)

Deletes a single Gateway.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the form: `projects//locations//gateways/*`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

DeleteGateway(google::cloud::apigateway::v1::DeleteGatewayRequest const &, Options)

Deletes a single Gateway.

Parameters
Name	Description
`request`	`google::cloud::apigateway::v1::DeleteGatewayRequest 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.apigateway.v1.DeleteGatewayRequest. 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::apigateway::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.apigateway.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListApis(std::string const &, Options)

Lists Apis in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource of the API, of the form: `projects/*/locations/global`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::apigateway::v1::Api >

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

ListApis(google::cloud::apigateway::v1::ListApisRequest, Options)

Lists Apis in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::apigateway::v1::ListApisRequest` 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.apigateway.v1.ListApisRequest. 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::apigateway::v1::Api >

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

GetApi(std::string const &, Options)

Gets details of a single Api.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the form: `projects//locations/global/apis/`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::apigateway::v1::Api >`	the result of the RPC. The response message type (google.cloud.apigateway.v1.Api) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetApi(google::cloud::apigateway::v1::GetApiRequest const &, Options)

Gets details of a single Api.

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

CreateApi(std::string const &, google::cloud::apigateway::v1::Api const &, std::string const &, Options)

Creates a new Api in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource of the API, of the form: `projects/*/locations/global`
`api`	`google::cloud::apigateway::v1::Api const &` Required. API resource.
`api_id`	`std::string const &` Required. Identifier to assign to the API. Must be unique within scope of the parent resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::apigateway::v1::Api > >

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

CreateApi(google::cloud::apigateway::v1::CreateApiRequest const &, Options)

Creates a new Api in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::apigateway::v1::CreateApiRequest 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.apigateway.v1.CreateApiRequest. 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::apigateway::v1::Api > >

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

UpdateApi(google::cloud::apigateway::v1::Api const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Api.

Parameters
Name	Description
`api`	`google::cloud::apigateway::v1::Api const &` Required. API resource.
`update_mask`	`google::protobuf::FieldMask const &` Field mask is used to specify the fields to be overwritten in the Api resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::apigateway::v1::Api > >

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

UpdateApi(google::cloud::apigateway::v1::UpdateApiRequest const &, Options)

Updates the parameters of a single Api.

Parameters
Name	Description
`request`	`google::cloud::apigateway::v1::UpdateApiRequest 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.apigateway.v1.UpdateApiRequest. 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::apigateway::v1::Api > >

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

DeleteApi(std::string const &, Options)

Deletes a single Api.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the form: `projects//locations/global/apis/`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

DeleteApi(google::cloud::apigateway::v1::DeleteApiRequest const &, Options)

Deletes a single Api.

Parameters
Name	Description
`request`	`google::cloud::apigateway::v1::DeleteApiRequest 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.apigateway.v1.DeleteApiRequest. 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::apigateway::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.apigateway.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListApiConfigs(std::string const &, Options)

Lists ApiConfigs in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource of the API Config, of the form: `projects//locations/global/apis/`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::apigateway::v1::ApiConfig >

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

ListApiConfigs(google::cloud::apigateway::v1::ListApiConfigsRequest, Options)

Lists ApiConfigs in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::apigateway::v1::ListApiConfigsRequest` 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.apigateway.v1.ListApiConfigsRequest. 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::apigateway::v1::ApiConfig >

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

GetApiConfig(std::string const &, Options)

Gets details of a single ApiConfig.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the form: `projects//locations/global/apis//configs/*`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::apigateway::v1::ApiConfig >`	the result of the RPC. The response message type (google.cloud.apigateway.v1.ApiConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetApiConfig(google::cloud::apigateway::v1::GetApiConfigRequest const &, Options)

Gets details of a single ApiConfig.

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

CreateApiConfig(std::string const &, google::cloud::apigateway::v1::ApiConfig const &, std::string const &, Options)

Creates a new ApiConfig in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource of the API Config, of the form: `projects//locations/global/apis/`
`api_config`	`google::cloud::apigateway::v1::ApiConfig const &` Required. API resource.
`api_config_id`	`std::string const &` Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::apigateway::v1::ApiConfig > >

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

CreateApiConfig(google::cloud::apigateway::v1::CreateApiConfigRequest const &, Options)

Creates a new ApiConfig in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::apigateway::v1::CreateApiConfigRequest 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.apigateway.v1.CreateApiConfigRequest. 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::apigateway::v1::ApiConfig > >

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

UpdateApiConfig(google::cloud::apigateway::v1::ApiConfig const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single ApiConfig.

Parameters
Name	Description
`api_config`	`google::cloud::apigateway::v1::ApiConfig const &` Required. API Config resource.
`update_mask`	`google::protobuf::FieldMask const &` Field mask is used to specify the fields to be overwritten in the ApiConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::apigateway::v1::ApiConfig > >

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

UpdateApiConfig(google::cloud::apigateway::v1::UpdateApiConfigRequest const &, Options)

Updates the parameters of a single ApiConfig.

Parameters
Name	Description
`request`	`google::cloud::apigateway::v1::UpdateApiConfigRequest 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.apigateway.v1.UpdateApiConfigRequest. 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::apigateway::v1::ApiConfig > >

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

DeleteApiConfig(std::string const &, Options)

Deletes a single ApiConfig.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the form: `projects//locations/global/apis//configs/*`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

DeleteApiConfig(google::cloud::apigateway::v1::DeleteApiConfigRequest const &, Options)

Deletes a single ApiConfig.

Parameters
Name	Description
`request`	`google::cloud::apigateway::v1::DeleteApiConfigRequest 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.apigateway.v1.DeleteApiConfigRequest. 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::apigateway::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.apigateway.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.