REST Resource: organizations.settings

リソース: 設定

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

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 が受け取る値。

注: すべての設定にデフォルト値があるわけではありません。

Methods

deleteValue

 設定値を削除します。

getValue

 設定値を取得します。

list

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

lookupEffectiveValue

 Cloud リソース parent の設定の有効な設定値を計算します。
リソース parent に存在するすべての設定値を検索します。

updateValue

 設定値を更新します。