Class ServiceUsageClient (2.33.0)

Version 2.33.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

Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.

See Service Usage API

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

ServiceUsageClient(ServiceUsageClient const &)

Copy and move support

Parameter
Name	Description
	ServiceUsageClient const &

ServiceUsageClient(ServiceUsageClient &&)

Copy and move support

Parameter
Name	Description
	ServiceUsageClient &&

ServiceUsageClient(std::shared_ptr< ServiceUsageConnection >, Options)

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

Operators

operator=(ServiceUsageClient const &)

Copy and move support

Parameter
Name	Description
	ServiceUsageClient const &

Returns
Type	Description
ServiceUsageClient &

operator=(ServiceUsageClient &&)

Copy and move support

Parameter
Name	Description
	ServiceUsageClient &&

Returns
Type	Description
ServiceUsageClient &

Functions

EnableService(google::api::serviceusage::v1::EnableServiceRequest const &, Options)

Enable a service so that it can be used with a project.

Parameters
Name	Description
request	google::api::serviceusage::v1::EnableServiceRequest 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.api.serviceusage.v1.EnableServiceRequest. 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::api::serviceusage::v1::EnableServiceResponse > >	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.api.serviceusage.v1.EnableServiceResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

EnableService(NoAwaitTag, google::api::serviceusage::v1::EnableServiceRequest const &, Options)

Enable a service so that it can be used with a project.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::api::serviceusage::v1::EnableServiceRequest const &
opts	Options

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

EnableService(google::longrunning::Operation const &, Options)

Enable a service so that it can be used with a project.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::api::serviceusage::v1::EnableServiceResponse > >

DisableService(google::api::serviceusage::v1::DisableServiceRequest const &, Options)

Disable a service so that it can no longer be used with a project.

This prevents unintended usage that may cause unexpected billing charges or security leaks.

It is not valid to call the disable method on a service that is not currently enabled. Callers will receive a FAILED_PRECONDITION status if the target service is not currently enabled.

Parameters
Name	Description
request	google::api::serviceusage::v1::DisableServiceRequest 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.api.serviceusage.v1.DisableServiceRequest. 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::api::serviceusage::v1::DisableServiceResponse > >	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.api.serviceusage.v1.DisableServiceResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DisableService(NoAwaitTag, google::api::serviceusage::v1::DisableServiceRequest const &, Options)

Disable a service so that it can no longer be used with a project.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::api::serviceusage::v1::DisableServiceRequest const &
opts	Options

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

DisableService(google::longrunning::Operation const &, Options)

Disable a service so that it can no longer be used with a project.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::api::serviceusage::v1::DisableServiceResponse > >

GetService(google::api::serviceusage::v1::GetServiceRequest const &, Options)

Returns the service configuration and enabled state for a given service.

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

ListServices(google::api::serviceusage::v1::ListServicesRequest, Options)

List all services available to the specified project, and the current state of those services with respect to the project.

The list includes all public services, all services for which the calling user has the servicemanagement.services.bind permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project.

WARNING: If you need to query enabled services frequently or across an organization, you should use Cloud Asset Inventory API, which provides higher throughput and richer filtering capability.

Parameters
Name	Description
request	google::api::serviceusage::v1::ListServicesRequest 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.api.serviceusage.v1.ListServicesRequest. 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::api::serviceusage::v1::Service >	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.api.serviceusage.v1.Service, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

BatchEnableServices(google::api::serviceusage::v1::BatchEnableServicesRequest const &, Options)

Enable multiple services on a project.

The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. To enable a single service, use the EnableService method instead.

Parameters
Name	Description
request	google::api::serviceusage::v1::BatchEnableServicesRequest 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.api.serviceusage.v1.BatchEnableServicesRequest. 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::api::serviceusage::v1::BatchEnableServicesResponse > >	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.api.serviceusage.v1.BatchEnableServicesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchEnableServices(NoAwaitTag, google::api::serviceusage::v1::BatchEnableServicesRequest const &, Options)

Enable multiple services on a project.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::api::serviceusage::v1::BatchEnableServicesRequest const &
opts	Options

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

BatchEnableServices(google::longrunning::Operation const &, Options)

Enable multiple services on a project.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::api::serviceusage::v1::BatchEnableServicesResponse > >

BatchGetServices(google::api::serviceusage::v1::BatchGetServicesRequest const &, Options)

Returns the service configurations and enabled states for a given list of services.

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

ListOperations(std::string const &, std::string const &, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name	Description
name	std::string const & The name of the operation's parent resource.
filter	std::string const & The standard list filter.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::longrunning::Operation >	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.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListOperations(google::longrunning::ListOperationsRequest, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name	Description
request	google::longrunning::ListOperationsRequest 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.longrunning.ListOperationsRequest. 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::longrunning::Operation >	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.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
name	std::string const & The name of the operation resource.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetOperation(google::longrunning::GetOperationRequest const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

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