REST Resource: projects.configs.variables

Ressource: Variable

Beschreibt eine einzelne Variable innerhalb einer RuntimeConfig-Ressource. Der Name bezeichnet den hierarchischen Namen einer Variable. ports/serving_port ist beispielsweise ein gültiger Variablenname. 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]

[PROJECT_ID] muss eine gültige Projekt-ID sein, [CONFIG_NAME] muss eine gültige RuntimeConfig-Ressource sein und [VARIABLE_NAME] muss der Benennung von Dateipfaden im Unix-Dateisystem entsprechen.

Der [VARIABLE_NAME] kann ASCII-Buchstaben, Ziffern, Schrägstriche und Bindestriche enthalten. Schrägstriche werden als Trennzeichen für Pfadelemente verwendet und sind nicht Teil von [VARIABLE_NAME] selbst. [VARIABLE_NAME] muss daher mindestens ein Zeichen enthalten, das kein Schrägstrich ist. Mehrere Schrägstriche werden zu einem Schrägstrichzeichen verbunden. Jedes Pfadsegment muss dem regulären Ausdruck 0-9A-Za-z? entsprechen. Die Länge einer [VARIABLE_NAME] darf maximal 256 Zeichen betragen.

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

string (Timestamp format)

Nur Ausgabe. Die Uhrzeit der letzten Variablenaktualisierung. Der Zeitstempel ist ein UTC-Zeitstempel.

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 Variablen. Der Variablenstatus gibt das Ergebnis des variables().watch-Aufrufs an und ist über die Aufrufe get und list sichtbar.

Union-Feld contents. Der Wert der Variablen. Es kann sich entweder um einen binären Wert oder einen String-Wert handeln. Sie müssen entweder value oder text angeben. Wenn Sie beide angeben, gibt der Server einen Fehler zurück. Für contents ist nur einer der folgenden Werte zulässig:
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-codiert sein und IETF RFC4648 (https://www.ietf.org/rfc/rfc4648.txt) entsprechen. Es kann nur value oder text festgelegt werden.

Ein base64-codierter 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

Die VariableState beschreibt den letzten bekannten Status der Variablen und wird bei einem variables().watch-Aufruf verwendet, um den Status der Variablen zu unterscheiden.

Enums
VARIABLE_STATE_UNSPECIFIED Standardstatus der Variable.
UPDATED Die Variable wurde aktualisiert, während variables().watch ausgeführt wurde.
DELETED Die Variable wurde gelöscht, während 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.

testIamPermissions

 Gibt die Berechtigungen des Aufrufers für die angegebene Ressource zurück.

update

 Aktualisiert eine Variable mit einem neuen Wert.

watch

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