REST Resource: folders.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 收到的值。

注意：並非所有設定都有預設值。

DataType

這項設定值的資料類型。如要進一步瞭解可用的資料類型，請參閱 Value。

列舉
DATA_TYPE_UNSPECIFIED 未指定資料類型。
BOOLEAN 布林值設定。
STRING 字串設定。
STRING_SET 字串集設定。

方法

deleteValue

 刪除設定值。

getValue

 取得設定值。

list

 列出 Cloud 資源 parent 的所有可用設定。

lookupEffectiveValue

 計算 Cloud 資源 parent 中設定的有效設定值。
搜尋資源 parent 上的所有設定值。

updateValue

 更新設定值。