Package google.cloud.resourcesettings.v1alpha1
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Ресурссеттингссервис
Интерфейс для взаимодействия с параметрами ресурсов и значениями параметров во всей иерархии ресурсов.
Службы могут отображать ряд параметров, позволяющих пользователям контролировать поведение своих ресурсов. Значения параметров, применяемые к данному облачному ресурсу, оцениваются иерархически и наследуются всеми потомками этого ресурса.
Для всех запросов возвращает 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 , если значение параметра уже существует в данном облачном ресурсе. Возвращает google.rpc.Status с google.rpc.Code.FAILED_PRECONDITION , если параметр помечен как доступный только для чтения. - Области авторизации
Требуется следующая область действия OAuth: -
https://www.googleapis.com/auth/cloud-platform
Дополнительные сведения см. в разделе Обзор аутентификации .
|
| УдалитьНастройкаЗначения |
|---|
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
Дополнительные сведения см. в разделе Обзор аутентификации .
|
| LookupEffectiveSettingValue |
|---|
rpc LookupEffectiveSettingValue( LookupEffectiveSettingValueRequest ) returns ( SettingValue ) Вычисляет действующее значение параметра для параметра в parent облачном ресурсе. Действующее значение параметра — это рассчитанное значение параметра в облачном ресурсе, которое оценивается как один из следующих параметров в заданном порядке (следующий параметр используется, если предыдущий не существует): - значение параметра на данном ресурсе
- значение параметра для ближайшего предка данного ресурса
- значение параметра по умолчанию
- пустое значение настройки, определенное как
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
Дополнительные сведения см. в разделе Обзор аутентификации .
|
| Упдатеттингвалуе |
|---|
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
|
УдалитьSettingValueRequest
Запрос DeleteSettingValue.
| Поля |
|---|
name | string Имя значения параметра, которое необходимо удалить. Требования к именованию см. в SettingValue . Для авторизации требуется следующее разрешение IAM на указанное name ресурса: -
resourcesettings.settingvalues.delete
|
ignore_read_only | bool Флаг, позволяющий удалить значение настройки read_only . ВНИМАНИЕ: используйте на свой страх и риск. Удаление значения параметра только для чтения является необратимым действием (т. е. его нельзя создать снова). |
GetSettingValueRequest
| Поля |
|---|
name | string Имя значения параметра, которое требуется получить. Требования к именованию см. в SettingValue . Для авторизации требуется следующее разрешение IAM на указанное name ресурса: -
resourcesettings.settingvalues.get
|
ListSettingsRequest
| Поля |
|---|
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
| Поля |
|---|
settings[] | Setting Список настроек, доступных на указанном облачном ресурсе. |
next_page_token | string Неиспользованный. Маркер страницы, используемый для получения следующей страницы. |
LookupEffectiveSettingValueRequest
Запрос LookupEffectiveSettingValue.
| Поля |
|---|
parent | string Параметр, для которого будет оцениваться эффективное значение. Требования к именованию см. в разделе Setting . Для авторизации требуется следующее разрешение IAM для указанного parent ресурса: -
resourcesettings.settingvalues.get
|
ПоискНастройкаЗначенийЗапрос
Запрос 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 Неиспользованный. Маркер страницы, используемый для получения следующей страницы. |
SearchSettingValuesResponse
Ответ от 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 | Настройка набора строк. |
НастройкаЗначение
Создание экземпляра настройки. Каждое значение настройки связано с соответствующей настройкой.
| Поля |
|---|
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 Только вывод. Отметка времени, указывающая, когда значение параметра было обновлено в последний раз. |
Упдаттингвалуерекуест
Запрос 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 Струны в комплекте |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2023-05-25 UTC.
[[["Прост для понимания","easyToUnderstand","thumb-up"],["Помог мне решить мою проблему","solvedMyProblem","thumb-up"],["Другое","otherUp","thumb-up"]],[["Отсутствует нужная мне информация","missingTheInformationINeed","thumb-down"],["Слишком сложен/слишком много шагов","tooComplicatedTooManySteps","thumb-down"],["Устарел","outOfDate","thumb-down"],["Проблема с переводом текста","translationIssue","thumb-down"],["Проблемы образцов/кода","samplesCodeIssue","thumb-down"],["Другое","otherDown","thumb-down"]],["Последнее обновление: 2023-05-25 UTC."],[[["ResourceSettingsService provides an interface for interacting with resource settings and setting values within the Google Cloud resource hierarchy."],["Setting values are inherited hierarchically, with values applied to a resource being inherited by all its descendants."],["The service offers methods to create, delete, get, list, lookup, search, and update setting values."],["All requests require specific IAM permissions and may return errors like `PERMISSION_DENIED`, `INVALID_ARGUMENT`, or `NOT_FOUND`."],["Setting values can have different data types, including boolean, string, and string set, and their schema is defined by the corresponding setting."]]],["The core content details the `ResourceSettingsService` interface, which manages settings and their values across a resource hierarchy. Key actions include: creating, deleting, getting, and updating setting values. It enables listing all available settings and searching for specific setting values on a resource. The service also computes the effective setting value based on hierarchical inheritance and defaults. Operations are subject to IAM permissions and may return error statuses like `PERMISSION_DENIED`, `INVALID_ARGUMENT`, `NOT_FOUND`, and `FAILED_PRECONDITION`.\n"]]
