Service describing handlers for resources.
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
LicenseManagerClient(LicenseManagerClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
LicenseManagerClient const &
|
LicenseManagerClient(LicenseManagerClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
LicenseManagerClient &&
|
LicenseManagerClient(std::shared_ptr< LicenseManagerConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< LicenseManagerConnection >
|
opts |
Options
|
Operators
operator=(LicenseManagerClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
LicenseManagerClient const &
|
Returns | |
---|---|
Type | Description |
LicenseManagerClient & |
operator=(LicenseManagerClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
LicenseManagerClient &&
|
Returns | |
---|---|
Type | Description |
LicenseManagerClient & |
Functions
ListConfigurations(std::string const &, Options)
Lists Configurations in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Parent value for ListConfigurationsRequest |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::licensemanager::v1::Configuration > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListConfigurations(google::cloud::licensemanager::v1::ListConfigurationsRequest, Options)
Lists Configurations in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::licensemanager::v1::ListConfigurationsRequest
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::cloud::licensemanager::v1::Configuration > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetConfiguration(std::string const &, Options)
Gets details of a single Configuration.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the resource |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::licensemanager::v1::Configuration > |
the result of the RPC. The response message type (google.cloud.licensemanager.v1.Configuration) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetConfiguration(google::cloud::licensemanager::v1::GetConfigurationRequest const &, Options)
Gets details of a single Configuration.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::licensemanager::v1::GetConfigurationRequest 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::cloud::licensemanager::v1::Configuration > |
the result of the RPC. The response message type (google.cloud.licensemanager.v1.Configuration) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateConfiguration(std::string const &, google::cloud::licensemanager::v1::Configuration const &, std::string const &, Options)
Creates a new Configuration in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Value for parent. |
configuration |
google::cloud::licensemanager::v1::Configuration const &
Required. The resource being created |
configuration_id |
std::string const &
Required. Id of the requesting object |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::licensemanager::v1::Configuration > > |
A |
CreateConfiguration(NoAwaitTag, std::string const &, google::cloud::licensemanager::v1::Configuration const &, std::string const &, Options)
Creates a new Configuration in a given project and location.
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
|
parent |
std::string const &
|
configuration |
google::cloud::licensemanager::v1::Configuration const &
|
configuration_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateConfiguration(google::cloud::licensemanager::v1::CreateConfigurationRequest const &, Options)
Creates a new Configuration in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::licensemanager::v1::CreateConfigurationRequest 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::cloud::licensemanager::v1::Configuration > > |
A |
CreateConfiguration(NoAwaitTag, google::cloud::licensemanager::v1::CreateConfigurationRequest const &, Options)
Creates a new Configuration in a given project and location.
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::cloud::licensemanager::v1::CreateConfigurationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateConfiguration(google::longrunning::Operation const &, Options)
Creates a new Configuration in a given project and location.
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::cloud::licensemanager::v1::Configuration > > |
UpdateConfiguration(google::cloud::licensemanager::v1::Configuration const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Configuration.
Parameters | |
---|---|
Name | Description |
configuration |
google::cloud::licensemanager::v1::Configuration const &
Required. The resource being updated |
update_mask |
google::protobuf::FieldMask const &
Optional. Field mask is used to specify the fields to be overwritten in the Configuration 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::licensemanager::v1::Configuration > > |
A |
UpdateConfiguration(NoAwaitTag, google::cloud::licensemanager::v1::Configuration const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Configuration.
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
|
configuration |
google::cloud::licensemanager::v1::Configuration const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateConfiguration(google::cloud::licensemanager::v1::UpdateConfigurationRequest const &, Options)
Updates the parameters of a single Configuration.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::licensemanager::v1::UpdateConfigurationRequest 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::cloud::licensemanager::v1::Configuration > > |
A |
UpdateConfiguration(NoAwaitTag, google::cloud::licensemanager::v1::UpdateConfigurationRequest const &, Options)
Updates the parameters of a single Configuration.
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::cloud::licensemanager::v1::UpdateConfigurationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateConfiguration(google::longrunning::Operation const &, Options)
Updates the parameters of a single Configuration.
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::cloud::licensemanager::v1::Configuration > > |
DeleteConfiguration(std::string const &, Options)
Deletes a single Configuration.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the resource |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::licensemanager::v1::OperationMetadata > > |
A |
DeleteConfiguration(NoAwaitTag, std::string const &, Options)
Deletes a single Configuration.
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
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteConfiguration(google::cloud::licensemanager::v1::DeleteConfigurationRequest const &, Options)
Deletes a single Configuration.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::licensemanager::v1::DeleteConfigurationRequest 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::cloud::licensemanager::v1::OperationMetadata > > |
A |
DeleteConfiguration(NoAwaitTag, google::cloud::licensemanager::v1::DeleteConfigurationRequest const &, Options)
Deletes a single Configuration.
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::cloud::licensemanager::v1::DeleteConfigurationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteConfiguration(google::longrunning::Operation const &, Options)
Deletes a single Configuration.
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::cloud::licensemanager::v1::OperationMetadata > > |
ListInstances(std::string const &, Options)
Lists Instances in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Parent value for ListInstancesRequest |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::licensemanager::v1::Instance > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListInstances(google::cloud::licensemanager::v1::ListInstancesRequest, Options)
Lists Instances in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::licensemanager::v1::ListInstancesRequest
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::cloud::licensemanager::v1::Instance > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetInstance(std::string const &, Options)
Gets details of a single Instance.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the resource |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::licensemanager::v1::Instance > |
the result of the RPC. The response message type (google.cloud.licensemanager.v1.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetInstance(google::cloud::licensemanager::v1::GetInstanceRequest const &, Options)
Gets details of a single Instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::licensemanager::v1::GetInstanceRequest 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::cloud::licensemanager::v1::Instance > |
the result of the RPC. The response message type (google.cloud.licensemanager.v1.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeactivateConfiguration(std::string const &, Options)
Deactivates the given configuration.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::licensemanager::v1::Configuration > > |
A |
DeactivateConfiguration(NoAwaitTag, std::string const &, Options)
Deactivates the given configuration.
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
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeactivateConfiguration(google::cloud::licensemanager::v1::DeactivateConfigurationRequest const &, Options)
Deactivates the given configuration.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::licensemanager::v1::DeactivateConfigurationRequest 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::cloud::licensemanager::v1::Configuration > > |
A |
DeactivateConfiguration(NoAwaitTag, google::cloud::licensemanager::v1::DeactivateConfigurationRequest const &, Options)
Deactivates the given configuration.
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::cloud::licensemanager::v1::DeactivateConfigurationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeactivateConfiguration(google::longrunning::Operation const &, Options)
Deactivates the given configuration.
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::cloud::licensemanager::v1::Configuration > > |
ReactivateConfiguration(std::string const &, Options)
Reactivates the given configuration.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::licensemanager::v1::Configuration > > |
A |
ReactivateConfiguration(NoAwaitTag, std::string const &, Options)
Reactivates the given configuration.
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
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ReactivateConfiguration(google::cloud::licensemanager::v1::ReactivateConfigurationRequest const &, Options)
Reactivates the given configuration.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::licensemanager::v1::ReactivateConfigurationRequest 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::cloud::licensemanager::v1::Configuration > > |
A |
ReactivateConfiguration(NoAwaitTag, google::cloud::licensemanager::v1::ReactivateConfigurationRequest const &, Options)
Reactivates the given configuration.
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::cloud::licensemanager::v1::ReactivateConfigurationRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ReactivateConfiguration(google::longrunning::Operation const &, Options)
Reactivates the given configuration.
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::cloud::licensemanager::v1::Configuration > > |
QueryConfigurationLicenseUsage(std::string const &, google::protobuf::Timestamp const &, google::protobuf::Timestamp const &, Options)
License Usage information for a Configuration.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource path of the Configuration. |
start_time |
google::protobuf::Timestamp const &
Required. The start time for retrieving the usage. If not specified, we will use the first day of the current billing period. |
end_time |
google::protobuf::Timestamp const &
Required. The end time for retrieving the usage. If not specified, we will use the last day of the current billing period. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::licensemanager::v1::QueryConfigurationLicenseUsageResponse > |
the result of the RPC. The response message type (google.cloud.licensemanager.v1.QueryConfigurationLicenseUsageResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
QueryConfigurationLicenseUsage(google::cloud::licensemanager::v1::QueryConfigurationLicenseUsageRequest const &, Options)
License Usage information for a Configuration.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::licensemanager::v1::QueryConfigurationLicenseUsageRequest 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::cloud::licensemanager::v1::QueryConfigurationLicenseUsageResponse > |
the result of the RPC. The response message type (google.cloud.licensemanager.v1.QueryConfigurationLicenseUsageResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
AggregateUsage(std::string const &, google::protobuf::Timestamp const &, google::protobuf::Timestamp const &, Options)
Aggregates Usage per Instance for a Configuration.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Parent value for AggregateUsageRequest |
start_time |
google::protobuf::Timestamp const &
Required. Licenses are purchased per month - so usage track needs start time of a month. |
end_time |
google::protobuf::Timestamp const &
Required. Usage track is always for a month. This parameter is for the end time of the month. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::licensemanager::v1::Usage > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
AggregateUsage(google::cloud::licensemanager::v1::AggregateUsageRequest, Options)
Aggregates Usage per Instance for a Configuration.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::licensemanager::v1::AggregateUsageRequest
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::cloud::licensemanager::v1::Usage > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListProducts(std::string const &, Options)
Lists Products in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Parent value for ListProductsRequest |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::licensemanager::v1::Product > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListProducts(google::cloud::licensemanager::v1::ListProductsRequest, Options)
Lists Products in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::licensemanager::v1::ListProductsRequest
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::cloud::licensemanager::v1::Product > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetProduct(std::string const &, Options)
Gets details of a single Product.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the resource |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::licensemanager::v1::Product > |
the result of the RPC. The response message type (google.cloud.licensemanager.v1.Product) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetProduct(google::cloud::licensemanager::v1::GetProductRequest const &, Options)
Gets details of a single Product.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::licensemanager::v1::GetProductRequest 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::cloud::licensemanager::v1::Product > |
the result of the RPC. The response message type (google.cloud.licensemanager.v1.Product) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListLocations(google::cloud::location::ListLocationsRequest, Options)
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::ListLocationsRequest
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::cloud::location::Location > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLocation(google::cloud::location::GetLocationRequest const &, Options)
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::location::GetLocationRequest 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::cloud::location::Location > |
the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
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 |
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 |
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 |
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 |
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 |
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 |
DeleteOperation(std::string const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be deleted. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::DeleteOperationRequest 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 |
Status |
a |
CancelOperation(std::string const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource to be cancelled. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CancelOperation(google::longrunning::CancelOperationRequest const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::CancelOperationRequest 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 |
Status |
a |