REST Resource: organizations.settings.value

  • SettingValue represents an instance of a setting, containing the value and metadata like name, Etag, and update time.

  • Each SettingValue is associated with a parent setting, inheriting properties like data type and read-only status.

  • The value field within SettingValue adheres to a specific data type defined by its parent setting and can be modified unless marked read-only.

  • You can create a new SettingValue using the provided API method, ensuring the value aligns with the parent setting's data type.

  • SettingValues provide a structured way to manage and store configuration data for your resources, offering features like optimistic concurrency control through Etags.

Resource: SettingValue

The instantiation of a setting. Every setting value is parented by its corresponding setting.

JSON representation 
{
  "name": string,
  "value": {
    object (Value)
  },
  "etag": string,
  "readOnly": boolean,
  "updateTime": string
}
Fields
name

string

The resource name of the setting value. Must be in one of the following forms:

  • projects/{project_number}/settings/{setting_name}/value
  • folders/{folder_id}/settings/{setting_name}/value
  • organizations/{organization_id}/settings/{setting_name}/value

For example, "/projects/123/settings/gcp-enableMyFeature/value"
value

object (Value)

The value of the setting. The data type of Value must always be consistent with the data type defined by the parent setting.
etag

string

A fingerprint used for optimistic concurrency. See settings.updateValue for more details.
readOnly

boolean

Output only. A flag indicating that this setting value cannot be modified; 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. This flag is inherited from its parent setting and is for convenience purposes. See Setting.read_only for more details.
updateTime

string (Timestamp format)

Output only. The timestamp indicating when the setting value was last updated.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Methods

create

 Creates a setting value.