Package google.cloud.resourcesettings.v1alpha1

索引

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

資源設定服務

介面可以與資源設定互動，並設定整個資源階層的值。

服務可能會顯示一些設定，讓使用者可控制資源的行為。特定 Cloud 資源套用的設定值會以階層式方式進行評估，並由該資源的所有子系繼承。

如果身分與存取權管理要求失敗，傳回 google.rpc.Status google.rpc.Code.PERMISSION_DENIED，如果身分與存取權管理檢查失敗，或是 parent 資源不在 Cloud 機構內。針對所有要求，如果要求格式錯誤，則傳回包含 google.rpc.Code.INVALID_ARGUMENT 的 google.rpc.Status。

注意：在 Alpha 測試階段的所有「設定」中，不在 Cloud Alpha 版資源中的任何資源下，「設定」均不存在。

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

刪除設定值
rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty) 刪除設定值。如果沒有設定值，則作業即為免人工管理。 如果設定或設定不存在，會傳回 google.rpc.Code.NOT_FOUND 的 google.rpc.Status。如果先前針對設定值發出的 DeleteSetting 呼叫已傳回成功代碼，這個設定值就不會顯示。如果設定標記為唯讀，會傳回含有 google.rpc.Code.FAILED_PRECONDITION 的 google.rpc.Status。 授權範圍 需要下列 OAuth 範圍： https://www.googleapis.com/auth/cloud-platform 詳情請參閱驗證總覽。

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

清單設定
rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse) 列出 Cloud 資源 parent 中所有可用設定。 授權範圍 需要下列 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 詳情請參閱驗證總覽。

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

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

建立設定值要求

CreateSettingValue 要求。

欄位
setting_value	SettingValue 要建立的設定值。如要瞭解欄位需求，請參閱 SettingValue。 授權需要指定資源 settingValue 的下列 IAM 權限： resourcesettings.settingvalues.create

刪除設定值要求

DeleteSettingValue 要求。

欄位
name	string 要刪除的設定值名稱。如要瞭解命名規定，請參閱 SettingValue。 授權需要指定資源 name 的下列 IAM 權限： resourcesettings.settingvalues.delete
ignore_read_only	bool 允許刪除 read_only 設定值的旗標。警告：您必須自行承擔使用風險。唯讀唯讀設定的值一經刪除即無法復原 (亦即無法再次建立)。

取得設定值要求

GetSettingValue 要求。

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

ListSettingsRequest

ListSettings 的要求。

欄位
parent	string 父項設定的父項資源。必須採用下列其中一種格式： 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 未使用。用來擷取下一頁的網頁憑證。

查詢有效設定值要求

針對 QueryeffectiveSettingValue 的要求。

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

搜尋設定值要求

SearchSettingValues 要求。

欄位
parent	string 父項設定的父項資源。必須採用下列其中一種格式： projects/{project_number} projects/{project_id} folders/{folder_id} organizations/{organization_id} 授權需要指定資源 parent 的下列 IAM 權限： resourcesettings.settingvalues.list
page_size	int32 未使用。要傳回的網頁大小。
page_token	string 未使用。用來擷取下一頁的網頁憑證。

搜尋設定值回應

SearchSettingValues 的回應。

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

設定值

設定執行個體化。每個設定值都會沿用相應的設定。

欄位
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 僅供輸出。表示設定值上次更新時間的時間戳記。

更新設定值要求

UpdateSettingValue 的要求。

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