REST Resource: projects.locations.unitOperations

Recurso: UnitOperation

UnitOperation encapsula la intención de cambiar o interactuar con el componente de servicio representado por la unidad específica. Se pueden crear (solicitar) y programar varias UnitOperations para el futuro, pero solo se permitirá la ejecución de una a la vez (esto puede cambiar en el futuro para las operaciones no mutativas).

Las UnitOperations permiten que los diferentes actores que interactúan con la misma unidad se enfoquen solo en el cambio que solicitaron.

Este es un objeto base que contiene los campos comunes en todas las operaciones de unidades. Siguiente: 22

Representación JSON
{
  "name": string,
  "unit": string,
  "parentUnitOperation": string,
  "rollout": string,
  "cancel": boolean,
  "state": enum (UnitOperationState),
  "conditions": [
    {
      object (UnitOperationCondition)
    }
  ],
  "schedule": {
    object (Schedule)
  },
  "engineState": string,
  "errorCategory": enum (UnitOperationErrorCategory),
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,

  // Union field unit_operation_type can be only one of the following:
  "provision": {
    object (Provision)
  },
  "upgrade": {
    object (Upgrade)
  },
  "deprovision": {
    object (Deprovision)
  }
  // End of list of possible types for union field unit_operation_type.
}
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}/unitOperations/{unitOperation}"

unit

string

Obligatorio. Inmutable. Es la unidad sobre la que actuará una UnitOperation determinada.

parentUnitOperation

string

Es opcional. Es una referencia al recurso principal: UnitOperation. Si una operación necesita crear otras operaciones como parte de su flujo de trabajo, cada una de las operaciones secundarias debe tener este campo establecido en la operación principal. Esto se puede usar para el seguimiento. (Opcional)

rollout

string

Es opcional. Especifica qué lanzamiento creó esta operación de unidad. No se puede modificar y solo se usa para fines de filtrado. Si se crean una unidad dependiente y una operación de unidad como parte de otra operación de unidad, usarán el mismo rolloutId.

cancel

boolean

Es opcional. Cuando es verdadero, se intenta cancelar la operación. La cancelación puede fallar si la operación ya se está ejecutando. (Opcional)

state

enum (UnitOperationState)

Es opcional. Solo salida. UnitOperationState describe el estado actual de la operación de la unidad.

conditions[]

object (UnitOperationCondition)

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

schedule

object (Schedule)

Es opcional. Fecha y hora para programar esta operación.

engineState

string

Es opcional. Solo salida. Es el estado del motor para las operaciones en curso del motor de implementación. Este campo es opaco para el uso externo.

errorCategory

enum (UnitOperationErrorCategory)

Es opcional. Solo salida. UnitOperationErrorCategory describe la categoría de error.

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

deleteTime

string (Timestamp format)

Solo salida. Es la marca de tiempo en la que se marcó el recurso para su eliminación (la eliminación es una operación asíncrona).

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

Campo de unión unit_operation_type.

unit_operation_type puede ser una de las siguientes opciones:

provision

object (Provision)

upgrade

object (Upgrade)

deprovision

object (Deprovision)

Aprovisionamiento

Provision es la operación de unidad que aprovisiona los recursos subyacentes representados por una unidad. Solo se puede ejecutar si la unidad no está aprovisionada actualmente.

Representación JSON
{
  "release": string,
  "inputVariables": [
    {
      object (UnitVariable)
    }
  ]
}
Campos
release

string

Es opcional. Es la referencia al objeto Release que se usará para la unidad. (Opcional).

inputVariables[]

object (UnitVariable)

Es opcional. Es el conjunto de variables de entrada. El máximo es 100. (opcional)

Actualizar

Upgrade es la operación de la unidad que actualiza una unidad aprovisionada, que también puede incluir los recursos subyacentes representados por una unidad. Solo se puede ejecutar si la unidad está aprovisionada actualmente.

Representación JSON
{
  "release": string,
  "inputVariables": [
    {
      object (UnitVariable)
    }
  ]
}
Campos
release

string

Es opcional. Es la referencia al objeto Release que se usará para la unidad. (Opcional).

inputVariables[]

object (UnitVariable)

Es opcional. Es el conjunto de variables de entrada. El máximo es 100. (opcional)

Desaprovisionamiento

Este tipo no tiene campos.

Deprovision es la operación de unidad que desaprovisiona los recursos subyacentes representados por una unidad. Solo se puede ejecutar si la unidad está aprovisionada actualmente.

UnitOperationState

UnitOperationState describe el estado actual de la operación de la unidad.

Enums
UNIT_OPERATION_STATE_UNKNOWN
UNIT_OPERATION_STATE_PENDING Se acepta la operación de la unidad, pero no está lista para ejecutarse.
UNIT_OPERATION_STATE_SCHEDULED Se acepta y programa la operación de unidad.
UNIT_OPERATION_STATE_RUNNING La operación de la unidad está en ejecución.
UNIT_OPERATION_STATE_SUCCEEDED La operación de la unidad se completó correctamente.
UNIT_OPERATION_STATE_FAILED Se produjo un error en la operación de la unidad.
UNIT_OPERATION_STATE_CANCELLED Se canceló la operación de la unidad.

UnitOperationCondition

UnitOperationCondition describe el estado de una operación de unidad. UnitOperationCondition 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_SCHEDULED El tipo de condición es programado.
TYPE_RUNNING El tipo de condición es en ejecución.
TYPE_SUCCEEDED El tipo de condición se completó correctamente.
TYPE_CANCELLED Se canceló el tipo de condición.
TYPE_APP_CREATED Indica si se creó la app de AppHub.
TYPE_APP_COMPONENTS_REGISTERED Indica si los servicios y las cargas de trabajo se registraron en App Hub.

Programar

Es una especificación de tiempo para programar el mantenimiento.

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

string (Timestamp format)

Es opcional. Es el inicio de la operación. Si no se configura, se establecerá en el inicio de la siguiente ventana. (opcional)

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

UnitOperationErrorCategory

UnitOperationErrorCategory describe la categoría de error de la operación de la unidad.

Enums
UNIT_OPERATION_ERROR_CATEGORY_UNSPECIFIED No se especificó la categoría de error de la operación de unidad
NOT_APPLICABLE La categoría de error de la operación de la unidad no es aplicable o no se trata de un error
FATAL La categoría de error de la operación de unidad es grave
RETRIABLE La categoría de error de la operación de unidad se puede reintentar
IGNORABLE La categoría de error de la operación de la unidad se puede ignorar
STANDARD La categoría de error de la operación de la unidad es estándar y se incluye en el porcentaje de error aceptable de lanzamiento.

Métodos

create

Crea una nueva operación de unidad.

delete

Borra una sola operación de unidad.

get

Recupera una sola operación de unidad.

list

Recupera una colección de operaciones de unidades.

patch

Actualiza una sola operación de unidad.