REST Resource: projects.settings

Ressource: Einstellung

Das Schema zum Festlegen von Werten. Für eine bestimmte Cloud-Ressource kann eine Einstellung maximal einen Einstellungswert als übergeordnetes Element haben.

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "description": string,
  "readOnly": boolean,
  "dataType": enum (DataType),
  "defaultValue": {
    object (Value)
  }
}
Felder
name

string

Der Ressourcenname der Einstellung. Muss eines der folgenden Formate haben:

  • projects/{project_number}/settings/{setting_name}
  • folders/{folder_id}/settings/{setting_name}
  • organizations/{organization_id}/settings/{setting_name}

Beispiel: „/projects/123/settings/gcp-enableMyFeature“
displayName

string

Der für Menschen lesbare Name dieser Einstellung.
description

string

Eine detaillierte Beschreibung der Funktion dieser Einstellung.
readOnly

boolean

Ein Flag, das angibt, dass die Werte dieser Einstellung nicht geändert werden können (siehe Dokumentation der jeweiligen Einstellung für Updates und Gründe). Sie kann jedoch mit settings.deleteValue gelöscht werden, wenn DeleteSettingValueRequest.ignore_read_only auf „true“ gesetzt ist. Die Verwendung dieses Flags gilt als Bestätigung, dass der Einstellungs-Wert nicht neu erstellt werden kann. Weitere Informationen finden Sie unter DeleteSettingValueRequest.ignore_read_only.
dataType

enum (DataType)

Der Datentyp für diese Einstellung.
defaultValue

object (Value)

Der Wert, der von settings.lookupEffectiveValue empfangen wird, wenn kein Einstellungswert explizit festgelegt ist.

Hinweis: Nicht für alle Einstellungen ist ein Standardwert festgelegt.

Methoden

deleteValue

 Löscht einen Einstellungswert.

getValue

 Ruft einen Einstellungswert ab.

list

 Listet alle Einstellungen auf, die für die Cloud-Ressource parent verfügbar sind.

lookupEffectiveValue

 Berechnet den effektiven Einstellungswert einer Einstellung für die Cloud-Ressource parent.
Sucht nach allen Einstellungswerten, die für die Ressource parent vorhanden sind.

updateValue

 Aktualisiert einen Einstellungswert.