Service describing handlers for config 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
ConfigClient(ConfigClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ConfigClient const &
|
ConfigClient(ConfigClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ConfigClient &&
|
ConfigClient(std::shared_ptr< ConfigConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< ConfigConnection >
|
opts |
Options
|
Operators
operator=(ConfigClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ConfigClient const &
|
Returns | |
---|---|
Type | Description |
ConfigClient & |
operator=(ConfigClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ConfigClient &&
|
Returns | |
---|---|
Type | Description |
ConfigClient & |
Functions
ListFrameworks(std::string const &, Options)
Lists Frameworks in a given organization.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent resource name, in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::cloudsecuritycompliance::v1::Framework > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListFrameworks(google::cloud::cloudsecuritycompliance::v1::ListFrameworksRequest, Options)
Lists Frameworks in a given organization.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cloudsecuritycompliance::v1::ListFrameworksRequest
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::cloudsecuritycompliance::v1::Framework > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetFramework(std::string const &, Options)
Gets details of a single Framework.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the framework to retrieve. Format: organizations/{organization}/locations/{location}/frameworks/{framework_id} |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cloudsecuritycompliance::v1::Framework > |
the result of the RPC. The response message type (google.cloud.cloudsecuritycompliance.v1.Framework) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetFramework(google::cloud::cloudsecuritycompliance::v1::GetFrameworkRequest const &, Options)
Gets details of a single Framework.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cloudsecuritycompliance::v1::GetFrameworkRequest 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::cloudsecuritycompliance::v1::Framework > |
the result of the RPC. The response message type (google.cloud.cloudsecuritycompliance.v1.Framework) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateFramework(std::string const &, google::cloud::cloudsecuritycompliance::v1::Framework const &, std::string const &, Options)
Creates a single framework for a given resource.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent resource name, in the format |
framework |
google::cloud::cloudsecuritycompliance::v1::Framework const &
Required. The resource being created |
framework_id |
std::string const &
Required. ID of the framework. This is not the full name of the framework. This is the last part of the full name of the framework. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cloudsecuritycompliance::v1::Framework > |
the result of the RPC. The response message type (google.cloud.cloudsecuritycompliance.v1.Framework) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateFramework(google::cloud::cloudsecuritycompliance::v1::CreateFrameworkRequest const &, Options)
Creates a single framework for a given resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cloudsecuritycompliance::v1::CreateFrameworkRequest 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::cloudsecuritycompliance::v1::Framework > |
the result of the RPC. The response message type (google.cloud.cloudsecuritycompliance.v1.Framework) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateFramework(google::cloud::cloudsecuritycompliance::v1::Framework const &, google::protobuf::FieldMask const &, Options)
Updates a single Framework.
Parameters | |
---|---|
Name | Description |
framework |
google::cloud::cloudsecuritycompliance::v1::Framework 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 Framework 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 present in the request will be overwritten. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cloudsecuritycompliance::v1::Framework > |
the result of the RPC. The response message type (google.cloud.cloudsecuritycompliance.v1.Framework) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateFramework(google::cloud::cloudsecuritycompliance::v1::UpdateFrameworkRequest const &, Options)
Updates a single Framework.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cloudsecuritycompliance::v1::UpdateFrameworkRequest 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::cloudsecuritycompliance::v1::Framework > |
the result of the RPC. The response message type (google.cloud.cloudsecuritycompliance.v1.Framework) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteFramework(std::string const &, Options)
Deletes a single Framework.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the resource, in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteFramework(google::cloud::cloudsecuritycompliance::v1::DeleteFrameworkRequest const &, Options)
Deletes a single Framework.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cloudsecuritycompliance::v1::DeleteFrameworkRequest 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 |
ListCloudControls(std::string const &, Options)
Lists CloudControls in a given organization.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent resource name, in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::cloudsecuritycompliance::v1::CloudControl > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListCloudControls(google::cloud::cloudsecuritycompliance::v1::ListCloudControlsRequest, Options)
Lists CloudControls in a given organization.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cloudsecuritycompliance::v1::ListCloudControlsRequest
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::cloudsecuritycompliance::v1::CloudControl > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetCloudControl(std::string const &, Options)
Gets details of a single CloudControl.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the cloudcontrol to retrieve in the format: organizations/{organization}/locations/{location}/cloudControls/{cloud_control} |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cloudsecuritycompliance::v1::CloudControl > |
the result of the RPC. The response message type (google.cloud.cloudsecuritycompliance.v1.CloudControl) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCloudControl(google::cloud::cloudsecuritycompliance::v1::GetCloudControlRequest const &, Options)
Gets details of a single CloudControl.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cloudsecuritycompliance::v1::GetCloudControlRequest 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::cloudsecuritycompliance::v1::CloudControl > |
the result of the RPC. The response message type (google.cloud.cloudsecuritycompliance.v1.CloudControl) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateCloudControl(std::string const &, google::cloud::cloudsecuritycompliance::v1::CloudControl const &, std::string const &, Options)
Creates a single CloudControl for a given resource.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent resource name, in the format |
cloud_control |
google::cloud::cloudsecuritycompliance::v1::CloudControl const &
Required. The resource being created |
cloud_control_id |
std::string const &
Required. ID of the CloudControl. This is the last segment of the CloudControl resource name. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cloudsecuritycompliance::v1::CloudControl > |
the result of the RPC. The response message type (google.cloud.cloudsecuritycompliance.v1.CloudControl) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateCloudControl(google::cloud::cloudsecuritycompliance::v1::CreateCloudControlRequest const &, Options)
Creates a single CloudControl for a given resource.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cloudsecuritycompliance::v1::CreateCloudControlRequest 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::cloudsecuritycompliance::v1::CloudControl > |
the result of the RPC. The response message type (google.cloud.cloudsecuritycompliance.v1.CloudControl) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateCloudControl(google::cloud::cloudsecuritycompliance::v1::CloudControl const &, google::protobuf::FieldMask const &, Options)
Updates a single CloudControl.
Parameters | |
---|---|
Name | Description |
cloud_control |
google::cloud::cloudsecuritycompliance::v1::CloudControl 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 CloudControl 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 present in the request will be overwritten. The fields that can be updated are:
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::cloudsecuritycompliance::v1::CloudControl > |
the result of the RPC. The response message type (google.cloud.cloudsecuritycompliance.v1.CloudControl) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateCloudControl(google::cloud::cloudsecuritycompliance::v1::UpdateCloudControlRequest const &, Options)
Updates a single CloudControl.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cloudsecuritycompliance::v1::UpdateCloudControlRequest 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::cloudsecuritycompliance::v1::CloudControl > |
the result of the RPC. The response message type (google.cloud.cloudsecuritycompliance.v1.CloudControl) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteCloudControl(std::string const &, Options)
Deletes a single CloudControl.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the resource, in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteCloudControl(google::cloud::cloudsecuritycompliance::v1::DeleteCloudControlRequest const &, Options)
Deletes a single CloudControl.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::cloudsecuritycompliance::v1::DeleteCloudControlRequest 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 |
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 |