Page Summary
-
The Setting resource defines configurable values for Cloud resources, allowing for customization and control.
-
Settings have properties like name, display name, description, data type, and a default value, which is used if no specific value is set.
-
You can manage settings using methods to delete, get, list, lookup, search, and update setting values.
-
Each setting can have at most one value associated with it at a given Cloud resource.
-
Settings can be read-only, preventing modification of their values, though they may be deleted under certain conditions.
Resource: Setting
The schema for setting values. At a given Cloud resource, a setting can parent at most one setting value.
| JSON representation | |
|---|---|
{ "name" : string , "displayName" : string , "description" : string , "readOnly" : boolean , "dataType" : enum ( |
|
name
string
The resource name of the setting. Must be in one of the following forms:
-
projects/{project_number}/settings/{setting_name} -
folders/{folder_id}/settings/{setting_name} -
organizations/{organization_id}/settings/{setting_name}
For example, "/projects/123/settings/gcp-enableMyFeature"
displayName
string
The human readable name for this setting.
description
string
A detailed description of what this setting does.
readOnly
boolean
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 settings.deleteValue
if DeleteSettingValueRequest.ignore_read_only
is set to true. Using this flag is considered an acknowledgement that the setting value cannot be recreated. See DeleteSettingValueRequest.ignore_read_only
for more details.
dataType
enum (
DataType
)
The data type for this setting.
defaultValue
object (
Value
)
The value received by settings.lookupEffectiveValue
if no setting value is explicitly set.
Note: not all settings have a default value.
Methods |
|
|---|---|
|
Deletes a setting value. |
|
Gets a setting value. |
|
Lists all the settings that are available on the Cloud resource parent
. |
|
Computes the effective setting value of a setting at the Cloud resource parent
. |
|
Searches for all setting values that exist on the resource parent
. |
|
Updates a setting value. |
