REST Resource: organizations.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

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

lookupEffectiveValue

 计算 Cloud 资源 parent 中某项设置的有效设置值。
搜索资源 parent 中存在的所有设置值。

updateValue

 更新设置值。