REST Resource: folders.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.

SettingMetadata

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

JSON representation 
 { 
 "displayName" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "readOnly" 
 : 
 boolean 
 , 
 "dataType" 
 : 
 enum (  DataType 
 
) 
 , 
 "defaultValue" 
 : 
 { 
 object (  Value 
 
) 
 } 
 }
Fields
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 for the specific setting for updates and reasons.
dataType

enum ( DataType )

The data type for this setting.
defaultValue

object ( Value )

The value provided by Setting.effective_value if no setting value is explicitly set.

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.
ENUM_VALUE A Enum setting
DURATION_VALUE A Duration setting
STRING_MAP A string->string map setting

Value

The data in a setting value.

JSON representation 
 { 
 // Union field value 
can be only one of the following: 
 "booleanValue" 
 : 
 boolean 
 , 
 "stringValue" 
 : 
 string 
 , 
 "stringSetValue" 
 : 
 { 
 object (  StringSet 
 
) 
 } 
 , 
 "enumValue" 
 : 
 { 
 object (  EnumValue 
 
) 
 } 
 , 
 "durationValue" 
 : 
 string 
 , 
 "stringMapValue" 
 : 
 { 
 object (  StringMap 
 
) 
 } 
 // End of list of possible types for union field value 
. 
 }
Fields
Union field value . Selects the data type and associated value. value can be only one of the following:
booleanValue

boolean

Defines this value as being a boolean value.

stringValue

string

Defines this value as being a string value.

stringSetValue

object ( StringSet )

Defines this value as being a StringSet.

enumValue

object ( EnumValue )

Defines this value as being a Enum.

durationValue

string ( Duration format)

Defines this value as being a Duration.

A duration in seconds with up to nine fractional digits, terminated by ' s '. Example: "3.5s" .

stringMapValue

object ( StringMap )

Defines this value as being a StringMap.

StringSet

A string set value that can hold a set of strings. The maximum length of each string is 200 characters and there can be a maximum of 50 strings in the string set.

JSON representation 
 { 
 "values" 
 : 
 [ 
 string 
 ] 
 }
Fields
values[]

string

The strings in the set

EnumValue

A enum value that can hold any enum type setting values. Each enum type is represented by a number, this representation is stored in the definitions.

JSON representation 
 { 
 "value" 
 : 
 string 
 }
Fields
value

string

The value of this enum

StringMap

A string->string map value that can hold a map of string keys to string values. The maximum length of each string is 200 characters and there can be a maximum of 50 key-value pairs in the map.

JSON representation 
 { 
 "mappings" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 }
Fields
mappings

map (key: string, value: string)

The key-value pairs in the map

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

Methods

get

Returns a specified setting.

list

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

patch

Updates a specified setting.