Index
ResourceSettingsService
(interface)CreateSettingValueRequest
(message)DeleteSettingValueRequest
(message)GetSettingValueRequest
(message)ListSettingsRequest
(message)ListSettingsResponse
(message)LookupEffectiveSettingValueRequest
(message)SearchSettingValuesRequest
(message)SearchSettingValuesResponse
(message)Setting
(message)Setting.DataType
(enum)SettingValue
(message)UpdateSettingValueRequest
(message)Value
(message)Value.StringSet
(message)
ResourceSettingsService
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. Setting values 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.
Note: For all alpha stage Settings, the Setting does not exist under any resources in Cloud Organizations that are not in the alpha.
CreateSettingValue | |
---|---|
Creates a setting value. Returns a
|
DeleteSettingValue | |
---|---|
Deletes a setting value. If the setting value does not exist, the operation is a no-op. Returns a
|
GetSettingValue | |
---|---|
Gets a setting value. Returns a
|
ListSettings | |
---|---|
Lists all the settings that are available on the Cloud resource
|
LookupEffectiveSettingValue | |
---|---|
Computes the effective setting value of a setting at the Cloud resource
Returns a
|
SearchSettingValues | |
---|---|
Searches for all setting values that exist on the resource
|
UpdateSettingValue | |
---|---|
Updates a setting value. Returns a Note: the supplied setting value will perform a full overwrite of all fields.
|
CreateSettingValueRequest
The request for CreateSettingValue.
Fields | |
---|---|
setting_value |
The setting value to create. See Authorization requires the following IAM permission on the specified resource
|
DeleteSettingValueRequest
The request for DeleteSettingValue.
Fields | |
---|---|
name |
The name of the setting value to delete. See Authorization requires the following IAM permission on the specified resource
|
ignore_read_only |
A flag that allows the deletion of the value of a |
GetSettingValueRequest
The request for GetSettingValue.
Fields | |
---|---|
name |
The name of the setting value to get. See Authorization requires the following IAM permission on the specified resource
|
ListSettingsRequest
The request for ListSettings.
Fields | |
---|---|
parent |
The Cloud resource that parents the setting. Must be in one of the following forms:
Authorization requires the following IAM permission on the specified resource
|
page_size |
Unused. The size of the page to be returned. |
page_token |
Unused. A page token used to retrieve the next page. |
ListSettingsResponse
The response from ListSettings.
Fields | |
---|---|
settings[] |
A list of settings that are available at the specified Cloud resource. |
next_page_token |
Unused. A page token used to retrieve the next page. |
LookupEffectiveSettingValueRequest
The request for LookupEffectiveSettingValue.
Fields | |
---|---|
parent |
The setting for which an effective value will be evaluated. See Authorization requires the following IAM permission on the specified resource
|
SearchSettingValuesRequest
The request for SearchSettingValues.
Fields | |
---|---|
parent |
The Cloud resource that parents the setting. Must be in one of the following forms:
Authorization requires the following IAM permission on the specified resource
|
page_size |
Unused. The size of the page to be returned. |
page_token |
Unused. A page token used to retrieve the next page. |
SearchSettingValuesResponse
The response from SearchSettingValues.
Fields | |
---|---|
setting_values[] |
All setting values that exist on the specified Cloud resource. |
next_page_token |
Unused. A page token used to retrieve the next page. |
Setting
The schema for setting values. At a given Cloud resource, a setting can parent at most one setting value.
Fields | |
---|---|
name |
The resource name of the setting. Must be in one of the following forms:
For example, "/projects/123/settings/gcp-enableMyFeature" |
display_name |
The human readable name for this setting. |
description |
A detailed description of what this setting does. |
read_only |
A flag indicating that values of this setting cannot be modified (see documentation of the specific setting for updates and reasons); however, it may be deleted using |
data_type |
The data type for this setting. |
default_value |
The value received by Note: not all settings have a default value. |
DataType
The data type for setting values of this setting. See Value
for more details on the available data types.
Enums | |
---|---|
DATA_TYPE_UNSPECIFIED |
Unspecified data type. |
BOOLEAN |
A boolean setting. |
STRING |
A string setting. |
STRING_SET |
A string set setting. |
SettingValue
The instantiation of a setting. Every setting value is parented by its corresponding setting.
Fields | |
---|---|
name |
The resource name of the setting value. Must be in one of the following forms:
For example, "/projects/123/settings/gcp-enableMyFeature/value" |
value |
The value of the setting. The data type of |
etag |
A fingerprint used for optimistic concurrency. See |
read_only |
Output only. A flag indicating that this setting value cannot be modified; however, it may be deleted using |
update_time |
Output only. The timestamp indicating when the setting value was last updated. |
UpdateSettingValueRequest
The request for UpdateSettingValue.
Fields | |
---|---|
setting_value |
The setting value to update. See Authorization requires the following IAM permission on the specified resource
|
Value
The data in a setting value.
Fields | ||
---|---|---|
Union field value . Selects the data type and associated value. value can be only one of the following: |
||
boolean_value |
Defines this value as being a boolean value. |
|
string_value |
Defines this value as being a string value. |
|
string_set_value |
Defines this value as being a StringSet. |
StringSet
A string set value that can hold a set of strings. The maximum length of each string is 60 characters and there can be a maximum of 50 strings in the string set.
Fields | |
---|---|
values[] |
The strings in the set |