此页面由 Cloud Translation API 翻译。

Package google.cloud.resourcesettings.v1alpha1

索引

ResourceSettingsService（接口）
CreateSettingValueRequest（消息）
DeleteSettingValueRequest（消息）
GetSettingValueRequest（消息）
ListSettingsRequest（消息）
ListSettingsResponse（消息）
LookupEffectiveSettingValueRequest（消息）
SearchSettingValuesRequest（消息）
SearchSettingValuesResponse（消息）
Setting（消息）
Setting.DataType（枚举）
SettingValue（消息）
UpdateSettingValueRequest（消息）
Value（消息）
Value.StringSet（消息）

ResourceSettingsService

一种用于在整个资源层次结构中与资源设置和设置值进行交互的接口。

服务可能会向用户显示许多设置，以便用户控制其资源的行为。应用于给定 Cloud 资源的设置值会按层次结构进行评估，并由该资源的所有后代继承。

对于所有请求，如果 IAM 检查失败或 parent 资源不在 Cloud 组织中，则返回包含 google.rpc.Code.PERMISSION_DENIED 的 google.rpc.Status。对于所有请求，如果请求格式不正确，则返回包含 google.rpc.Code.INVALID_ARGUMENT 的 google.rpc.Status。

注意：对于所有 Alpha 版设置，如果 Cloud 组织中的资源不在 Alpha 版中，则该设置不会存在于这些资源下。

CreateSettingValue

CreateSettingValue
`rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)` 创建设置值。如果相应设置不存在，则返回包含 `google.rpc.Code.NOT_FOUND` 的 `google.rpc.Status`。如果给定 Cloud 资源上已存在设置值，则返回包含 `google.rpc.Code.ALREADY_EXISTS` 的 `google.rpc.Status`。如果设置被标记为只读，则返回带有 `google.rpc.Code.FAILED_PRECONDITION` 的 `google.rpc.Status`。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

创建设置值。

如果相应设置不存在，则返回包含 google.rpc.Code.NOT_FOUND 的 google.rpc.Status。如果给定 Cloud 资源上已存在设置值，则返回包含 google.rpc.Code.ALREADY_EXISTS 的 google.rpc.Status。如果设置被标记为只读，则返回带有 google.rpc.Code.FAILED_PRECONDITION 的 google.rpc.Status。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅身份验证概览。

DeleteSettingValue

DeleteSettingValue
`rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)` 删除设置值。如果设置值不存在，则该操作不执行任何操作。如果设置或设置值不存在，则返回包含 `google.rpc.Code.NOT_FOUND` 的 `google.rpc.Status`。如果之前对设置值的 `DeleteSetting` 调用已返回成功代码，则设置值将不存在。如果设置被标记为只读，则返回带有 `google.rpc.Code.FAILED_PRECONDITION` 的 `google.rpc.Status`。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)

删除设置值。如果设置值不存在，则该操作不执行任何操作。

如果设置或设置值不存在，则返回包含 google.rpc.Code.NOT_FOUND 的 google.rpc.Status。如果之前对设置值的 DeleteSetting 调用已返回成功代码，则设置值将不存在。如果设置被标记为只读，则返回带有 google.rpc.Code.FAILED_PRECONDITION 的 google.rpc.Status。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅身份验证概览。

GetSettingValue

GetSettingValue
`rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)` 获取设置值。如果设置值不存在，则返回包含 `google.rpc.Code.NOT_FOUND` 的 `google.rpc.Status`。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

获取设置值。

如果设置值不存在，则返回包含 google.rpc.Code.NOT_FOUND 的 google.rpc.Status。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅身份验证概览。

ListSettings

ListSettings
`rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)` 列出云资源 `parent` 上可用的所有设置。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

列出云资源 parent 上可用的所有设置。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅身份验证概览。

LookupEffectiveSettingValue

LookupEffectiveSettingValue
`rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)` 计算云资源 `parent` 中设置的有效设置值。有效设置值是指 Cloud 资源中计算出的设置值，并按以下顺序评估为以下选项之一（如果前一个选项不存在，则使用下一个选项）：给定资源上的设置值给定资源最近的祖先的设置值相应设置的默认值空设置值，定义为所有字段均未设置的 `SettingValue` 如果相应设置不存在，则返回包含 `google.rpc.Code.NOT_FOUND` 的 `google.rpc.Status`。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

计算云资源 parent 中设置的有效设置值。有效设置值是指 Cloud 资源中计算出的设置值，并按以下顺序评估为以下选项之一（如果前一个选项不存在，则使用下一个选项）：

给定资源上的设置值
给定资源最近的祖先的设置值
相应设置的默认值
空设置值，定义为所有字段均未设置的 SettingValue

如果相应设置不存在，则返回包含 google.rpc.Code.NOT_FOUND 的 google.rpc.Status。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅身份验证概览。

SearchSettingValues

SearchSettingValues
`rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)` 搜索资源 `parent` 上存在的所有设置值。设置值不限于特定设置的值。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

搜索资源 parent 上存在的所有设置值。设置值不限于特定设置的值。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅身份验证概览。

UpdateSettingValue

UpdateSettingValue
`rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)` 更新设置值。如果设置或设置值不存在，则返回包含 `google.rpc.Code.NOT_FOUND` 的 `google.rpc.Status`。如果设置被标记为只读，则返回带有 `google.rpc.Code.FAILED_PRECONDITION` 的 `google.rpc.Status`。如果请求中提供的 ETag 与设置值的持久化 ETag 不匹配，则返回 `google.rpc.Status`，并包含 `google.rpc.Code.ABORTED`。注意：提供的设置值将完全覆盖所有字段。授权范围需要以下 OAuth 范围： `https://www.googleapis.com/auth/cloud-platform` 如需了解详情，请参阅身份验证概览。

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)

更新设置值。

如果设置或设置值不存在，则返回包含 google.rpc.Code.NOT_FOUND 的 google.rpc.Status。如果设置被标记为只读，则返回带有 google.rpc.Code.FAILED_PRECONDITION 的 google.rpc.Status。如果请求中提供的 ETag 与设置值的持久化 ETag 不匹配，则返回 google.rpc.Status，并包含 google.rpc.Code.ABORTED。

注意：提供的设置值将完全覆盖所有字段。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅身份验证概览。

CreateSettingValueRequest

针对 CreateSettingValue 的请求。

字段

字段
`setting_value`	`SettingValue` 要创建的设置值。如需了解字段要求，请参阅 `SettingValue`。必须对指定的资源 `settingValue` 具有以下 IAM 权限才能进行授权： `resourcesettings.settingvalues.create`

setting_value

SettingValue

要创建的设置值。如需了解字段要求，请参阅 SettingValue。

必须对指定的资源 settingValue 具有以下 IAM 权限才能进行授权：

resourcesettings.settingvalues.create

DeleteSettingValueRequest

针对 DeleteSettingValue 的请求。

字段

字段
`name`	`string` 要删除的设置值的名称。如需了解命名要求，请参阅 `SettingValue`。必须对指定的资源 `name` 具有以下 IAM 权限才能进行授权： `resourcesettings.settingvalues.delete`
`ignore_read_only`	`bool` 一个标志，用于允许删除 `read_only` 设置的值。警告：使用时需自行承担风险。删除只读设置的值是不可逆的操作（即无法再次创建）。

name

string

要删除的设置值的名称。如需了解命名要求，请参阅 SettingValue。

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

resourcesettings.settingvalues.delete

ignore_read_only

bool

一个标志，用于允许删除 read_only 设置的值。警告：使用时需自行承担风险。删除只读设置的值是不可逆的操作（即无法再次创建）。

GetSettingValueRequest

针对 GetSettingValue 的请求。

字段

字段
`name`	`string` 要获取的设置值的名称。如需了解命名要求，请参阅 `SettingValue`。必须对指定的资源 `name` 具有以下 IAM 权限才能进行授权： `resourcesettings.settingvalues.get`

name

string

要获取的设置值的名称。如需了解命名要求，请参阅 SettingValue。

必须对指定的资源 name 具有以下 IAM 权限才能进行授权：

resourcesettings.settingvalues.get

ListSettingsRequest

针对 ListSettings 的请求。

字段

字段
`parent`	`string` 设置的父 Cloud 资源。必须采用以下形式之一： `projects/{project_number}` `projects/{project_id}` `folders/{folder_id}` `organizations/{organization_id}` 必须对指定的资源 `parent` 具有以下 IAM 权限才能进行授权： `resourcesettings.settings.list`
`page_size`	`int32` 未使用。要返回的页面大小。
`page_token`	`string` 未使用。用于检索下一页的分页令牌。

parent

string

设置的父 Cloud 资源。必须采用以下形式之一：

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

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权：

resourcesettings.settings.list

page_size

int32

未使用。要返回的页面大小。

page_token

string

未使用。用于检索下一页的分页令牌。

ListSettingsResponse

来自 ListSettings 的响应。

字段

字段
`settings[]`	`Setting` 指定 Cloud 资源中可用的设置列表。
`next_page_token`	`string` 未使用。用于检索下一页的分页令牌。

settings[]

Setting

指定 Cloud 资源中可用的设置列表。

next_page_token

string

未使用。用于检索下一页的分页令牌。

LookupEffectiveSettingValueRequest

针对 LookupEffectiveSettingValue 的请求。

字段

字段
`parent`	`string` 要评估有效值的设置。如需了解命名要求，请参阅 `Setting`。必须对指定的资源 `parent` 具有以下 IAM 权限才能进行授权： `resourcesettings.settingvalues.get`

parent

string

要评估有效值的设置。如需了解命名要求，请参阅 Setting。

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权：

resourcesettings.settingvalues.get

SearchSettingValuesRequest

对 SearchSettingValues 的请求。

字段

字段
`parent`	`string` 设置的父 Cloud 资源。必须采用以下形式之一： `projects/{project_number}` `projects/{project_id}` `folders/{folder_id}` `organizations/{organization_id}` 必须对指定的资源 `parent` 具有以下 IAM 权限才能进行授权： `resourcesettings.settingvalues.list`
`page_size`	`int32` 未使用。要返回的页面大小。
`page_token`	`string` 未使用。用于检索下一页的分页令牌。

parent

string

设置的父 Cloud 资源。必须采用以下形式之一：

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

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权：

resourcesettings.settingvalues.list

page_size

int32

未使用。要返回的页面大小。

page_token

string

未使用。用于检索下一页的分页令牌。

SearchSettingValuesResponse

来自 SearchSettingValues 的响应。

字段

字段
`setting_values[]`	`SettingValue` 指定 Cloud 资源上存在的所有设置值。
`next_page_token`	`string` 未使用。用于检索下一页的分页令牌。

setting_values[]

SettingValue

指定 Cloud 资源上存在的所有设置值。

next_page_token

string

未使用。用于检索下一页的分页令牌。

设置

用于设置值的架构。在给定的 Cloud 资源中，一个设置最多只能有一个父级设置值。

字段
`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` 一个标志，用于指示相应设置的值无法修改（如需了解更新和原因，请参阅具体设置的文档）；不过，如果 `DeleteSettingValueRequest.ignore_read_only` 设置为 true，则可以使用 `DeleteSettingValue` 将其删除。使用此标志即表示确认无法重新创建相应设置值。如需了解详情，请参阅 `DeleteSettingValueRequest.ignore_read_only`。
`data_type`	`DataType` 相应设置的数据类型。
`default_value`	`Value` 如果未明确设置任何设置值，`LookupEffectiveSettingValue` 收到的值。注意：并非所有设置都有默认值。

DataType

相应设置的值的数据类型。如需详细了解可用的数据类型，请参阅 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` 仅限输出。一个标志，用于指示相应设置值无法修改；不过，如果 `DeleteSettingValueRequest.ignore_read_only` 设置为 true，则可以使用 `DeleteSettingValue` 将其删除。使用此标志即表示确认无法重新创建相应设置值。此标志继承自其父级设置，旨在提供便利。如需了解详情，请参阅 `Setting.read_only`。
`update_time`	`Timestamp` 仅限输出。时间戳，用于指示上次更新设置值的时间。

UpdateSettingValueRequest

针对 UpdateSettingValue 的请求。

字段

字段
`setting_value`	`SettingValue` 要更新的设置值。如需了解字段要求，请参阅 `SettingValue`。必须对指定的资源 `settingValue` 具有以下 IAM 权限才能进行授权： `resourcesettings.settingvalues.update`

setting_value

SettingValue

要更新的设置值。如需了解字段要求，请参阅 SettingValue。

必须对指定的资源 settingValue 具有以下 IAM 权限才能进行授权：

resourcesettings.settingvalues.update

值

设置值中的数据。

字段
联合字段 `value`。选择数据类型和关联的值。`value` 只能是下列其中一项：
`boolean_value`	`bool` 将此值定义为布尔值。
`string_value`	`string` 将此值定义为字符串值。
`string_set_value`	`StringSet` 将此值定义为 StringSet。

StringSet

一种字符串集值，可包含一组字符串。每个字符串的长度上限为 60 个字符，字符串集中最多可以包含 50 个字符串。

字段

字段
`values[]`	`string` 集合中的字符串

values[]

string

集合中的字符串

Package google.cloud.resourcesettings.v1alpha1 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

索引

ResourceSettingsService

CreateSettingValueRequest

DeleteSettingValueRequest

GetSettingValueRequest

ListSettingsRequest

ListSettingsResponse

LookupEffectiveSettingValueRequest

SearchSettingValuesRequest

SearchSettingValuesResponse

设置

DataType

SettingValue

UpdateSettingValueRequest

值

StringSet

Package google.cloud.resourcesettings.v1alpha1