REST Resource: projects.settings

资源:Setting

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

JSON 表示法
{
  "name": string,
  "displayName": string,
  "description": string,
  "readOnly": boolean,
  "dataType": enum (DataType),
  "defaultValue": {
    object (Value)
  }
}
字段
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”

displayName

string

相应设置的人类可读名称。

description

string

此设置的详细说明。

readOnly

boolean

一个标志,用于指示相应设置的值无法修改(如需了解更新和原因,请参阅具体设置的文档);不过,如果 DeleteSettingValueRequest.ignore_read_only 设置为 true,则可以使用 settings.deleteValue 将其删除。使用此标志即表示确认无法重新创建相应设置值。如需了解详情,请参阅 DeleteSettingValueRequest.ignore_read_only

dataType

enum (DataType)

相应设置的数据类型。

defaultValue

object (Value)

如果未明确设置任何设置值,settings.lookupEffectiveValue 收到的值。

注意:并非所有设置都有默认值。

方法

deleteValue

删除设置值。

getValue

获取设置值。

list

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

lookupEffectiveValue

计算云资源 parent 中设置的有效设置值。
搜索资源 parent 上存在的所有设置值。

updateValue

更新设置值。