REST Resource: projects.locations.flags

Recurso: sinalização

Representa uma única flag.

Representação JSON
{
  "name": string,
  "key": string,
  "valueType": enum (FlagValueType),
  "flagValueType": enum (ValueType),
  "evaluationSpec": {
    object (EvaluationSpec)
  },
  "unitKind": string,
  "description": string,
  "variants": [
    {
      object (FlagVariant)
    }
  ],
  "flagSet": string,
  "state": enum (State),
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string
}
Campos
name

string

Identificador. O nome do recurso (URI completo do recurso) seguindo o esquema de nomenclatura padrão:

"projects/{project}/locations/{location}/flags/{flagId}"

key

string

Obrigatório. Imutável. Chave de flag usada nas APIs de avaliação do ambiente de execução (OpenFeature). Tamanho máximo: 256 bytes.

valueType
(deprecated)

enum (FlagValueType)

Opcional. Imutável. Descontinuado: use flagValueType. Tipo de valor da flag.

flagValueType

enum (ValueType)

Opcional. Imutável. Tipo de valor da flag.

evaluationSpec

object (EvaluationSpec)

Opcional. Especificação de como o valor da flag deve ser avaliado.

Se uma flag booleana for criada sem um "evaluationSpec" especificado, duas variantes padrão, "Enabled" (com "boolValue" = true) e "Disabled" (com "boolValue" = false), serão criadas por padrão, e "Disabled" será definido como o "defaultTarget".

unitKind

string

Obrigatório. Imutável. UnitKind que pode consumir essa flag.

description

string

Opcional. Descrição da flag. Tamanho máximo: 500 bytes.

variants[]

object (FlagVariant)

Opcional. Uma lista de variantes.

flagSet

string

Opcional. A flag a que este conjunto de flags pertence.

state

enum (State)

Opcional. Estado atual da flag.

labels

map (key: string, value: string)

Opcional. Os rótulos no recurso, que podem ser usados para categorização, semelhantes aos rótulos de recursos do Kubernetes.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

annotations

map (key: string, value: string)

Opcional. Anotações é um mapa de chave-valor não estruturado armazenado com um recurso que pode ser definido por ferramentas externas para armazenar e recuperar metadados arbitrários. Elas não podem ser consultadas e precisam ser preservadas ao modificar objetos.

Mais informações: https://kubernetes.io/docs/user-guide/annotations

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

uid

string

Apenas saída. O identificador exclusivo do recurso. O UID é exclusivo no tempo e espaço para esse recurso no escopo do serviço. Geralmente, ele é gerado pelo servidor quando um recurso é criado com sucesso e não pode ser modificado. O UID é usado para identificar exclusivamente recursos com reutilização de nome de recurso. Deve ser um UUID4.

etag

string

Apenas saída. Um valor opaco que identifica exclusivamente uma versão ou geração de um recurso. Pode ser usado para confirmar que o cliente e o servidor concordam com a ordenação de um recurso em criação.

createTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora em que o recurso foi criado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora da última atualização do recurso. Qualquer mudança que for feita pelos usuários no recurso vai atualizar esse valor. As mudanças de um recurso feitas pelo serviço devem atualizar esse valor.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

FlagValueType

Tipos enumerados
FLAG_VALUE_TYPE_UNSPECIFIED
FLAG_VALUE_TYPE_BOOL Tipo de valor de flag booleana.
FLAG_VALUE_TYPE_INT Tipo de valor de flag inteiro.
FLAG_VALUE_TYPE_STRING Tipo de valor da flag de string.
FLAG_VALUE_TYPE_DOUBLE Tipo de flag dupla.

ValueType

Tipo de valor da flag.

Tipos enumerados
FLAG_VALUE_TYPE_UNSPECIFIED Tipo de valor de flag não especificado.
FLAG_VALUE_TYPE_BOOLEAN Tipo de valor de flag booleana.
FLAG_VALUE_TYPE_INTEGER Tipo de valor de flag inteiro.
FLAG_VALUE_TYPE_STRING Tipo de valor da flag de string.
FLAG_VALUE_TYPE_DOUBLE Tipo de valor de flag duplo.

FlagVariant

Uma variante é um identificador de um valor (nome atribuído a um valor).

Representação JSON
{
  "id": string,
  "trackingId": string,
  "description": string,

  // Union field value can be only one of the following:
  "booleanValue": boolean,
  "integerValue": string,
  "stringValue": string,
  "doubleValue": number
  // End of list of possible types for union field value.
}
Campos
id

string

Obrigatório. ID da variante. Tamanho máximo: 128 bytes.

trackingId

string

Opcional. O trackingId é exclusivo dependendo do nome e do valor da variante no escopo do serviço. Geralmente, ele é gerado pelo servidor e não pode ser mudado. O trackingId é usado para identificar e rastrear variantes de forma exclusiva.

description

string

Opcional. Uma descrição legível do que essa variante faz ou representa.

Campo de união value. value é um único valor de flag para a variante. value pode ser apenas de um dos tipos a seguir:
booleanValue

boolean

Opcional. Valor booleano da variante.

integerValue

string (int64 format)

Opcional. Valor da variante de número inteiro.

stringValue

string

Opcional. Valor da variante de string.

doubleValue

number

Opcional. Valor de variante dupla.

Estado

O estado define o estado da flag.

Tipos enumerados
FLAG_STATE_UNSPECIFIED O estado da flag não foi especificado.
FLAG_STATE_IN_DEVELOPMENT A flag está em desenvolvimento.
FLAG_STATE_ACTIVE A flag está ativa.
FLAG_STATE_SUNSETTING A flag está em um estado de descontinuação.
FLAG_STATE_CLEANUP A flag está em estado de limpeza.

Métodos

create

Crie uma nova flag.

delete

Excluir uma única flag.

get

Recupera uma única flag.

list

Recupera uma coleção de flags.

patch

Atualize uma única flag.