REST Resource: projects.configs.variables

Ressource: Variable

Décrit une seule variable dans une ressource RuntimeConfig. Le nom indique le nom de la variable hiérarchique. Par exemple, ports/serving_port est un nom de variable valide. La valeur de la variable est une chaîne opaque, et seules les variables feuilles peuvent avoir des valeurs (c'est-à-dire les variables qui n'ont pas de variables enfants).

Représentation JSON
{
  "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.
}
Champs
name

string

Nom de la ressource de variable, au format suivant:

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

[PROJECT_ID] doit être un ID de projet valide, [CONFIG_NAME] doit être une ressource RuntimeConfig valide et [VARIABLE_NAME] suit la dénomination des chemins d'accès au système de fichiers Unix.

Le [VARIABLE_NAME] peut contenir des lettres ASCII, des chiffres, des barres obliques et des tirets. Les barres obliques sont utilisées comme séparateurs d'éléments de chemin d'accès et ne font pas partie de [VARIABLE_NAME] lui-même. [VARIABLE_NAME] doit donc contenir au moins un caractère autre qu'une barre oblique. Plusieurs barres obliques sont fusionnées en un seul caractère. Chaque segment de chemin d'accès doit correspondre à l'expression régulière 0-9A-Za-z?. La longueur d'un [VARIABLE_NAME] doit être inférieure à 256 caractères.

Une fois que vous avez créé une variable, vous ne pouvez plus modifier son nom.

updateTime

string (Timestamp format)

Uniquement en sortie. Heure de la dernière mise à jour de la variable. L'horodatage sera au format UTC.

Horodatage au format RFC3339 UTC "Zulu", précis à la nanoseconde près. Exemple : "2014-10-02T15:01:23.045123456Z".

state

enum(VariableState)

Uniquement en sortie. État actuel de la variable. L'état de la variable indique le résultat de l'appel variables().watch et est visible via les appels get et list.

Champ d'union contents. Valeur de la variable. Il peut s'agir d'une valeur binaire ou d'une valeur de chaîne. Vous devez spécifier value ou text. Si vous spécifiez les deux, le serveur renverra une erreur. contents ne peut être qu'un des éléments suivants:
value

string (bytes format)

Valeur binaire de la variable. La longueur de la valeur doit être inférieure à 4 096 octets. Les valeurs vides sont également acceptées. La valeur doit être encodée en base64 et être conforme à la norme IETF RFC 4648 (https://www.ietf.org/rfc/rfc4648.txt). Vous ne pouvez définir qu'un seul élément value ou text.

Chaîne encodée en base64.

text

string

Valeur de chaîne de la variable. La longueur de la valeur doit être inférieure à 4 096 octets. Les valeurs vides sont également acceptées. Par exemple, text: "my text value". Il doit s'agir d'une chaîne UTF-8 valide.

VariableState

VariableState décrit le dernier état connu de la variable et est utilisé lors d'un appel variables().watch pour distinguer l'état de la variable.

Enums
VARIABLE_STATE_UNSPECIFIED État par défaut de la variable.
UPDATED La variable a été mise à jour pendant l'exécution de variables().watch.
DELETED La variable a été supprimée pendant l'exécution de variables().watch.

Méthodes

create

Crée une variable dans la configuration donnée.

delete

Supprime une ou plusieurs variables.

get

Récupère des informations sur une seule variable.

list

Répertorie les variables d'une configuration donnée correspondant aux filtres fournis.

testIamPermissions

Renvoie les autorisations qu'un appelant a sur la ressource spécifiée.

update

Met à jour une variable existante avec une nouvelle valeur.

watch

Surveille une variable spécifique et attend que sa valeur change.