Package google.cloud.resourcesettings.v1alpha1

索引

ResourceSettingsService

用于在整个资源层次结构中与资源设置交互以及设置值的接口。

服务可能会向用户显示多种设置，用于控制资源的行为。应用于给定 Cloud 资源的设置值分层评估，并且该资源的所有后代都会继承该值。

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

注意：对于所有 Alpha 版阶段的设置，如果 Alpha 版 Cloud 组织的资源不是 Alpha 版，则“设置”下不会有任何设置。

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

如需了解详情，请参阅身份验证概览。
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

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

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

获取设置值。

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

授权范围

需要以下 OAuth 范围：

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

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

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

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

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅身份验证概览。
查询有效设置值

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

计算 Cloud 资源 parent 中某项设置的有效设置值。有效设置值是计算出的 Cloud 资源设置值，其求得的值为给定顺序中的以下选项之一（如果前一个选项不存在，则使用下一个选项）：

  1. 指定资源的设置值
  2. 指定资源的最近祖先实体上的设置值
  3. 设置的默认值
  4. 空设置值，定义为未设置所有字段的 SettingValue

如果设置不存在，则返回具有 google.rpc.Code.NOT_FOUND 的 google.rpc.Status。

授权范围

需要以下 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.Code.NOT_FOUND 的 google.rpc.Status。如果相应设置被标记为只读，则返回具有 google.rpc.Code.FAILED_PRECONDITION 的 google.rpc.Status。如果请求中提供的 etag 与设置值的保留 etag 不匹配，则返回带有 google.rpc.Code.ABORTED 的 google.rpc.Status。

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

授权范围

需要以下 OAuth 范围：

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

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

CreateSettingValueRequest

CreateSettingValue 的请求。

字段
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 设置值的标志。警告：使用时应自行承担风险。删除只读设置的值是不可逆转的操作（即无法再重新创建）。

GetSettingValueRequest

GetSettingValue 的请求。

字段
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

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

ListSettingsResponse

ListSettings 的响应。

字段
settings[]

Setting

适用于指定 Cloud 资源的设置列表。
next_page_token

string

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

LookupEffectiveSettingValueRequest

针对 LookupEffectiveSettingValue 的请求。

字段
parent

string

将为哪个值评估有效值。如需了解命名要求，请参阅 Setting。

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

  • resourcesettings.settingvalues.get

SearchSettingValues 请求

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

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

SearchSettingValuesResponse

SearchSettingValues 的响应。

字段
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 字符串集设置。

设置值

设置的实例化。每个设置值都由相应的设置构成。

字段
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

值

设置值中的数据。

字段
联合字段 value。选择数据类型和关联的值。value 只能是下列其中一项：
boolean_value

bool

将此值定义为布尔值。
string_value

string

将此值定义为字符串值。
string_set_value

StringSet

将此值定义为 StringSet。

StringSet

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

字段
values[]

string

集中的字符串