Sammlung: projects.configs.variables

Ressource: Variable

Beschreibt eine einzelne Variable innerhalb einer RuntimeConfig-Ressource. Der Name bezeichnet den hierarchischen Namen einer Variable. Beispielsweise ist ports/serving_port ein gültiger Name einer Variable. Die Variable ist ein opaker String und nur Blatt-Variablen können Werte haben (also Variablen, die keine untergeordneten Variablen haben).

JSON-Darstellung

{
  "name": string,
  "updateTime": string,
  "state": enum(VariableState),

  // Union field contents can be only one of the following:
  "value": string,
  "text": string,
  // End of list of possible types for union field contents.
}
Felder
name

string

Der Name der Variablen-Ressource im Format:


projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]

Die [PROJECT_ID] muss eine gültige Projekt-ID sein, [CONFIG_NAME] muss eine gültige RuntimeConfig-Ressource sein und [VARIABLE_NAME] entspricht der Pfadnamensgebung im Unix-Dateisystem.

Der [VARIABLE_NAME] kann ASCII-Buchstaben, Ziffern, Schrägstriche und Bindestriche enthalten. Schrägstriche werden als Trennung für Pfadelemente verwendet und nicht als Teil des [VARIABLE_NAME] selbst, daher muss [VARIABLE_NAME] zumindest ein Zeichen enthalten, das kein Schrägstrich ist. Mehrere Schrägstriche werden zu einem Schrägstrichzeichen verbunden. Jedes Pfadelement sollte der Segment-Spezifikation RFC 1035 entsprechen. Die Größe eines [VARIABLE_NAME] muss kleiner als 256 Byte sein.

Sobald Sie die Variable erstellt haben, können sie den Namen der Variable nicht mehr ändern.

updateTime

string (Timestamp format)

[Nur Ausgabe] Die Zeit der letzten Aktualisierung der Variable.

Ein Zeitstempel im Format "RFC3339 UTC 'Zulu'" in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".

state

enum(VariableState)

[Nur Ausgabe] Der aktuelle Status der Variable. Der Status der Variable zeigt das Ergebnis des Aufrufs variables().watch an und ist durch die Aufrufe get und list sichtbar.

Union-Feld contents. Der Wert der Variable. Es kann sich entweder um einen binären Wert oder einen String-Wert handeln. Sie müssen entweder value oder text angeben. Wenn beides angegeben wird, gibt der Server einen Fehler zurück. contents kann nur eines der Folgenden sein:
value

string (bytes format)

Der binäre Wert der Variable. Die Länge des Werts muss kleiner als 4096 Byte sein. Leere Werte werden auch akzeptiert. Der Wert muss base64-kodiert sein. Es kann nur entweder value oder text angegeben werden.

Ein base64-kodierter String.

text

string

Der String-Wert der Variable. Die Länge des Werts muss kleiner als 4096 Byte sein. Leere Werte werden auch akzeptiert. Beispiel: text: "my text value" Der String muss UTF-8-gültig sein.

VariableState

Der VariableState beschreibt den letzten bekannten Status der Variable und wird während eines variables().watch-Aufrufs verwendet, um den Status der Variable zu bestimmen.

Enums
VARIABLE_STATE_UNSPECIFIED Standardstatus der Variable.
UPDATED Die Variable wurde aktualisiert, als variables().watch ausgeführt wurde.
DELETED Die Variable wurde gelöscht, als variables().watch ausgeführt wurde.

Methoden

create

Erstellt eine Variable innerhalb der angegebenen Konfiguration.

delete

Löscht eine oder mehrere Variablen.

get

Ruft Informationen über eine einzelne Variable ab.

list

Listet Variablen in einer bestimmten Konfiguration entsprechend vorhandenen Filtern auf.

update

Aktualisiert eine Variable mit einem neuen Wert.

watch

Überwacht eine bestimmte Variable und wartet auf eine Änderung des Werts der Variable.