REST Resource: organizations.settings

Resource: Setting

The schema for settings.

JSON representation 
{
  "name": string,
  "metadata": {
    object (SettingMetadata)
  },
  "localValue": {
    object (Value)
  },
  "effectiveValue": {
    object (Value)
  },
  "etag": string
}
Fields
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"
metadata

object (SettingMetadata)

Output only. Metadata about a setting which is not editable by the end user.
localValue

object (Value)

The configured value of the setting at the given parent resource, ignoring the resource hierarchy. The data type of Value must always be consistent with the data type defined in Setting.metadata.
effectiveValue

object (Value)

Output only. The effective value of the setting at the given parent resource, evaluated based on the resource hierarchy

The effective value evaluates to one of the following options, in this order. If an option is not valid or doesn't exist, then the next option is used:

  1. The local setting value on the given resource: Setting.local_value
  2. If one of the given resource's ancestors in the resource hierarchy have a local setting value, the local value at the nearest such ancestor.
  3. The setting's default value: SettingMetadata.default_value
  4. An empty value, defined as a Value with all fields unset.

The data type of Value must always be consistent with the data type defined in Setting.metadata.
etag

string

A fingerprint used for optimistic concurrency. See settings.patch for more details.

Methods

get

 Returns a specified setting.

list

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

patch

 Updates a specified setting.