Coleção: projects.configs.variables

Recurso: variável

Descreve uma única variável em um recurso RuntimeConfig. O nome representa a variável hierárquica. Por exemplo, ports/serving_port é um nome de variável válido. O valor da variável é uma string opaca, e somente variáveis de folha podem ter valores (ou seja, variáveis que não têm filhos).

Representação 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.
}
Campos
name

string

O nome do recurso de variável no formato:


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

[PROJECT_ID] precisa ser um código de projeto válido, [CONFIG_NAME] precisa ser um recurso RuntimeConfig válido e [VARIABLE_NAME] segue a nomenclatura de caminho de arquivo do sistema de arquivos Unix.

[VARIABLE_NAME] pode ter letras ASCII, números, barras e traços. As barras são usadas como separadores de elementos de caminho e não fazem parte do [VARIABLE_NAME] propriamente dito, portanto [VARIABLE_NAME] precisa incluir pelo menos um caractere que não seja barra. Várias barras são unidas em um caractere de barra única. Cada segmento de caminho deve seguir a especificação RFC 1035. O comprimento do [VARIABLE_NAME] precisa ser inferior a 256 bytes.

Após criar uma variável, você não poderá alterar o nome dela.
updateTime

string (Timestamp format)

[Somente saída] O horário da última atualização da variável.

Um timestamp no formato UTC "Zulu" RFC3339 é precisamente medido em nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".
state

enum(VariableState)

[Somente saída] O estado atual da variável. O estado da variável indica o resultado da chamada variables().watch e é visível por meio das chamadas get e list.

contents do campo de união. O valor da variável. Ele pode ser binário ou string. É necessário especificar value ou text. Se os dois forem especificados, o servidor poderá retornar um erro. contents pode ser apenas um dos seguintes:
value

string (bytes format)

O valor binário da variável. O comprimento dele precisa ser inferior a 4096 bytes. Valores vazios também são aceitos. Ele precisa ser codificado em base64. É possível definir apenas um dos dois: value ou text.

Uma string codificada em base64.
text

string

O valor da string da variável. O comprimento dele precisa ser inferior a 4096 bytes. Valores vazios também são aceitos. Por exemplo, text: "my text value". A string precisa ser UTF-8 válido.

VariableState

VariableState descreve o último estado conhecido da variável e é usado durante a chamada variables().watch para diferenciar o estado da variável.

Enums
VARIABLE_STATE_UNSPECIFIED Estado padrão da variável.
UPDATED A variável foi atualizada enquanto variables().watch estava em execução.
DELETED A variável foi excluída enquanto variables().watch estava em execução.

Métodos

create

 Cria uma variável na configuração especificada.

delete

 Exclui uma ou diversas variáveis.

get

 Recebe informações sobre uma única variável.

list

 Lista as variáveis de uma determinada configuração, que correspondam aos filtros fornecidos.

update

 Atualiza uma variável existente com um novo valor.

watch

 Observa uma variável específica e aguarda uma alteração no valor dela.