Package google.cloud.resourcesettings.v1alpha1

Index

Service für Ressourceneinstellungen

Eine Schnittstelle zur Interaktion mit Ressourceneinstellungen und Werten in der Ressourcenhierarchie.

Dienste können eine Reihe von Einstellungen anzeigen, mit denen Nutzer das Verhalten ihrer Ressourcen steuern können. Einstellungswerte, die auf eine bestimmte Cloud-Ressource angewendet werden, werden hierarchisch ausgewertet und von allen untergeordneten Elementen dieser Ressource übernommen.

Bei allen Anfragen wird google.rpc.Status mit google.rpc.Code.PERMISSION_DENIED zurückgegeben, wenn die IAM-Prüfung fehlschlägt oder sich die parent-Ressource nicht in einer Cloud-Organisation befindet. Gibt für alle Anfragen einen google.rpc.Status mit google.rpc.Code.INVALID_ARGUMENT zurück, wenn die Anfrage fehlerhaft ist.

Hinweis: Für alle Einstellungen der Alphaphase ist die Einstellung unter Ressourcen in Cloud-Organisationen nicht vorhanden, die sich nicht in der Alphaphase befinden.

Wert für „CreateSetting“

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

Erstellt einen Einstellungswert.

Gibt google.rpc.Status mit google.rpc.Code.NOT_FOUND zurück, wenn die Einstellung nicht vorhanden ist. Gibt google.rpc.Status mit google.rpc.Code.ALREADY_EXISTS zurück, wenn der Einstellungswert bereits in der angegebenen Cloud-Ressource vorhanden ist. Gibt ein google.rpc.Status mit google.rpc.Code.FAILED_PRECONDITION zurück, wenn die Einstellung schreibgeschützt ist.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
Einstellung löschen

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)

Löscht einen Einstellungswert. Wenn der Einstellungswert nicht vorhanden ist, ist der Vorgang ein Nullbefehl.

Gibt google.rpc.Status mit google.rpc.Code.NOT_FOUND zurück, wenn die Einstellung oder der Einstellungswert nicht vorhanden ist. Der Einstellungswert ist nicht vorhanden, wenn ein vorheriger Aufruf von DeleteSetting für den Einstellungswert bereits einen Erfolgscode zurückgegeben hat. Gibt ein google.rpc.Status mit google.rpc.Code.FAILED_PRECONDITION zurück, wenn die Einstellung schreibgeschützt ist.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
GetSettingValue

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

Ruft einen Einstellungswert ab.

Gibt google.rpc.Status mit google.rpc.Code.NOT_FOUND zurück, wenn der Einstellungswert nicht vorhanden ist.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
Listeneinstellungen

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

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

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
LookupEffectiveSettingValue

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

Berechnet den effektiven Einstellungswert einer Einstellung in der Cloud-Ressource parent. Der Wert der effektiven Einstellung ist der berechnete Einstellungswert einer Cloudressource und wird mit einer der folgenden Optionen in der angegebenen Reihenfolge ausgewertet (die nächste Option wird verwendet, wenn die vorherige nicht vorhanden ist):

  1. den Einstellungswert für die angegebene Ressource
  2. den Einstellungswert für den nächstgelegenen Ancestor der Ressource
  3. Standardwert der Einstellung
  4. Ein leerer Einstellungswert, definiert als SettingValue, wobei alle Felder nicht festgelegt sind

Gibt google.rpc.Status mit google.rpc.Code.NOT_FOUND zurück, wenn die Einstellung nicht vorhanden ist.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
Werte für Sucheinstellungen

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

Sucht nach allen Einstellungswerten, die für die Ressource parent vorhanden sind. Die Einstellungswerte sind nicht auf die einer bestimmten Einstellung beschränkt.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
Einstellung aktualisieren

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)

Aktualisiert einen Einstellungswert.

Gibt google.rpc.Status mit google.rpc.Code.NOT_FOUND zurück, wenn die Einstellung oder der Einstellungswert nicht vorhanden ist. Gibt ein google.rpc.Status mit google.rpc.Code.FAILED_PRECONDITION zurück, wenn die Einstellung schreibgeschützt ist. Gibt ein google.rpc.Status mit google.rpc.Code.ABORTED zurück, wenn das in der Anfrage angegebene ETag nicht mit dem persistenten ETag des Einstellungswerts übereinstimmt.

Hinweis: Mit dem angegebenen Einstellungswert werden alle Felder vollständig überschrieben.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

Anforderungseinstellung erstellen

Die Anfrage für CreateSettingValue.

Felder
setting_value

SettingValue

Der zu erstellende Einstellungswert Informationen zu den Feldanforderungen finden Sie unter SettingValue.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource settingValue erforderlich:

  • resourcesettings.settingvalues.create

Anfrage zum Löschen der Einstellung

Die Anfrage für „DeleteSettingValue“.

Felder
name

string

Der Name des zu löschenden Einstellungswerts. Informationen zu Benennungsanforderungen finden Sie unter SettingValue.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • resourcesettings.settingvalues.delete
ignore_read_only

bool

Ein Flag, das das Löschen des Werts einer read_only-Einstellung zulässt. WARNUNG: Die Nutzung erfolgt auf eigenes Risiko. Das Löschen des Werts einer schreibgeschützten Einstellung kann nicht rückgängig gemacht werden.

GetSettingValueRequest

Die Anfrage für GetSettingValue.

Felder
name

string

Der Name des abzurufenden Einstellungswerts. Informationen zu Benennungsanforderungen finden Sie unter SettingValue.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • resourcesettings.settingvalues.get

Anfrage zu Listeneinstellungen

Die Anfrage für ListSettings.

Felder
parent

string

Die Cloud-Ressource, die die Einstellung übergibt. Sie müssen in einem der folgenden Formate vorliegen:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • resourcesettings.settings.list
page_size

int32

nicht in Verwendung. Die Größe der zurückzugebenden Seite.
page_token

string

nicht in Verwendung. Ein Seitentoken, das zum Abrufen der nächsten Seite verwendet wird.

ListSettingsResponse

Die Antwort von ListSettings.

Felder
settings[]

Setting

Eine Liste der Einstellungen, die in der angegebenen Cloud-Ressource verfügbar sind.
next_page_token

string

nicht in Verwendung. Ein Seitentoken, das zum Abrufen der nächsten Seite verwendet wird.

LookupEffectiveSettingValueRequest

Die Anfrage für „LookupEffectiveSettingValue“.

Felder
parent

string

Die Einstellung, für die ein effektiver Wert ausgewertet wird. Informationen zu Benennungsanforderungen finden Sie unter Setting.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • resourcesettings.settingvalues.get

SucheinstellungswerteAnfrage

Die Anfrage für „SearchSettingValues“.

Felder
parent

string

Die Cloud-Ressource, die die Einstellung übergibt. Sie müssen in einem der folgenden Formate vorliegen:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • resourcesettings.settingvalues.list
page_size

int32

nicht in Verwendung. Die Größe der zurückzugebenden Seite.
page_token

string

nicht in Verwendung. Ein Seitentoken, das zum Abrufen der nächsten Seite verwendet wird.

SucheinstellungWerteAntwort

Die Antwort von SearchSettingValues.

Felder
setting_values[]

SettingValue

Alle Einstellungswerte, die in der angegebenen Cloud-Ressource vorhanden sind.
next_page_token

string

nicht in Verwendung. Ein Seitentoken, das zum Abrufen der nächsten Seite verwendet wird.

Einstellung

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

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“
display_name

string

Der menschenlesbare Name für diese Einstellung.
description

string

Eine ausführliche Beschreibung der Funktion dieser Einstellung.
read_only

bool

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 DeleteSettingValue 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.
data_type

DataType

Der Datentyp für diese Einstellung.
default_value

Value

Der Wert, der von LookupEffectiveSettingValue 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.

Einstellungswert

Die Instanziierung einer Einstellung. Jeder Einstellungswert ist der entsprechenden Einstellung übergeordnet.

Felder
name

string

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

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

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

Value

Der Wert der Einstellung. Der Datentyp von Value muss immer mit dem Datentyp übereinstimmen, der von der übergeordneten Einstellung definiert wird.
etag

string

Ein Fingerabdruck für optimistische Nebenläufigkeit Unter UpdateSettingValue finden Sie weitere Informationen.
read_only

bool

Nur Ausgabe. Ein Flag, das angibt, dass dieser Einstellungswert nicht geändert werden kann. Er kann jedoch mit DeleteSettingValue 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. Dieses Flag wurde aus der übergeordneten Einstellung übernommen und dient der Übersichtlichkeit. Weitere Informationen finden Sie unter Setting.read_only.
update_time

Timestamp

Nur Ausgabe. Der Zeitstempel, der angibt, wann der Einstellungswert zuletzt aktualisiert wurde.

Anfrage für Aktualisierungseinstellungswert

Die Anfrage für UpdateSettingValue.

Felder
setting_value

SettingValue

Der zu aktualisierende Einstellungswert. Informationen zu den Feldanforderungen finden Sie unter SettingValue.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource settingValue erforderlich:

  • resourcesettings.settingvalues.update

Wert

Die Daten in einem Einstellungswert.

Felder
Union-Feld value. Wählt den Datentyp und den zugehörigen Wert aus. Für value ist nur einer der folgenden Werte zulässig:
boolean_value

bool

Definiert diesen Wert als booleschen Wert.
string_value

string

Definiert diesen Wert als Stringwert.
string_set_value

StringSet

Definiert diesen Wert als StringSet.

StringSet

Ein Stringsatzwert, der eine Reihe von Strings enthalten kann. Jeder String darf maximal 60 Zeichen lang sein. Der String darf maximal 50 Strings umfassen.

Felder
values[]

string

Die Strings im Satz