REST Resource: projects.locations.flags

Recurso: Flag

Representa un solo parámetro de configuración.

Representación 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

Es el identificador. Nombre del recurso (URI completo del recurso) según el esquema de nombres estándar:

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

key

string

Obligatorio. Inmutable. Es la clave de la marca que se usa en las APIs de evaluación de entorno de ejecución (OpenFeature). Longitud máxima: 256 bytes.

valueType
(deprecated)

enum (FlagValueType)

Es opcional. Inmutable. Obsoleto: Usa flagValueType en su lugar. Es el tipo de valor de la marca.

flagValueType

enum (ValueType)

Es opcional. Inmutable. Es el tipo de valor de la marca.

evaluationSpec

object (EvaluationSpec)

Es opcional. Especificación de cómo se debe evaluar el valor de la marca.

Si se crea una marca booleana sin un evaluationSpec especificado, se crearán dos variantes predeterminadas, "Habilitada" (con boolValue = true) y "Inhabilitada" (con boolValue = false), y se establecerá "Inhabilitada" como el defaultTarget.

unitKind

string

Obligatorio. Inmutable. UnitKind que puede consumir esta marca.

description

string

Es opcional. Es la descripción de la marca. Longitud máxima: 500 bytes.

variants[]

object (FlagVariant)

Es opcional. Es una lista de variantes.

flagSet

string

Es opcional. Es la marca a la que pertenece esta marca.

state

enum (State)

Es opcional. Estado actual de la marca.

labels

map (key: string, value: string)

Es opcional. Son las etiquetas del recurso, que se pueden usar para la categorización, de forma similar a las etiquetas de recursos de Kubernetes.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

annotations

map (key: string, value: string)

Es opcional. Las anotaciones son un mapa clave-valor no estructurado que se almacena con un recurso que herramientas externas pueden establecer para almacenar y recuperar metadatos arbitrarios. No se pueden consultar y deben conservarse cuando se modifican objetos.

Más información: https://kubernetes.io/docs/user-guide/annotations

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

uid

string

Solo salida. Identificador único del recurso. El UID es único en el tiempo y espacio para este recurso dentro del alcance de este servicio. Normalmente, el servidor lo genera durante la creación correcta de un recurso y no se debe cambiar. El UID se usa para identificar los recursos de manera única en caso de la reutilización de nombres de recursos y debe ser un UUID4.

etag

string

Solo salida. Valor opaco que identifica de manera única a una versión o generación de un recurso. Se puede usar para confirmar que el cliente y el servidor están de acuerdo en el orden del recurso que se escribe.

createTime

string (Timestamp format)

Solo salida. Marca de tiempo cuando se creó el recurso.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Solo salida. Marca de tiempo cuando se actualizó el recurso por última vez. Este valor debe actualizarse en caso de que los usuarios hagan cualquier cambio al recurso. Este valor debería actualizarse si el servicio hace cambios al recurso.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

FlagValueType

Enums
FLAG_VALUE_TYPE_UNSPECIFIED
FLAG_VALUE_TYPE_BOOL Es el tipo de valor de la marca booleana.
FLAG_VALUE_TYPE_INT Es el tipo de valor de la marca de número entero.
FLAG_VALUE_TYPE_STRING Es el tipo de valor de la marca de cadena.
FLAG_VALUE_TYPE_DOUBLE Es un tipo de marca doble.

ValueType

Es el tipo de valor de la marca.

Enums
FLAG_VALUE_TYPE_UNSPECIFIED Es el tipo de valor de la marca no especificado.
FLAG_VALUE_TYPE_BOOLEAN Es el tipo de valor de la marca booleana.
FLAG_VALUE_TYPE_INTEGER Es el tipo de valor de la marca de número entero.
FLAG_VALUE_TYPE_STRING Es el tipo de valor de la marca de cadena.
FLAG_VALUE_TYPE_DOUBLE Es el tipo de valor de la marca doble.

FlagVariant

La variante es un identificador de un valor (nombre asignado a un valor).

Representación 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

Obligatorio. Es el ID de la variante. Longitud máxima: 128 bytes.

trackingId

string

Opcional. El trackingId es único según el nombre y el valor de la variante dentro del alcance del servicio. Por lo general, lo genera el servidor y no se debe cambiar. trackingId se usa para identificar y hacer un seguimiento de las variantes de forma única.

description

string

Es opcional. Es una descripción legible de lo que hace o representa esta variante.

Campo de unión value. El valor es un solo valor de la marca para la variante. value puede ser solo uno de los parámetros siguientes:
booleanValue

boolean

Es opcional. Es el valor de la variante booleana.

integerValue

string (int64 format)

Es opcional. Es el valor de la variante de número entero.

stringValue

string

Es opcional. Es el valor de la variante de cadena.

doubleValue

number

Es opcional. Es el valor de la variante doble.

Estado

El estado define el estado de la marca.

Enums
FLAG_STATE_UNSPECIFIED No se especificó el estado de la marca.
FLAG_STATE_IN_DEVELOPMENT La marca está en estado de desarrollo.
FLAG_STATE_ACTIVE La marca está en estado activo.
FLAG_STATE_SUNSETTING La marca está en estado de obsolescencia.
FLAG_STATE_CLEANUP La marca está en estado de limpieza.

Métodos

create

Crea una nueva marca.

delete

Borra un solo indicador.

get

Recupera una sola marca.

list

Recupera una colección de marcas.

patch

Actualiza una sola marca.