本頁面由 Cloud Translation API 翻譯而成。

Package google.cloud.resourcesettings.v1alpha1

索引

ResourceSettingsService (介面)
CreateSettingValueRequest (訊息)
DeleteSettingValueRequest (訊息)
GetSettingValueRequest (訊息)
ListSettingsRequest (訊息)
ListSettingsResponse (訊息)
LookupEffectiveSettingValueRequest (訊息)
SearchSettingValuesRequest (訊息)
SearchSettingValuesResponse (訊息)
Setting (訊息)
Setting.DataType (列舉)
SettingValue (訊息)
UpdateSettingValueRequest (訊息)
Value (訊息)
Value.StringSet (訊息)

ResourceSettingsService

這個介面可讓您在整個資源階層中，與資源設定和設定值互動。

服務可能會向使用者顯示多項設定，讓他們控管資源的行為。系統會以階層方式評估套用至特定 Cloud 資源的值，且該資源的所有子項都會沿用這些值。

如果 IAM 檢查失敗，或 parent 資源不在 Cloud Organization 中，則所有要求都會傳回 google.rpc.Status 和 google.rpc.Code.PERMISSION_DENIED。如果要求格式錯誤，所有要求都會傳回含有 google.rpc.Code.INVALID_ARGUMENT 的 google.rpc.Status。

注意：對於所有 Alpha 版設定，如果 Cloud Organizations 中的資源不在 Alpha 版中，則該資源底下不會有任何設定。

CreateSettingValue

CreateSettingValue
`rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)` 建立設定值。如果設定不存在，則傳回含有 `google.rpc.Code.NOT_FOUND` 的 `google.rpc.Status`。如果指定 Cloud 資源上已有設定值，則傳回 `google.rpc.Status` (含 `google.rpc.Code.ALREADY_EXISTS`)。如果設定標示為唯讀，則傳回含有 `google.rpc.Code.FAILED_PRECONDITION` 的 `google.rpc.Status`。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

建立設定值。

如果設定不存在，則傳回含有 google.rpc.Code.NOT_FOUND 的 google.rpc.Status。如果指定 Cloud 資源上已有設定值，則傳回 google.rpc.Status (含 google.rpc.Code.ALREADY_EXISTS)。如果設定標示為唯讀，則傳回含有 google.rpc.Code.FAILED_PRECONDITION 的 google.rpc.Status。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

DeleteSettingValue

DeleteSettingValue
`rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)` 刪除設定值。如果設定值不存在，這項作業就不會執行任何動作。如果設定或設定值不存在，則傳回 `google.rpc.Status` (含 `google.rpc.Code.NOT_FOUND`)。如果先前對設定值的 `DeleteSetting` 呼叫已傳回成功代碼，則設定值不存在。如果設定標示為唯讀，則傳回含有 `google.rpc.Code.FAILED_PRECONDITION` 的 `google.rpc.Status`。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)

刪除設定值。如果設定值不存在，這項作業就不會執行任何動作。

如果設定或設定值不存在，則傳回 google.rpc.Status (含 google.rpc.Code.NOT_FOUND)。如果先前對設定值的 DeleteSetting 呼叫已傳回成功代碼，則設定值不存在。如果設定標示為唯讀，則傳回含有 google.rpc.Code.FAILED_PRECONDITION 的 google.rpc.Status。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

GetSettingValue

GetSettingValue
`rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)` 取得設定值。如果設定值不存在，則傳回 `google.rpc.Status` (含 `google.rpc.Code.NOT_FOUND`)。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

取得設定值。

如果設定值不存在，則傳回 google.rpc.Status (含 google.rpc.Code.NOT_FOUND)。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

ListSettings

ListSettings
`rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)` 列出 Cloud 資源 `parent` 的所有可用設定。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

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

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

LookupEffectiveSettingValue

LookupEffectiveSettingValue
`rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)` 計算 Cloud 資源 `parent` 中設定的有效設定值。有效設定值是 Cloud 資源的計算設定值，並依下列順序評估其中一個選項 (如果前一個選項不存在，則使用下一個選項)：指定資源的設定值指定資源最接近的祖項設定值設定的預設值空白設定值，定義為所有欄位都未設定的 `SettingValue` 如果設定不存在，則傳回含有 `google.rpc.Code.NOT_FOUND` 的 `google.rpc.Status`。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

計算 Cloud 資源 parent 中設定的有效設定值。有效設定值是 Cloud 資源的計算設定值，並依下列順序評估其中一個選項 (如果前一個選項不存在，則使用下一個選項)：

指定資源的設定值
指定資源最接近的祖項設定值
設定的預設值
空白設定值，定義為所有欄位都未設定的 SettingValue

如果設定不存在，則傳回含有 google.rpc.Code.NOT_FOUND 的 google.rpc.Status。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

SearchSettingValues

SearchSettingValues
`rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)` 搜尋資源 `parent` 上的所有設定值。設定值不限於特定設定的值。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

搜尋資源 parent 上的所有設定值。設定值不限於特定設定的值。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證總覽一文。

UpdateSettingValue

UpdateSettingValue
`rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)` 更新設定值。如果設定或設定值不存在，則傳回 `google.rpc.Status` (含 `google.rpc.Code.NOT_FOUND`)。如果設定標示為唯讀，則會傳回含 `google.rpc.Status` 的 `google.rpc.Status`。`google.rpc.Code.FAILED_PRECONDITION`如果要求中提供的 ETag 與設定值的持續性 ETag 不符，則會傳回含有 `google.rpc.Code.ABORTED` 的 `google.rpc.Status`。注意：提供的設定值會完整覆寫所有欄位。授權範圍需要下列 OAuth 範圍： `https://www.googleapis.com/auth/cloud-platform` 詳情請參閱驗證總覽一文。

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)

更新設定值。

如果設定或設定值不存在，則傳回 google.rpc.Status (含 google.rpc.Code.NOT_FOUND)。如果設定標示為唯讀，則會傳回含 google.rpc.Status 的 google.rpc.Status。google.rpc.Code.FAILED_PRECONDITION如果要求中提供的 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`

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` 設定的值。警告：請自行承擔使用風險。刪除唯讀設定的值是無法復原的操作 (即無法再次建立)。

name

string

要刪除的設定值名稱。請參閱SettingValue瞭解命名規定。

授權需要指定資源 name 的下列 IAM 權限：

resourcesettings.settingvalues.delete

ignore_read_only

bool

這個旗標可刪除 read_only 設定的值。警告：請自行承擔使用風險。刪除唯讀設定的值是無法復原的操作 (即無法再次建立)。

GetSettingValueRequest

GetSettingValue 的要求。

欄位

欄位
`name`	`string` 要取得的設定值名稱。請參閱`SettingValue`瞭解命名規定。授權需要指定資源 `name` 的下列 IAM 權限： `resourcesettings.settingvalues.get`

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` 未使用。用於擷取下一頁的頁面符記。

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` 未使用。用於擷取下一頁的頁面符記。

settings[]

Setting

指定 Cloud 資源可用的設定清單。

next_page_token

string

未使用。用於擷取下一頁的頁面符記。

LookupEffectiveSettingValueRequest

LookupEffectiveSettingValue 的要求。

欄位

欄位
`parent`	`string` 系統會評估此設定的有效值。請參閱`Setting`瞭解命名規定。授權需要指定資源 `parent` 的下列 IAM 權限： `resourcesettings.settingvalues.get`

parent

string

系統會評估此設定的有效值。請參閱Setting瞭解命名規定。

授權需要指定資源 parent 的下列 IAM 權限：

resourcesettings.settingvalues.get

SearchSettingValuesRequest

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` 未使用。用於擷取下一頁的頁面符記。

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` 未使用。用於擷取下一頁的頁面符記。

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`	字串集設定。

SettingValue

設定的例項。每個設定值都會以對應的設定做為父項。

欄位
`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`

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` 集合中的字串

values[]

string

集合中的字串

Package google.cloud.resourcesettings.v1alpha1 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

索引

ResourceSettingsService

CreateSettingValueRequest

DeleteSettingValueRequest

GetSettingValueRequest

ListSettingsRequest

ListSettingsResponse

LookupEffectiveSettingValueRequest

SearchSettingValuesRequest

SearchSettingValuesResponse

設定

DataType

SettingValue

UpdateSettingValueRequest

值

StringSet

Package google.cloud.resourcesettings.v1alpha1