Package google.cloud.resourcesettings.v1alpha1

Index

ResourceSettingsService

Eine Schnittstelle für die Interaktion mit Ressourceneinstellungen und Einstellungswerten in der gesamten Ressourcenhierarchie.

Dienste können eine Reihe von Einstellungen für Nutzer bereitstellen, mit denen sie das Verhalten ihrer Ressourcen steuern können. Die für eine bestimmte Cloud-Ressource angewendeten Einstellungswerte werden hierarchisch ausgewertet und von allen untergeordneten Elementen dieser Ressource übernommen.

Gibt für alle Anfragen einen google.rpc.Status mit google.rpc.Code.PERMISSION_DENIED zurück, 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-Fehler mit google.rpc.Code.INVALID_ARGUMENT zurück, wenn die Anfrage fehlerhaft ist.

Hinweis: Für alle Einstellungen in der Alphaphase ist die Einstellung für keine Ressourcen in Cloud-Organisationen vorhanden, die nicht in der Alphaphase sind.

CreateSettingValue

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

Erstellt einen Einstellwert.

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

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
DeleteSettingValue

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)

Löscht einen Einstellungswert. Wenn der Einstellungswert nicht vorhanden ist, wird der Vorgang nicht ausgeführt.

Gibt ein google.rpc.Status mit google.rpc.Code.NOT_FOUND zurück, wenn die Einstellung oder der Einstellungswert nicht vorhanden ist. Der Einstellungs-Wert ist nicht vorhanden, wenn bei einem vorherigen Aufruf von DeleteSetting für den Einstellungs-Wert bereits ein Erfolgscode zurückgegeben wurde. Gibt ein google.rpc.Status mit google.rpc.Code.FAILED_PRECONDITION zurück, wenn die Einstellung als schreibgeschützt gekennzeichnet 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 ein google.rpc.Status mit google.rpc.Code.NOT_FOUND zurück, wenn der Einstellungs-Wert nicht vorhanden ist.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.
ListSettings

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 für die Cloud-Ressource parent. Der effektive Einstellungswert ist der berechnete Einstellungswert für eine Cloud-Ressource. Er wird in der angegebenen Reihenfolge zu einer der folgenden Optionen ausgewertet (die nächste Option wird verwendet, wenn die vorherige nicht vorhanden ist):

  1. der Einstellungswert für die angegebene Ressource
  2. der Einstellungswert des nächsten Ancestors der angegebenen Ressource
  3. Der Standardwert der Einstellung
  4. ein leerer Einstellwert, der als SettingValue mit allen nicht festgelegten Feldern definiert ist

Gibt ein 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.
SearchSettingValues

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.
UpdateSettingValue

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)

Aktualisiert einen Einstellungswert.

Gibt ein 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 als schreibgeschützt gekennzeichnet ist. Gibt einen google.rpc.Status mit google.rpc.Code.ABORTED zurück, wenn das in der Anfrage angegebene ETag nicht mit dem gespeicherten ETag des Einstellungs-Werts ü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.

CreateSettingValueRequest

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

DeleteSettingValueRequest

Die Anfrage für DeleteSettingValue.

Felder
name

string

Der Name des zu löschenden Einstellungs-Werts. Informationen zu den 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, mit dem der Wert einer read_only-Einstellung gelöscht werden kann. WARNUNG: Die Nutzung erfolgt auf eigenes Risiko. Das Löschen des Werts einer schreibgeschützten Einstellung ist eine irreversible Aktion, d.h., der Wert kann nicht noch einmal erstellt werden.

GetSettingValueRequest

Die Anfrage für GetSettingValue.

Felder
name

string

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

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

  • resourcesettings.settingvalues.get

ListSettingsRequest

Die Anfrage für ListSettings.

Felder
parent

string

Die Cloud-Ressource, die die Einstellung enthält. Muss eines der folgenden Formate haben:

  • 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 verwendet Die Größe der zurückzugebenden Seite.
page_token

string

Nicht verwendet Ein Seitentoken, mit dem die nächste Seite abgerufen wird.

ListSettingsResponse

Die Antwort von ListSettings.

Felder
settings[]

Setting

Eine Liste der Einstellungen, die für die angegebene Cloud-Ressource verfügbar sind.
next_page_token

string

Nicht verwendet Ein Seitentoken, mit dem die nächste Seite abgerufen wird.

LookupEffectiveSettingValueRequest

Die Anfrage für LookupEffectiveSettingValue.

Felder
parent

string

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

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

  • resourcesettings.settingvalues.get

SearchSettingValuesRequest

Die Anfrage für SearchSettingValues.

Felder
parent

string

Die Cloud-Ressource, die die Einstellung enthält. Muss eines der folgenden Formate haben:

  • 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 verwendet Die Größe der zurückzugebenden Seite.
page_token

string

Nicht verwendet Ein Seitentoken, mit dem die nächste Seite abgerufen wird.

SearchSettingValuesResponse

Die Antwort von SearchSettingValues.

Felder
setting_values[]

SettingValue

Alle Einstellungswerte, die für die angegebene Cloud-Ressource vorhanden sind.
next_page_token

string

Nicht verwendet Ein Seitentoken, mit dem die nächste Seite abgerufen wird.

Einstellung

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

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

string

Der für Menschen lesbare Name dieser Einstellung.
description

string

Eine detaillierte Beschreibung der Funktion dieser Einstellung.
read_only

bool

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 DeleteSettingValue 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.
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 für alle Einstellungen ist ein Standardwert festgelegt.

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 Eine boolesche Einstellung.
STRING Eine String-Einstellung.
STRING_SET Eine Einstellung für einen String-Satz.

SettingValue

Die Instanziierung einer Einstellung. Jeder Einstellungswert ist der entsprechenden Einstellung untergeordnet.

Felder
name

string

Der Ressourcenname des Einstellungs-Werts. Muss eines der folgenden Formate haben:

  • 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 durch die übergeordnete Einstellung definiert wird.
etag

string

Ein Fingerabdruck, der für Optimistic Concurrency verwendet wird. 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 Einstellungs-Wert nicht neu erstellt werden kann. Dieses Flag wird von der übergeordneten Einstellung übernommen und dient nur 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.

UpdateSettingValueRequest

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 String-Set-Wert, der eine Reihe von Strings enthalten kann. Jeder String darf maximal 60 Zeichen lang sein und das String-Set darf maximal 50 Strings enthalten.

Felder
values[]

string

Die Strings im Set