Package google.cloud.resourcesettings.v1alpha1

インデックス

ResourceSettingsService

リソース階層全体でリソース設定と設定値を操作するためのインターフェース。

サービスでは、ユーザーがリソースの動作を制御するための設定が多数表示されることがあります。特定のリソースに適用された設定値は階層的に評価され、そのリソースのすべての子孫に継承されます。

すべてのリクエストについて、IAM チェックが失敗した場合、または parent リソースが Cloud 組織にない場合は、google.rpc.Code.PERMISSION_DENIED を含む google.rpc.Status を返します。すべてのリクエストについて、リクエストの形式が正しくない場合は google.rpc.Code.INVALID_ARGUMENT を含む google.rpc.Status を返します。

注: すべてのアルファ版の設定について、アルファ版以外の Cloud Organizations のリソースには設定が存在しません。

CreateSettingValue

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

詳細については、認証の概要をご覧ください。
DeleteSettingValue

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)

設定値を削除します。設定値が存在しない場合、オペレーションは no-op になります。

設定または設定値が存在しない場合は、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

詳細については、認証の概要をご覧ください。
GetSettingValue

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

設定値を取得します。

設定値が存在しない場合は、google.rpc.Code.NOT_FOUND を含む google.rpc.Status を返します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。
ListSettings

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

Cloud リソース parent で使用可能なすべての設定を一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。
LookupEffectiveSettingValue

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

Cloud リソース parent の設定の有効な設定値を計算します。有効な設定値は、Cloud リソースで計算された設定値であり、次のオプションのいずれかに指定された順序で評価されます（前のオプションが存在しない場合は、次のオプションが使用されます）。

  1. 指定されたリソースの設定値
  2. 指定されたリソースの最も近い祖先の設定値
  3. 設定のデフォルト値
  4. 空の設定値。すべてのフィールドが設定されていない SettingValue として定義されます。

設定が存在しない場合は、google.rpc.Code.NOT_FOUND を含む google.rpc.Status を返します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。
SearchSettingValues

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

リソース parent に存在するすべての設定値を検索します。設定値は特定の設定の値に限定されません。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。
UpdateSettingValue

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.Code.ABORTED を含む google.rpc.Status を返します。

注: 指定された設定値は、すべてのフィールドを完全に上書きします。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

CreateSettingValueRequest

CreateSettingValue のリクエスト。

フィールド
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 設定の値を削除できるフラグ。警告: ご自身の責任で使用してください。読み取り専用設定の値を削除すると、元に戻すことはできません（つまり、再度作成することはできません）。

GetSettingValueRequest

GetSettingValue のリクエスト。

フィールド
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

未使用。次のページを取得するために使用されるページトークン。

ListSettingsResponse

ListSettings からのレスポンス。

フィールド
settings[]

Setting

指定された Cloud リソースで使用可能な設定のリスト。
next_page_token

string

未使用。次のページを取得するために使用されるページトークン。

LookupEffectiveSettingValueRequest

LookupEffectiveSettingValue のリクエスト。

フィールド
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

未使用。次のページを取得するために使用されるページトークン。

SearchSettingValuesResponse

SearchSettingValues からのレスポンス。

フィールド
setting_values[]

SettingValue

指定された Cloud リソースに存在するすべての設定値。
next_page_token

string

未使用。次のページを取得するために使用されるページトークン。

設定

値を設定するためのスキーマ。特定のリソースでは、設定は最大 1 つの設定値を親にできます。

フィールド
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

値

設定値のデータ。

フィールド
共用体フィールド value。データ型と関連する値を選択します。value は次のいずれかになります。
boolean_value

bool

この値をブール値として定義します。
string_value

string

この値を文字列値として定義します。
string_set_value

StringSet

この値を StringSet として定義します。

StringSet

文字列のセットを保持できる文字列セット値。各文字列の最大長は 60 文字で、文字列セットには最大 50 個の文字列を含めることができます。

フィールド
values[]

string

セット内の文字列