REST Resource: projects.locations.units

Recurso: unidade

Uma unidade de implantação que tem ciclo de vida por uma API CRUD usando um mecanismo de atuação (por exemplo, com base em Terraform, Helm ou uma implementação personalizada fornecida por um produtor de serviços). Um elemento básico de um locatário de SaaS.

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

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

"projects/{project}/locations/{location}/units/{unit}"
unitKind

string

Opcional. Referência ao UnitKind a que esta unidade pertence. Imutável depois de definido.
release

string

Opcional. Apenas saída. O objeto Release atual para esta unidade.
tenant

string

Opcional. Referência ao recurso de locatário do SaaS a que esta unidade pertence. Por exemplo, isso informa as políticas de manutenção a serem usadas para programar atualizações futuras em uma unidade. (opcional e imutável depois de criado)
ongoingOperations[]

string

Opcional. Apenas saída. Lista de UnitOperations simultâneas que estão operando nesta unidade.
pendingOperations[]

string

Opcional. Apenas saída. Lista de UnitOperations pendentes (aguardando execução) para esta unidade.
scheduledOperations[]

string

Opcional. Apenas saída. Lista de UnitOperations agendadas para esta unidade.
dependents[]

object (UnitDependency)

Opcional. Apenas saída. Lista de unidades que dependem desta unidade. A unidade só poderá ser desprovisionada se essa lista estiver vazia. Máximo de 1.000.
dependencies[]

object (UnitDependency)

Opcional. Apenas saída. Conjunto de dependências para esta unidade. No máximo 10.
inputVariables[]

object (UnitVariable)

Opcional. Apenas saída. Indica as variáveis de entrada atuais implantadas pela unidade.
outputVariables[]

object (UnitVariable)

Opcional. Apenas saída. Conjunto de pares de chave/valor correspondentes às variáveis de saída da execução de modelos de ação. As variáveis são declaradas em configurações de ação (por exemplo, em um gráfico do Helm ou no Terraform), e os valores são buscados e retornados pelo mecanismo de ação após a conclusão da execução.
maintenance

object (MaintenanceSettings)

Opcional. Captura as diretivas solicitadas para realizar manutenção futura na unidade. Isso inclui um pedido para que a unidade pule a manutenção por um período e permaneça fixada na versão atual, além de controles para adiar a manutenção agendada para o futuro.
state

enum (UnitState)

Opcional. Apenas saída. O estado atual do ciclo de vida do recurso (por exemplo, se ele está sendo criado ou pronto para uso).
conditions[]

object (UnitCondition)

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

enum (ManagementMode)

Opcional. Imutável. Indica se o ciclo de vida da unidade é controlado pelo usuário ou pelo sistema. Imutável após a criação.
systemManagedState

enum (SystemManagedState)

Opcional. Apenas saída. Indica o estado gerenciado pelo sistema da unidade.
systemCleanupAt

string (Timestamp format)

Opcional. Apenas saída. Se definido, indica o momento em que o sistema vai começar a remover a unidade.

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

boolean

Apenas saída. Indica se o local do recurso atende às restrições de separação de zonas. O padrão é "falso".
satisfiesPzi

boolean

Apenas saída. Indica se o local do recurso atende às restrições de isolamento de zona. O padrão é "falso".

UnitDependency

Conjunto de dependências para esta unidade. No máximo 10.

Representação JSON 
{
  "alias": string,
  "unit": string
}
Campos
alias

string

Apenas saída. Alias para o nome da dependência.
unit

string

Apenas saída. Uma referência ao objeto Unit.

MaintenanceSettings

Captura as diretivas solicitadas para realizar manutenção futura na unidade. Isso inclui um pedido para que a unidade pule a manutenção por um período e permaneça fixada na versão atual, além de controles para adiar a manutenção agendada para o futuro.

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

string (Timestamp format)

Opcional. Se a opção estiver marcada, ela corrigirá a versão na unidade até o horário especificado. Ou seja, as alterações no campo de versão serão rejeitadas. Os lançamentos também respeitam essa opção e não solicitam um upgrade.

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

UnitState

UnitState anota qual é o estado atual da unidade.

Tipos enumerados
UNIT_STATE_UNSPECIFIED Estado não especificado.
UNIT_STATE_NOT_PROVISIONED A unidade não está provisionada.
UNIT_STATE_PROVISIONING A unidade está sendo provisionada.
UNIT_STATE_UPDATING A unidade está sendo atualizada. Isso geralmente acontece quando uma unidade está sendo atualizada para um novo lançamento ou quando algumas das variáveis de entrada na unidade estão sendo alteradas. Alguns tipos de atualizações podem inutilizar a unidade enquanto a atualização está em andamento.
UNIT_STATE_DEPROVISIONING A unidade está sendo excluída.
UNIT_STATE_READY A unidade foi provisionada e está pronta para uso
UNIT_STATE_ERROR A unidade tem um erro quando não está pronta e alguma operação de erro

UnitCondition

UnitCondition descreve o status de uma unidade. UnitCondition 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_READY O tipo de condição está pronto.
TYPE_UPDATING O tipo de condição está sendo atualizado.
TYPE_PROVISIONED O tipo de condição é provisionado.
TYPE_OPERATION_ERROR O tipo de condição é operationError. Verdadeiro quando a última operação de unidade falha com um erro não ignorável.

ManagementMode

O ManagementMode descreve quem é responsável pelo gerenciamento da unidade.

Tipos enumerados
MANAGEMENT_MODE_UNSPECIFIED
MANAGEMENT_MODE_USER O ciclo de vida da unidade é gerenciado pelo usuário.
MANAGEMENT_MODE_SYSTEM O sistema decide quando desprovisionar e excluir a unidade. O usuário ainda pode desprovisionar ou excluir a unidade manualmente.

SystemManagedState

Tipos enumerados
SYSTEM_MANAGED_STATE_UNSPECIFIED
SYSTEM_MANAGED_STATE_ACTIVE A unidade tem dependentes anexados.
SYSTEM_MANAGED_STATE_INACTIVE A unidade não tem dependências anexadas, mas o anexo é permitido.
SYSTEM_MANAGED_STATE_DECOMMISSIONED A unidade não tem dependências anexadas, e o anexo não é permitido.

Métodos

create

 Crie uma nova unidade.

delete

 Excluir uma única unidade.

get

 Recupera uma única unidade.

list

 Recupera uma coleção de unidades.

patch

 Atualize uma única unidade.