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