REST Resource: organizations.settings

資源：設定

用於設定值的結構定義。在特定 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

 更新設定值。