Индекс
-
ResourceSettingsService
(интерфейс) -
CreateSettingValueRequest
(сообщение) -
DeleteSettingValueRequest
(сообщение) -
GetSettingValueRequest
(сообщение) -
ListSettingsRequest
(сообщение) -
ListSettingsResponse
(сообщение) -
LookupEffectiveSettingValueRequest
(сообщение) -
SearchSettingValuesRequest
(сообщение) -
SearchSettingValuesResponse
(сообщение) -
Setting
(сообщение) -
Setting.DataType
(перечисление) -
SettingValue
(сообщение) -
UpdateSettingValueRequest
(сообщение) -
Value
(сообщение) -
Value.StringSet
(сообщение)
Ресурссеттингссервис
Интерфейс для взаимодействия с параметрами ресурсов и значениями параметров во всей иерархии ресурсов.
Службы могут отображать ряд параметров, позволяющих пользователям контролировать поведение своих ресурсов. Значения параметров, применяемые к данному облачному ресурсу, оцениваются иерархически и наследуются всеми потомками этого ресурса.
Для всех запросов возвращает google.rpc.Status
с google.rpc.Code.PERMISSION_DENIED
, если проверка IAM не удалась или parent
ресурс не находится в облачной организации. Для всех запросов возвращает google.rpc.Status
с google.rpc.Code.INVALID_ARGUMENT
, если запрос имеет неверный формат.
Примечание. Для всех настроек альфа-версии параметр не существует ни для каких ресурсов в облачных организациях, которые не находятся в альфа-версии.
CreateSettingValue | |
---|---|
Создает значение параметра. Возвращает
|
УдалитьНастройкаЗначения | |
---|---|
Удаляет значение настройки. Если значение параметра не существует, операция не выполняется. Возвращает
|
GetSettingValue | |
---|---|
Получает значение параметра. Возвращает
|
СписокНастройки | |
---|---|
Список всех параметров, доступных в
|
LookupEffectiveSettingValue | |
---|---|
Вычисляет действующее значение параметра для параметра в
Возвращает
|
SearchSettingValues | |
---|---|
Выполняет поиск всех значений параметров, существующих в
|
Упдатеттингвалуе | |
---|---|
Обновляет значение параметра. Возвращает Примечание: указанное значение параметра приведет к полной перезаписи всех полей.
|
CreateSettingValueRequest
Запрос CreateSettingValue.
Поля | |
---|---|
setting_value | Значение параметра для создания. Требования к полям см. в Для авторизации требуется следующее разрешение IAM на указанный ресурс
|
УдалитьSettingValueRequest
Запрос DeleteSettingValue.
Поля | |
---|---|
name | Имя значения параметра, которое необходимо удалить. Требования к именованию см. в Для авторизации требуется следующее разрешение IAM на указанное
|
ignore_read_only | Флаг, позволяющий удалить значение настройки |
GetSettingValueRequest
Запрос GetSettingValue.
Поля | |
---|---|
name | Имя значения параметра, которое требуется получить. Требования к именованию см. в Для авторизации требуется следующее разрешение IAM на указанное
|
ListSettingsRequest
Запрос ListSettings.
Поля | |
---|---|
parent | Облачный ресурс, являющийся родительским для настройки. Должен быть в одной из следующих форм:
Для авторизации требуется следующее разрешение IAM для указанного
|
page_size | Неиспользованный. Размер возвращаемой страницы. |
page_token | Неиспользованный. Маркер страницы, используемый для получения следующей страницы. |
ListSettingsResponse
Ответ от ListSettings.
Поля | |
---|---|
settings[] | Список настроек, доступных на указанном облачном ресурсе. |
next_page_token | Неиспользованный. Маркер страницы, используемый для получения следующей страницы. |
LookupEffectiveSettingValueRequest
Запрос LookupEffectiveSettingValue.
Поля | |
---|---|
parent | Параметр, для которого будет оцениваться эффективное значение. Требования к именованию см. в разделе Для авторизации требуется следующее разрешение IAM для указанного
|
ПоискНастройкаЗначенийЗапрос
Запрос SearchSettingValues.
Поля | |
---|---|
parent | Облачный ресурс, являющийся родительским для настройки. Должен быть в одной из следующих форм:
Для авторизации требуется следующее разрешение IAM для указанного
|
page_size | Неиспользованный. Размер возвращаемой страницы. |
page_token | Неиспользованный. Маркер страницы, используемый для получения следующей страницы. |
SearchSettingValuesResponse
Ответ от SearchSettingValues.
Поля | |
---|---|
setting_values[] | Все значения параметров, существующие в указанном облачном ресурсе. |
next_page_token | Неиспользованный. Маркер страницы, используемый для получения следующей страницы. |
Параметр
Схема установки значений. В данном облачном ресурсе параметр может быть родительским не более чем для одного значения параметра.
Поля | |
---|---|
name | Имя ресурса параметра. Должен быть в одной из следующих форм:
Например, "/projects/123/settings/gcp-enableMyFeature" |
display_name | Удобочитаемое имя для этого параметра. |
description | Подробное описание того, что делает этот параметр. |
read_only | Флаг, указывающий, что значения этого параметра не могут быть изменены (об обновлениях и причинах см. документацию по конкретному параметру); однако его можно удалить с помощью |
data_type | Тип данных для этого параметра. |
default_value | Значение, полученное Примечание: не все настройки имеют значение по умолчанию. |
Тип данных
Тип данных для установки значений этого параметра. Дополнительные сведения о доступных типах данных см. в разделе Value
.
перечисления | |
---|---|
DATA_TYPE_UNSPECIFIED | Неопределенный тип данных. |
BOOLEAN | Логическая настройка. |
STRING | Строковая настройка. |
STRING_SET | Настройка набора строк. |
НастройкаЗначение
Создание экземпляра настройки. Каждое значение настройки связано с соответствующей настройкой.
Поля | |
---|---|
name | Имя ресурса значения параметра. Должен быть в одной из следующих форм:
Например, "/projects/123/settings/gcp-enableMyFeature/value" |
value | Значение настройки. Тип данных |
etag | Отпечаток пальца, используемый для оптимистичного параллелизма. Дополнительные сведения см. в |
read_only | Только вывод. Флаг, указывающий, что это значение параметра нельзя изменить; однако его можно удалить с помощью |
update_time | Только вывод. Отметка времени, указывающая, когда значение параметра было обновлено в последний раз. |
Упдаттингвалуерекуест
Запрос UpdateSettingValue.
Поля | |
---|---|
setting_value | Значение параметра для обновления. Требования к полям см. в Для авторизации требуется следующее разрешение IAM на указанный ресурс
|
Ценить
Данные в значении настройки.
Поля | ||
---|---|---|
value поля объединения. Выбирает тип данных и связанное значение. value может быть только одним из следующих: | ||
boolean_value | Определяет это значение как логическое значение. | |
string_value | Определяет это значение как строковое значение. | |
string_set_value | Определяет это значение как StringSet. |
StringSet
Значение набора строк, которое может содержать набор строк. Максимальная длина каждой строки составляет 60 символов, а в наборе строк может быть не более 50 строк.
Поля | |
---|---|
values[] | Струны в комплекте |