Package google.cloud.resourcesettings.v1alpha1

Индекс

ResourceSettingsService

Интерфейс для взаимодействия с настройками ресурсов и значениями настроек по всей иерархии ресурсов.

Сервисы могут предоставлять пользователям ряд настроек для управления поведением своих ресурсов. Значения настроек, применяемые к данному облачному ресурсу, оцениваются иерархически и наследуются всеми потомками этого ресурса.

Для всех запросов возвращает google.rpc.Status с google.rpc.Code.PERMISSION_DENIED , если проверка IAM не пройдена или parent ресурс не находится в облачной организации. Для всех запросов возвращает google.rpc.Status с google.rpc.Code.INVALID_ARGUMENT , если запрос некорректен.

Примечание: для всех настроек стадии альфа настройка не существует ни в каких ресурсах в облачных организациях, которые не находятся в стадии альфа.

CreateSettingValue

rpc CreateSettingValue( CreateSettingValueRequest ) returns ( SettingValue )

Создает значение настройки.

Возвращает google.rpc.Status с google.rpc.Code.NOT_FOUND , если параметр не существует. Возвращает google.rpc.Status с google.rpc.Code.ALREADY_EXISTS , если значение параметра уже существует в заданном ресурсе Cloud. Возвращает google.rpc.Status с google.rpc.Code.FAILED_PRECONDITION если параметр помечен как доступный только для чтения.

Области авторизации

Требуется следующая область OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Более подробную информацию см. в разделе Обзор аутентификации .

DeleteSettingValue

rpc DeleteSettingValue( DeleteSettingValueRequest ) returns ( Empty )

Удаляет значение настройки. Если значение настройки не существует, операция не выполняется.

Возвращает google.rpc.Status с google.rpc.Code.NOT_FOUND , если параметр или его значение не существует. Значение параметра не будет существовать, если предыдущий вызов DeleteSetting для этого значения уже вернул код успешного завершения. Возвращает google.rpc.Status с google.rpc.Code.FAILED_PRECONDITION , если параметр помечен как «только для чтения».

Области авторизации

Требуется следующая область OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Более подробную информацию см. в разделе Обзор аутентификации .

GetSettingValue

rpc GetSettingValue( GetSettingValueRequest ) returns ( SettingValue )

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

Возвращает google.rpc.Status с google.rpc.Code.NOT_FOUND , если значение настройки не существует.

Области авторизации

Требуется следующая область OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Более подробную информацию см. в разделе Обзор аутентификации .

Настройки списка

rpc ListSettings( ListSettingsRequest ) returns ( ListSettingsResponse )

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

Области авторизации

Требуется следующая область OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Более подробную информацию см. в разделе Обзор аутентификации .

LookupEffectiveSettingValue

rpc LookupEffectiveSettingValue( LookupEffectiveSettingValueRequest ) returns ( SettingValue )

Вычисляет эффективное значение параметра parent облачного ресурса. Эффективное значение параметра — это рассчитанное значение параметра родительского облачного ресурса, которое может быть оценено как один из следующих вариантов в указанном порядке (следующий вариант используется, если предыдущий отсутствует):

  1. значение настройки на данном ресурсе
  2. значение настройки ближайшего предка данного ресурса
  3. значение настройки по умолчанию
  4. пустое значение настройки, определенное как SettingValue со всеми неустановленными полями

Возвращает google.rpc.Status с google.rpc.Code.NOT_FOUND , если настройка не существует.

Области авторизации

Требуется следующая область OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Более подробную информацию см. в разделе Обзор аутентификации .

SearchSettingValues

rpc SearchSettingValues( SearchSettingValuesRequest ) returns ( SearchSettingValuesResponse )

Поиск всех значений параметров, существующих в parent ресурсе. Значения параметров не ограничиваются значениями конкретного параметра.

Области авторизации

Требуется следующая область OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Более подробную информацию см. в разделе Обзор аутентификации .

UpdateSettingValue

rpc UpdateSettingValue( UpdateSettingValueRequest ) returns ( SettingValue )

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

Возвращает google.rpc.Status с google.rpc.Code.NOT_FOUND , если параметр или его значение не существует. Возвращает google.rpc.Status с google.rpc.Code.FAILED_PRECONDITION , если параметр помечен как доступный только для чтения. Возвращает google.rpc.Status с google.rpc.Code.ABORTED если указанный в запросе etag не соответствует сохраненному etag значения параметра.

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

Области авторизации

Требуется следующая область OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Более подробную информацию см. в разделе Обзор аутентификации .

CreateSettingValueRequest

Запрос на CreateSettingValue.

Поля
setting_value

SettingValue

Значение параметра, которое необходимо создать. Требования к полям см. в описании SettingValue .

Для авторизации требуется следующее разрешение IAM для указанного ресурса settingValue :

  • resourcesettings.settingvalues.create

DeleteSettingValueRequest

Запрос на DeleteSettingValue.

Поля
name

string

Имя удаляемого значения параметра. Требования к именованию см. в описании SettingValue .

Для авторизации требуется следующее разрешение IAM для указанного name ресурса:

  • resourcesettings.settingvalues.delete
ignore_read_only

bool

Флаг, позволяющий удалить значение параметра, read_only . ВНИМАНИЕ: используйте на свой страх и риск. Удаление значения параметра, доступного только для чтения, является необратимым действием (т.е. его невозможно создать снова).

GetSettingValueRequest

Запрос GetSettingValue.

Поля
name

string

Имя значения параметра, которое нужно получить. Требования к именованию см. в описании SettingValue .

Для авторизации требуется следующее разрешение IAM для указанного name ресурса:

  • resourcesettings.settingvalues.get

ListSettingsRequest

Запрос на ListSettings.

Поля
parent

string

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

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

Для авторизации требуется следующее разрешение IAM для указанного parent ресурса:

  • resourcesettings.settings.list
page_size

int32

Неиспользованный. Размер возвращаемой страницы.

page_token

string

Не используется. Токен страницы, используемый для получения следующей страницы.

ListSettingsResponse

Ответ от ListSettings.

Поля
settings[]

Setting

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

next_page_token

string

Не используется. Токен страницы, используемый для получения следующей страницы.

Запрос на поиск эффективного значения настройки

Запрос LookupEffectiveSettingValue.

Поля
parent

string

Параметр, для которого будет оцениваться эффективное значение. Требования к именованию см. в Setting .

Для авторизации требуется следующее разрешение IAM для указанного parent ресурса:

  • resourcesettings.settingvalues.get

SearchSettingValuesRequest

Запрос SearchSettingValues.

Поля
parent

string

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

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

Для авторизации требуется следующее разрешение IAM для указанного parent ресурса:

  • resourcesettings.settingvalues.list
page_size

int32

Неиспользованный. Размер возвращаемой страницы.

page_token

string

Не используется. Токен страницы, используемый для получения следующей страницы.

ПоискНастройкиЗначенияОтвет

Ответ от SearchSettingValues.

Поля
setting_values[]

SettingValue

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

next_page_token

string

Не используется. Токен страницы, используемый для получения следующей страницы.

Параметр

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

Поля
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»

display_name

string

Человекочитаемое название для этой настройки.

description

string

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

read_only

bool

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

data_type

DataType

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

default_value

Value

Значение, полученное LookupEffectiveSettingValue , если явно не задано значение настройки.

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

Тип данных

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

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

SettingValue

Создание экземпляра настройки. Каждое значение настройки является родительским для соответствующей настройки.

Поля
name

string

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

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

Например, «/projects/123/settings/gcp-enableMyFeature/value»

value

Value

Значение параметра. Тип данных Value всегда должен соответствовать типу данных, определенному родительским параметром.

etag

string

Отпечаток, используемый для оптимистичного параллелизма. Подробнее см. в разделе UpdateSettingValue .

read_only

bool

Только вывод. Флаг, указывающий, что значение этого параметра невозможно изменить; однако его можно удалить с помощью DeleteSettingValue , если DeleteSettingValueRequest.ignore_read_only имеет значение true. Использование этого флага считается подтверждением того, что значение параметра невозможно пересоздать. Этот флаг наследуется от родительского параметра и используется для удобства. Подробнее см. Setting.read_only .

update_time

Timestamp

Только вывод. Метка времени, указывающая, когда значение параметра было обновлено в последний раз.

UpdateSettingValueRequest

Запрос UpdateSettingValue.

Поля
setting_value

SettingValue

Значение параметра для обновления. Требования к полю см. в описании SettingValue .

Для авторизации требуется следующее разрешение IAM для указанного ресурса settingValue :

  • resourcesettings.settingvalues.update

Ценить

Данные в значении настройки.

Поля
value поля объединения. Выбирает тип данных и связанное с ним значение. value может быть только одним из следующих:
boolean_value

bool

Определяет это значение как логическое значение.

string_value

string

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

string_set_value

StringSet

Определяет это значение как StringSet.

StringSet

Значение набора строк, которое может содержать набор строк. Максимальная длина каждой строки составляет 60 символов, а количество строк в наборе не может превышать 50.

Поля
values[]

string

Струны в наборе