REST Resource: 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]

O [PROJECT_ID] precisa ser um ID de projeto válido, o [CONFIG_NAME] precisa ser um recurso RuntimeConfig válido e o [VARIABLE_NAME] precisa seguir 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]. Portanto, [VARIABLE_NAME] precisa conter pelo menos um caractere que não seja uma barra. Várias barras são unidas em um caractere de barra única. Cada segmento do caminho precisa corresponder à expressão regular 0-9A-Za-z?. O comprimento de um [VARIABLE_NAME] precisa ser menor que 256 caracteres.

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

updateTime

string (Timestamp format)

Apenas saída. O horário da última atualização da variável. O carimbo de data/hora será o carimbo de data/hora UTC.

Um carimbo de data/hora no formato UTC “Zulu” RFC3339, medido com precisão de nanossegundos. Exemplo: "2014-10-02T15:01:23.045123456Z".

state

enum(VariableState)

Apenas saída. O estado atual da variável. O estado da variável indica o resultado da chamada variables().watch e fica visível nas chamadas get e list.

Campo de união contents. O valor da variável. Ele pode ser binário ou string. É preciso especificar value ou text. Especificar os dois fará com que o servidor retorne 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. O valor precisa ser codificado em base64 e estar em conformidade com o IETF RFC4648 (https://www.ietf.org/rfc/rfc4648.txt). Apenas uma das opções value ou text pode ser definida.

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

O VariableState descreve o último estado conhecido da variável e é usado durante uma chamada variables().watch para distinguir 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 sendo executada.
DELETED A variável foi excluída enquanto variables().watch estava sendo executada.

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.

testIamPermissions

Retorna permissões do autor da chamada no recurso especificado.

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.