REST Resource: projects.locations.units

Recurso: Unidad

Es una unidad de implementación que tiene su ciclo de vida a través de una API de CRUD que usa un motor de activación de forma interna (p.ej., basado en Terraform, Helm o una implementación personalizada proporcionada por un productor de servicios). Es un componente básico de un arrendatario de SaaS.

Representación JSON 
{
  "name": string,
  "unitKind": string,
  "release": string,
  "tenant": string,
  "ongoingOperations": [
    string
  ],
  "pendingOperations": [
    string
  ],
  "scheduledOperations": [
    string
  ],
  "dependents": [
    {
      object (UnitDependency)
    }
  ],
  "dependencies": [
    {
      object (UnitDependency)
    }
  ],
  "inputVariables": [
    {
      object (UnitVariable)
    }
  ],
  "outputVariables": [
    {
      object (UnitVariable)
    }
  ],
  "maintenance": {
    object (MaintenanceSettings)
  },
  "state": enum (UnitState),
  "conditions": [
    {
      object (UnitCondition)
    }
  ],
  "managementMode": enum (ManagementMode),
  "systemManagedState": enum (SystemManagedState),
  "systemCleanupAt": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean
}
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}/units/{unit}"
unitKind

string

Es opcional. Es una referencia al UnitKind al que pertenece esta unidad. Es inmutable una vez que se establece.
release

string

Es opcional. Solo salida. Es el objeto Release actual de esta unidad.
tenant

string

Es opcional. Es una referencia al recurso de inquilino de SaaS al que pertenece esta unidad. Por ejemplo, esto informa a las políticas de mantenimiento que se deben usar para programar actualizaciones futuras en una unidad. (opcional y no se puede cambiar una vez creado)
ongoingOperations[]

string

Es opcional. Solo salida. Es la lista de UnitOperations simultáneas que operan en esta unidad.
pendingOperations[]

string

Es opcional. Solo salida. Es la lista de UnitOperations pendientes (que esperan ejecutarse) para esta unidad.
scheduledOperations[]

string

Es opcional. Solo salida. Es la lista de UnitOperations programadas para esta unidad.
dependents[]

object (UnitDependency)

Es opcional. Solo salida. Es la lista de unidades que dependen de esta unidad. La unidad solo se puede desaprovisionar si esta lista está vacía. El máximo es 1,000.
dependencies[]

object (UnitDependency)

Es opcional. Solo salida. Es el conjunto de dependencias de esta unidad. Máximo 10.
inputVariables[]

object (UnitVariable)

Es opcional. Solo salida. Indica las variables de entrada actuales que implementa la unidad.
outputVariables[]

object (UnitVariable)

Es opcional. Solo salida. Es un conjunto de pares clave-valor que corresponden a las variables de salida de la ejecución de plantillas de activación. Las variables se declaran en las configuraciones de activación (p. ej., en el gráfico de Helm o Terraform), y el motor de activación recupera y devuelve los valores cuando se completa la ejecución.
maintenance

object (MaintenanceSettings)

Es opcional. Captura las directivas solicitadas para realizar el mantenimiento futuro de la unidad. Esto incluye una solicitud para que la unidad omita el mantenimiento durante un período y permanezca fijada en su versión actual, así como controles para posponer el mantenimiento programado en el futuro.
state

enum (UnitState)

Es opcional. Solo salida. Es el estado actual del ciclo de vida del recurso (p.ej., si se está creando o está listo para usarse).
conditions[]

object (UnitCondition)

Es opcional. Solo salida. Es un conjunto de condiciones que indican las diversas condiciones que puede tener este recurso.
managementMode

enum (ManagementMode)

Es opcional. Inmutable. Indica si el ciclo de vida de la unidad está controlado por el usuario o por el sistema. Es inmutable una vez creado.
systemManagedState

enum (SystemManagedState)

Es opcional. Solo salida. Indica el estado de la unidad administrado por el sistema.
systemCleanupAt

string (Timestamp format)

Es opcional. Solo salida. Si se configura, indica la fecha y hora en que el sistema comenzará a quitar la unidad.

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".
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".
satisfiesPzs

boolean

Solo salida. Indica si la ubicación del recurso satisface las restricciones de separación de zonas. El valor es falso de forma predeterminada.
satisfiesPzi

boolean

Solo salida. Indica si la ubicación del recurso satisface las restricciones de aislamiento de zona. El valor es falso de forma predeterminada.

UnitDependency

Es el conjunto de dependencias de esta unidad. Máximo 10.

Representación JSON 
{
  "alias": string,
  "unit": string
}
Campos
alias

string

Solo salida. Es el alias del nombre de la dependencia.
unit

string

Solo salida. Es una referencia al objeto Unit.

MaintenanceSettings

Captura las directivas solicitadas para realizar el mantenimiento futuro de la unidad. Esto incluye una solicitud para que la unidad omita el mantenimiento durante un período y permanezca fijada en su versión actual, así como controles para posponer el mantenimiento programado en el futuro.

Representación JSON 
{
  "pinnedUntilTime": string
}
Campos
pinnedUntilTime

string (Timestamp format)

Es opcional. Si está presente, fija la versión en la unidad hasta el momento especificado (es decir, se rechazarán los cambios en el campo de la versión). Los lanzamientos también respetarán este parámetro y no solicitarán actualizaciones.

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".

UnitState

UnitState anota cuál es el estado actual de la unidad en sí.

Enums
UNIT_STATE_UNSPECIFIED Significa que el estado no se especificó.
UNIT_STATE_NOT_PROVISIONED La unidad no está aprovisionada.
UNIT_STATE_PROVISIONING Se está aprovisionando la unidad.
UNIT_STATE_UPDATING Se está actualizando la unidad. Esto suele ocurrir cuando se actualiza una unidad a una versión nueva o cuando se cambian algunas de las variables de entrada de la unidad. Algunos tipos de actualizaciones pueden hacer que la unidad quede inutilizable mientras la actualización está en curso.
UNIT_STATE_DEPROVISIONING Se está borrando la unidad.
UNIT_STATE_READY La unidad se aprovisionó y está lista para usarse
UNIT_STATE_ERROR La unidad tiene un error cuando no está lista y se produce alguna operación de error.

UnitCondition

UnitCondition describe el estado de una unidad. UnitCondition son componentes individuales que contribuyen a un estado general.

Representación JSON 
{
  "status": enum (Status),
  "type": enum (Type),
  "lastTransitionTime": string,
  "message": string,
  "reason": string
}
Campos
status

enum (Status)

Obligatorio. Es el estado de la condición.
type

enum (Type)

Obligatorio. Es el tipo de condición.
lastTransitionTime

string (Timestamp format)

Obligatorio. Es la última vez que la condición pasó de un estado a otro.

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".
message

string

Obligatorio. Es un mensaje legible que indica detalles sobre la última transición.
reason

string

Obligatorio. Es el motivo breve de la última transición de la condición.

Estado

Es una enumeración de los estados de la condición.

Enums
STATUS_UNSPECIFIED El estado de la condición no está especificado.
STATUS_UNKNOWN Se desconoce la condición.
STATUS_TRUE La condición es verdadera.
STATUS_FALSE La condición es falsa.

Tipo

Es una enumeración de los tipos de condiciones.

Enums
TYPE_UNSPECIFIED No se especificó el tipo de condición.
TYPE_READY El tipo de condición está listo.
TYPE_UPDATING Se está actualizando el tipo de condición.
TYPE_PROVISIONED El tipo de condición se aprovisionó.
TYPE_OPERATION_ERROR El tipo de condición es operationError. Es verdadero cuando la última operación de unidad falla con un error que no se puede ignorar.

ManagementMode

ManagementMode describe quién es responsable de la administración de la unidad.

Enums
MANAGEMENT_MODE_UNSPECIFIED
MANAGEMENT_MODE_USER El usuario administra el ciclo de vida de la unidad.
MANAGEMENT_MODE_SYSTEM El sistema decidirá cuándo desaprovisionar y borrar la unidad. El usuario aún puede anular el aprovisionamiento o borrar la unidad de forma manual.

SystemManagedState

Enums
SYSTEM_MANAGED_STATE_UNSPECIFIED
SYSTEM_MANAGED_STATE_ACTIVE La unidad tiene dependientes adjuntos.
SYSTEM_MANAGED_STATE_INACTIVE La unidad no tiene dependencias adjuntas, pero se permite el adjunto.
SYSTEM_MANAGED_STATE_DECOMMISSIONED La unidad no tiene dependencias adjuntas y no se permite el adjunto.

Métodos

create

 Crea una unidad nueva.

delete

 Borra una sola unidad.

get

 Recupera una sola unidad.

list

 Recupera una colección de unidades.

patch

 Actualiza una sola unidad.