REST Resource: organizations.settings

Ресурс: Настройка

Схема установки значений. В данном облачном ресурсе параметр может быть родительским не более чем для одного значения параметра.

Представление JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "readOnly": boolean,
  "dataType": enum (DataType),
  "defaultValue": {
    object (Value)
  }
}
Поля
name

string

Имя ресурса параметра. Должен быть в одной из следующих форм:

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

Например, "/projects/123/settings/gcp-enableMyFeature"

displayName

string

Удобочитаемое имя для этого параметра.

description

string

Подробное описание того, что делает этот параметр.

readOnly

boolean

Флаг, указывающий, что значения этого параметра не могут быть изменены (об обновлениях и причинах см. документацию по конкретному параметру); однако его можно удалить с помощью settings.deleteValue , если DeleteSettingValueRequest.ignore_read_only установлено значение true. Использование этого флага считается подтверждением того, что значение параметра не может быть воссоздано. Дополнительные сведения см. в DeleteSettingValueRequest.ignore_read_only .

dataType

enum ( DataType )

Тип данных для этого параметра.

defaultValue

object ( Value )

Значение, полученное параметром settings.lookupEffectiveValue , если значение параметра не задано явно.

Примечание: не все настройки имеют значение по умолчанию.

Методы

deleteValue

 Удаляет значение настройки.

getValue

 Получает значение параметра.

list

 Список всех параметров, доступных в parent облачном ресурсе.

lookupEffectiveValue

 Вычисляет действующее значение параметра для параметра в parent облачном ресурсе.
Выполняет поиск всех значений параметров, существующих в parent ресурсе.

updateValue

 Обновляет значение параметра.