REST Resource: folders.settings

Ressource: Einstellung

Das Schema zum Festlegen von Werten. Bei einer bestimmten Cloud-Ressource kann einer Einstellung höchstens ein Einstellungswert übergeordnet sein.

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

string

Der Ressourcenname der Einstellung. Sie müssen in einem der folgenden Formate vorliegen:

  • 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 menschenlesbare Name für diese Einstellung.
description

string

Eine ausführliche Beschreibung der Funktion dieser Einstellung.
readOnly

boolean

Ein Flag, das angibt, dass die Werte dieser Einstellung nicht geändert werden können. Informationen zu Aktualisierungen und Gründen finden Sie in der Dokumentation der jeweiligen Einstellung. 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 Einstellungswert 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 alle Einstellungen haben einen Standardwert.

DataType

Der Datentyp zum Festlegen von Werten für diese Einstellung. Weitere Informationen zu den verfügbaren Datentypen finden Sie unter Value.

Enums
DATA_TYPE_UNSPECIFIED Nicht angegebener Datentyp.
BOOLEAN Boolesche Einstellung.
STRING Eine Stringeinstellung.
STRING_SET Ein Stringsatz.

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 in der Cloud-Ressource parent.
Sucht nach allen Einstellungswerten, die für die Ressource parent vorhanden sind.

updateValue

 Aktualisiert einen Einstellungswert.