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
ServiceManagerClient(ServiceManagerClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ServiceManagerClient const &
|
ServiceManagerClient(ServiceManagerClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ServiceManagerClient &&
|
ServiceManagerClient(std::shared_ptr< ServiceManagerConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< ServiceManagerConnection >
|
opts |
Options
|
Operators
operator=(ServiceManagerClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ServiceManagerClient const &
|
Returns | |
---|---|
Type | Description |
ServiceManagerClient & |
operator=(ServiceManagerClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ServiceManagerClient &&
|
Returns | |
---|---|
Type | Description |
ServiceManagerClient & |
Functions
ListServices(google::api::servicemanagement::v1::ListServicesRequest, Options)
Lists managed services.
Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for.
Parameters | |
---|---|
Name | Description |
request |
google::api::servicemanagement::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::servicemanagement::v1::ManagedService > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetService(std::string const &, Options)
Gets a managed service.
Authentication is required unless the service is public.
Parameters | |
---|---|
Name | Description |
service_name |
std::string const &
Required. The name of the service. See the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::api::servicemanagement::v1::ManagedService > | the result of the RPC. The response message type (google.api.servicemanagement.v1.ManagedService) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetService(google::api::servicemanagement::v1::GetServiceRequest const &, Options)
Gets a managed service.
Authentication is required unless the service is public.
Parameters | |
---|---|
Name | Description |
request |
google::api::servicemanagement::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::servicemanagement::v1::ManagedService > | the result of the RPC. The response message type (google.api.servicemanagement.v1.ManagedService) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateService(google::api::servicemanagement::v1::ManagedService const &, Options)
Creates a new managed service.
A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after deletion.
One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project.
Operation<response: ManagedService>
Parameters | |
---|---|
Name | Description |
service |
google::api::servicemanagement::v1::ManagedService const &
Required. Initial values for the service resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::api::servicemanagement::v1::ManagedService > > | A |
CreateService(google::api::servicemanagement::v1::CreateServiceRequest const &, Options)
Creates a new managed service.
A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after deletion.
One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project.
Operation<response: ManagedService>
Parameters | |
---|---|
Name | Description |
request |
google::api::servicemanagement::v1::CreateServiceRequest 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::servicemanagement::v1::ManagedService > > | A |
DeleteService(std::string const &, Options)
Deletes a managed service.
This method will change the service to the Soft-Delete
state for 30 days. Within this period, service producers may call UndeleteService to restore the service. After 30 days, the service will be permanently deleted.
Operation<response: google.protobuf.Empty>
Parameters | |
---|---|
Name | Description |
service_name |
std::string const &
Required. The name of the service. See the overview for naming requirements. For example: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::api::servicemanagement::v1::OperationMetadata > > | A |
DeleteService(google::api::servicemanagement::v1::DeleteServiceRequest const &, Options)
Deletes a managed service.
This method will change the service to the Soft-Delete
state for 30 days. Within this period, service producers may call UndeleteService to restore the service. After 30 days, the service will be permanently deleted.
Operation<response: google.protobuf.Empty>
Parameters | |
---|---|
Name | Description |
request |
google::api::servicemanagement::v1::DeleteServiceRequest 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::servicemanagement::v1::OperationMetadata > > | A |
UndeleteService(std::string const &, Options)
Revives a previously deleted managed service.
The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days.
Operation<response: UndeleteServiceResponse>
Parameters | |
---|---|
Name | Description |
service_name |
std::string const &
Required. The name of the service. See the overview for naming requirements. For example: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::api::servicemanagement::v1::UndeleteServiceResponse > > | A |
UndeleteService(google::api::servicemanagement::v1::UndeleteServiceRequest const &, Options)
Revives a previously deleted managed service.
The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days.
Operation<response: UndeleteServiceResponse>
Parameters | |
---|---|
Name | Description |
request |
google::api::servicemanagement::v1::UndeleteServiceRequest 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::servicemanagement::v1::UndeleteServiceResponse > > | A |
ListServiceConfigs(std::string const &, Options)
Lists the history of the service configuration for a managed service, from the newest to the oldest.
Parameters | |
---|---|
Name | Description |
service_name |
std::string const &
Required. The name of the service. See the overview for naming requirements. For example: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::api::Service > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListServiceConfigs(google::api::servicemanagement::v1::ListServiceConfigsRequest, Options)
Lists the history of the service configuration for a managed service, from the newest to the oldest.
Parameters | |
---|---|
Name | Description |
request |
google::api::servicemanagement::v1::ListServiceConfigsRequest
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::Service > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetServiceConfig(std::string const &, std::string const &, google::api::servicemanagement::v1::GetServiceConfigRequest::ConfigView, Options)
Gets a service configuration (version) for a managed service.
Parameters | |
---|---|
Name | Description |
service_name |
std::string const &
Required. The name of the service. See the overview for naming requirements. For example: |
config_id |
std::string const &
Required. The id of the service configuration resource. |
view |
google::api::servicemanagement::v1::GetServiceConfigRequest::ConfigView
Specifies which parts of the Service Config should be returned in the response. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::api::Service > | the result of the RPC. The response message type (google.api.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetServiceConfig(google::api::servicemanagement::v1::GetServiceConfigRequest const &, Options)
Gets a service configuration (version) for a managed service.
Parameters | |
---|---|
Name | Description |
request |
google::api::servicemanagement::v1::GetServiceConfigRequest 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::Service > | the result of the RPC. The response message type (google.api.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateServiceConfig(std::string const &, google::api::Service const &, Options)
Creates a new service configuration (version) for a managed service.
This method only stores the service configuration. To roll out the service configuration to backend systems please call CreateServiceRollout.
Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually.
Parameters | |
---|---|
Name | Description |
service_name |
std::string const &
Required. The name of the service. See the overview for naming requirements. For example: |
service_config |
google::api::Service const &
Required. The service configuration resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::api::Service > | the result of the RPC. The response message type (google.api.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateServiceConfig(google::api::servicemanagement::v1::CreateServiceConfigRequest const &, Options)
Creates a new service configuration (version) for a managed service.
This method only stores the service configuration. To roll out the service configuration to backend systems please call CreateServiceRollout.
Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually.
Parameters | |
---|---|
Name | Description |
request |
google::api::servicemanagement::v1::CreateServiceConfigRequest 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::Service > | the result of the RPC. The response message type (google.api.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SubmitConfigSource(std::string const &, google::api::servicemanagement::v1::ConfigSource const &, bool, Options)
Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification).
This method stores the source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call CreateServiceRollout.
Only the 100 most recent configuration sources and ones referenced by existing service configurtions are kept for each service. The rest will be deleted eventually.
Operation<response: SubmitConfigSourceResponse>
Parameters | |
---|---|
Name | Description |
service_name |
std::string const &
Required. The name of the service. See the overview for naming requirements. For example: |
config_source |
google::api::servicemanagement::v1::ConfigSource const &
Required. The source configuration for the service. |
validate_only |
bool
Optional. If set, this will result in the generation of a |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::api::servicemanagement::v1::SubmitConfigSourceResponse > > | A |
SubmitConfigSource(google::api::servicemanagement::v1::SubmitConfigSourceRequest const &, Options)
Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification).
This method stores the source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call CreateServiceRollout.
Only the 100 most recent configuration sources and ones referenced by existing service configurtions are kept for each service. The rest will be deleted eventually.
Operation<response: SubmitConfigSourceResponse>
Parameters | |
---|---|
Name | Description |
request |
google::api::servicemanagement::v1::SubmitConfigSourceRequest 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::servicemanagement::v1::SubmitConfigSourceResponse > > | A |
ListServiceRollouts(std::string const &, std::string const &, Options)
Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.
Parameters | |
---|---|
Name | Description |
service_name |
std::string const &
Required. The name of the service. See the overview for naming requirements. For example: |
filter |
std::string const &
Required. Use |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::api::servicemanagement::v1::Rollout > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListServiceRollouts(google::api::servicemanagement::v1::ListServiceRolloutsRequest, Options)
Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.
Parameters | |
---|---|
Name | Description |
request |
google::api::servicemanagement::v1::ListServiceRolloutsRequest
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::servicemanagement::v1::Rollout > | a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetServiceRollout(std::string const &, std::string const &, Options)
Gets a service configuration rollout.
Parameters | |
---|---|
Name | Description |
service_name |
std::string const &
Required. The name of the service. See the overview for naming requirements. For example: |
rollout_id |
std::string const &
Required. The id of the rollout resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::api::servicemanagement::v1::Rollout > | the result of the RPC. The response message type (google.api.servicemanagement.v1.Rollout) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetServiceRollout(google::api::servicemanagement::v1::GetServiceRolloutRequest const &, Options)
Gets a service configuration rollout.
Parameters | |
---|---|
Name | Description |
request |
google::api::servicemanagement::v1::GetServiceRolloutRequest 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::servicemanagement::v1::Rollout > | the result of the RPC. The response message type (google.api.servicemanagement.v1.Rollout) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateServiceRollout(std::string const &, google::api::servicemanagement::v1::Rollout const &, Options)
Creates a new service configuration rollout.
Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging.
Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts.
Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually.
Operation<response: Rollout>
Parameters | |
---|---|
Name | Description |
service_name |
std::string const &
Required. The name of the service. See the overview for naming requirements. For example: |
rollout |
google::api::servicemanagement::v1::Rollout const &
Required. The rollout resource. The |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::api::servicemanagement::v1::Rollout > > | A |
CreateServiceRollout(google::api::servicemanagement::v1::CreateServiceRolloutRequest const &, Options)
Creates a new service configuration rollout.
Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging.
Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts.
Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually.
Operation<response: Rollout>
Parameters | |
---|---|
Name | Description |
request |
google::api::servicemanagement::v1::CreateServiceRolloutRequest 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::servicemanagement::v1::Rollout > > | A |
GenerateConfigReport(google::protobuf::Any const &, google::protobuf::Any const &, Options)
Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_value.
If GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare GenerateConfigReportRequest.new_value with the last pushed service configuration.
Parameters | |
---|---|
Name | Description |
new_config |
google::protobuf::Any const &
Required. Service configuration for which we want to generate the report. For this version of API, the supported types are [google.api.servicemanagement.v1.ConfigRef][google.api.servicemanagement.v1.ConfigRef], [google.api.servicemanagement.v1.ConfigSource][google.api.servicemanagement.v1.ConfigSource], and [google.api.Service][google.api.Service] |
old_config |
google::protobuf::Any const &
Optional. Service configuration against which the comparison will be done. For this version of API, the supported types are [google.api.servicemanagement.v1.ConfigRef][google.api.servicemanagement.v1.ConfigRef], [google.api.servicemanagement.v1.ConfigSource][google.api.servicemanagement.v1.ConfigSource], and [google.api.Service][google.api.Service] |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::api::servicemanagement::v1::GenerateConfigReportResponse > | the result of the RPC. The response message type (google.api.servicemanagement.v1.GenerateConfigReportResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GenerateConfigReport(google::api::servicemanagement::v1::GenerateConfigReportRequest const &, Options)
Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_value.
If GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare GenerateConfigReportRequest.new_value with the last pushed service configuration.
Parameters | |
---|---|
Name | Description |
request |
google::api::servicemanagement::v1::GenerateConfigReportRequest 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::servicemanagement::v1::GenerateConfigReportResponse > | the result of the RPC. The response message type (google.api.servicemanagement.v1.GenerateConfigReportResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |