REST Resource: folders.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 , если явно не задано значение настройки.

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

Тип данных

Тип данных для установки значений этого параметра. Подробнее о доступных типах данных см. в Value .

Перечисления
DATA_TYPE_UNSPECIFIED Неуказанный тип данных.
BOOLEAN Булева настройка.
STRING Настройка струны.
STRING_SET Настройка набора струн.

Методы

deleteValue

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

getValue

Получает значение настройки.

list

Перечисляет все настройки, доступные в parent ресурсе Cloud.

lookupEffectiveValue

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

updateValue

Обновляет значение настройки.