Class ResourceSettingsServiceClient (2.27.0)

An interface to interact with resource settings and setting values throughout the resource hierarchy.

Services may surface a number of settings for users to control how their resources behave. Values of settings applied on a given Cloud resource are evaluated hierarchically and inherited by all descendants of that resource.

For all requests, returns a google.rpc.Status with google.rpc.Code.PERMISSION_DENIED if the IAM check fails or the parent resource is not in a Cloud Organization. For all requests, returns a google.rpc.Status with google.rpc.Code.INVALID_ARGUMENT if the request is malformed. (== deprecation_description Resource Settings is deprecated. As of November 7, 2023, no organizations will be onboarded for any of the enabled settings, and the service will be shut down on October 1, 2024. ==)

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

ResourceSettingsServiceClient(ResourceSettingsServiceClient const &)

Copy and move support

Parameter
Name	Description
	`ResourceSettingsServiceClient const &`

ResourceSettingsServiceClient(ResourceSettingsServiceClient &&)

Copy and move support

Parameter
Name	Description
	`ResourceSettingsServiceClient &&`

ResourceSettingsServiceClient(std::shared_ptr< ResourceSettingsServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< ResourceSettingsServiceConnection >`
`opts`	`Options`

Operators

operator=(ResourceSettingsServiceClient const &)

Copy and move support

Parameter
Name	Description
	`ResourceSettingsServiceClient const &`

Returns
Type	Description
`ResourceSettingsServiceClient &`

operator=(ResourceSettingsServiceClient &&)

Copy and move support

Parameter
Name	Description
	`ResourceSettingsServiceClient &&`

Returns
Type	Description
`ResourceSettingsServiceClient &`

Functions

ListSettings(std::string const &, Options)

Lists all the settings that are available on the Cloud resource parent.

Parameters

Name Description

parent

std::string const &

Required. The Cloud resource that parents the setting. Must be in one of the following forms:

projects/{project_number}
projects/{project_id}
folders/{folder_id}
organizations/{organization_id}

opts

Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::resourcesettings::v1::Setting >

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.cloud.resourcesettings.v1.Setting, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSettings(google::cloud::resourcesettings::v1::ListSettingsRequest, Options)

Lists all the settings that are available on the Cloud resource parent.

Parameters
Name	Description
`request`	`google::cloud::resourcesettings::v1::ListSettingsRequest` 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.cloud.resourcesettings.v1.ListSettingsRequest. 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::cloud::resourcesettings::v1::Setting >

GetSetting(std::string const &, Options)

Gets a setting.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the setting to get. See Setting for naming requirements.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetSetting(google::cloud::resourcesettings::v1::GetSettingRequest const &, Options)

Gets a setting.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist.

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

UpdateSetting(google::cloud::resourcesettings::v1::UpdateSettingRequest const &, Options)

Updates a setting.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist. Returns a google.rpc.Status with google.rpc.Code.FAILED_PRECONDITION if the setting is flagged as read only. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the setting value.

On success, the response will contain only name, local_value and etag. The metadata and effective_value cannot be updated through this API.

Note: the supplied setting will perform a full overwrite of the local_value field.

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