REST Resource: projects.locations.unitOperations

Recurso: UnitOperation

UnitOperation encapsula a intenção de mudar/interagir com o componente de serviço representado pela unidade específica. Várias UnitOperations podem ser criadas (solicitadas) e programadas para o futuro, mas apenas uma pode ser executada por vez. Isso pode mudar no futuro para operações não mutantes.

As UnitOperations permitem que diferentes atores que interagem com a mesma unidade se concentrem apenas na mudança que solicitaram.

É um objeto básico que contém os campos comuns em todas as operações de unidade. Próximo: 22

Representação 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

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

"projects/{project}/locations/{location}/unitOperations/{unitOperation}"
unit

string

Obrigatório. Imutável. A unidade em que uma determinada UnitOperation vai atuar.
parentUnitOperation

string

Opcional. Referência ao recurso pai: UnitOperation. Se uma operação precisar criar outras como parte do fluxo de trabalho, cada uma das operações secundárias precisará ter esse campo definido como o principal. Isso pode ser usado para rastreamento. (Opcional)
rollout

string

Opcional. Especifica qual lançamento criou esta operação de unidade. Ele não pode ser modificado e é usado apenas para fins de filtragem. Se uma unidade dependente e uma operação de unidade forem criadas como parte de outra operação de unidade, elas usarão o mesmo rolloutId.
cancel

boolean

Opcional. Quando for "true", tente cancelar a operação. O cancelamento pode falhar se a operação já estiver em execução. (Opcional)
state

enum (UnitOperationState)

Opcional. Apenas saída. UnitOperationState descreve o estado atual da operação da unidade.
conditions[]

object (UnitOperationCondition)

Opcional. Apenas saída. Um conjunto de condições que indicam as várias condições que esse recurso pode ter.
schedule

object (Schedule)

Opcional. Quando programar essa operação.
engineState

string

Opcional. Apenas saída. O estado do mecanismo para operações de implantação em andamento. Este campo é opaco para uso externo.
errorCategory

enum (UnitOperationErrorCategory)

Opcional. Apenas saída. UnitOperationErrorCategory descreve a categoria do erro.
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".
deleteTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora em que o recurso foi marcado para exclusão (a exclusão é uma operação assíncrona).

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

Campo de união unit_operation_type.

unit_operation_type pode ser apenas de um dos tipos a seguir:
provision

object (Provision)
upgrade

object (Upgrade)
deprovision

object (Deprovision)

Provisionamento

O provisionamento é a operação de unidade que provisiona os recursos representados por uma unidade. Só pode ser executado se a unidade não estiver provisionada no momento.

Representação JSON 
{
  "release": string,
  "inputVariables": [
    {
      object (UnitVariable)
    }
  ]
}
Campos
release

string

Opcional. Referência ao objeto Release a ser usado para a unidade. Opcional:
inputVariables[]

object (UnitVariable)

Opcional. Conjunto de variáveis de entrada. Máximo de 100. (opcional)

Fazer upgrade

O upgrade é a operação de unidade que faz upgrade de uma unidade provisionada, que também pode incluir os recursos representados por uma unidade. Só pode ser executado se a unidade estiver provisionada.

Representação JSON 
{
  "release": string,
  "inputVariables": [
    {
      object (UnitVariable)
    }
  ]
}
Campos
release

string

Opcional. Referência ao objeto Release a ser usado para a unidade. Opcional:
inputVariables[]

object (UnitVariable)

Opcional. Conjunto de variáveis de entrada. Máximo de 100. (opcional)

Desprovisionar

Esse tipo não tem campos.

O desprovisionamento é a operação de unidade que desprovisiona os recursos representados por uma unidade. Só pode ser executado se a unidade estiver provisionada.

UnitOperationState

UnitOperationState descreve o estado atual da operação da unidade.

Tipos enumerados
UNIT_OPERATION_STATE_UNKNOWN
UNIT_OPERATION_STATE_PENDING A operação da unidade foi aceita, mas não está pronta para ser executada.
UNIT_OPERATION_STATE_SCHEDULED A operação de unidade é aceita e programada.
UNIT_OPERATION_STATE_RUNNING A operação de unidade está em execução.
UNIT_OPERATION_STATE_SUCCEEDED A operação da unidade foi concluída.
UNIT_OPERATION_STATE_FAILED A operação da unidade falhou.
UNIT_OPERATION_STATE_CANCELLED A operação da unidade foi cancelada.

UnitOperationCondition

UnitOperationCondition descreve o status de uma operação de unidade. UnitOperationCondition são componentes individuais que contribuem para um estado geral.

Representação JSON 
{
  "status": enum (Status),
  "type": enum (Type),
  "lastTransitionTime": string,
  "message": string,
  "reason": string
}
Campos
status

enum (Status)

Obrigatório. Status da condição.
type

enum (Type)

Obrigatório. Tipo da condição.
lastTransitionTime

string (Timestamp format)

Obrigatório. A última vez que a condição passou de um status para outro.

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

string

Obrigatório. Mensagem legível por humanos indicando detalhes sobre a última transição.
reason

string

Obrigatório. Breve motivo da última transição da condição.

Status

Enumeração dos status de condição.

Tipos enumerados
STATUS_UNSPECIFIED O status da condição não foi especificado.
STATUS_UNKNOWN Condição desconhecida.
STATUS_TRUE A condição é verdadeira.
STATUS_FALSE A condição é falsa.

Tipo

Enumeração de tipos de condição.

Tipos enumerados
TYPE_UNSPECIFIED O tipo de condição não foi especificado.
TYPE_SCHEDULED O tipo de condição está programado.
TYPE_RUNNING O tipo de condição está em execução.
TYPE_SUCCEEDED O tipo de condição foi concluído.
TYPE_CANCELLED O tipo de condição foi cancelado.
TYPE_APP_CREATED Indica se o app do AppHub foi criado.
TYPE_APP_COMPONENTS_REGISTERED Indica se os serviços e as cargas de trabalho foram registrados no App Hub.

Programar

Uma especificação de horário para agendar a manutenção.

Representação JSON 
{
  "startTime": string
}
Campos
startTime

string (Timestamp format)

Opcional. Início da operação. Se não for definido, será definido como o início da próxima janela. (opcional)

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

UnitOperationErrorCategory

UnitOperationErrorCategory descreve a categoria de erro da operação da unidade.

Tipos enumerados
UNIT_OPERATION_ERROR_CATEGORY_UNSPECIFIED A categoria de erro da operação de unidade não foi especificada
NOT_APPLICABLE A categoria de erro da operação da unidade não é aplicável ou não é um erro
FATAL A categoria de erro de operação da unidade é fatal
RETRIABLE A categoria de erro da operação de unidade pode ser repetida
IGNORABLE A categoria de erro de operação da unidade pode ser ignorada
STANDARD A categoria de erro da operação da unidade é padrão e conta para a margem de erro de lançamento.

Métodos

create

 Crie uma nova operação de unidade.

delete

 Exclui uma única operação de unidade.

get

 Recupera uma única operação de unidade.

list

 Recupera uma coleção de operações de unidade.

patch

 Atualiza uma única operação de unidade.