REST Resource: projects.locations.rollouts

Recurso: Rollout

Representa uma única execução de lançamento e os resultados dela.

Representação JSON 
{
  "name": string,
  "release": string,
  "startTime": string,
  "endTime": string,
  "state": enum (RolloutState),
  "stateMessage": string,
  "stateTransitionTime": string,
  "rootRollout": string,
  "parentRollout": string,
  "rolloutOrchestrationStrategy": string,
  "unitFilter": string,
  "rolloutKind": string,
  "stats": {
    object (RolloutStats)
  },
  "control": {
    object (RolloutControl)
  },
  "effectiveUnitFilter": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string
}
Campos
name

string

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

"projects/{project}/locations/{location}/rollout/{rolloutId}"
release

string

Opcional. Imutável. Nome da versão que é lançada para as unidades de destino. Obrigatório se nenhum outro tipo de lançamento for especificado.
startTime

string (Timestamp format)

Opcional. Apenas saída. O horário em que o lançamento começou a ser executado. Ficará vazio se o lançamento ainda não tiver começado.

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

string (Timestamp format)

Opcional. Apenas saída. O momento em que o lançamento terminou a execução (independente de sucesso, falha ou cancelamento). Ficará vazio se o lançamento ainda não tiver sido concluído. Depois de definido, o lançamento fica em estado terminal e todos os resultados são finais.

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

enum (RolloutState)

Apenas saída. Estado atual do lançamento.
stateMessage

string

Apenas saída. Mensagem legível por humanos indicando detalhes sobre a última transição de estado.
stateTransitionTime

string (Timestamp format)

Opcional. Apenas saída. O horário em que o lançamento passou para o estado atual.

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

string

Opcional. Apenas saída. O lançamento raiz de que este lançamento deriva. O nome do recurso (URI completo do recurso) seguindo o esquema de nomenclatura padrão:

"projects/{project}/locations/{location}/rollouts/{rolloutId}"
parentRollout

string

Opcional. Apenas saída. O lançamento principal direto de que este lançamento deriva. O nome do recurso (URI completo do recurso) seguindo o esquema de nomenclatura padrão:

"projects/{project}/locations/{location}/rollouts/{rolloutId}"
rolloutOrchestrationStrategy

string

Opcional. A estratégia usada para executar este lançamento. Essa estratégia vai substituir qualquer estratégia especificada no RolloutKind. Se não for especificado na criação, a estratégia de RolloutKind será usada.

Há duas estratégias de valores compatíveis usadas para controle: "Google.Cloud.Simple.AllAtOnce" e "Google.Cloud.Simple.OneLocationAtATime".

Um lançamento com uma dessas estratégias simples será feito em todos os locais definidos nos locais de SaaS do UnitKind segmentado.
unitFilter

string

Opcional. String de filtro formatada em CEL(https://github.com/google/cel-spec) em relação a "Unit". O filtro será aplicado para determinar a população de unidades qualificadas. Esse filtro só pode reduzir, mas não expandir o escopo do lançamento. Se não for fornecido, o unitFilter do RolloutKind será usado.
rolloutKind

string

Opcional. Imutável. Nome do RolloutKind de que este lançamento deriva e a que ele adere.
stats

object (RolloutStats)

Opcional. Apenas saída. Detalhes sobre o progresso da implementação.
control

object (RolloutControl)

Opcional. Mudança solicitada na execução deste lançamento. O RolloutControl.action padrão é ROLLOUT_ACTION_RUN, o que significa que o lançamento será executado até a conclusão enquanto passa por todos os estados naturais de lançamento (como RUNNING -> SUCCEEDED ou RUNNING -> FAILED). As solicitações só podem ser feitas quando o lançamento está em um estado não terminal.
effectiveUnitFilter

string

Opcional. Apenas saída. Gera apenas o snapshot do filtro de unidade efetivo no horário de início do lançamento. Contém uma expressão CEL(https://github.com/google/cel-spec) que consiste em uma conjunção de Rollout.unit_filter e RolloutKind.unit_filter. Esse campo captura o filtro aplicado pelo lançamento para determinar a população da unidade. Se o unitFilter do RolloutKind associado for modificado depois que o lançamento for iniciado, ele não será atualizado aqui.
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".

RolloutState

O estado atual do lançamento.

Tipos enumerados
ROLLOUT_STATE_UNSPECIFIED Estado não especificado.
ROLLOUT_STATE_RUNNING O lançamento está em andamento.
ROLLOUT_STATE_PAUSED O lançamento foi pausado.
ROLLOUT_STATE_SUCCEEDED O lançamento foi concluído.
ROLLOUT_STATE_FAILED Falha no lançamento.
ROLLOUT_STATE_CANCELLED O lançamento foi cancelado.
ROLLOUT_STATE_WAITING O lançamento está aguardando o atendimento de uma condição antes de começar.
ROLLOUT_STATE_CANCELLING O lançamento está sendo cancelado.
ROLLOUT_STATE_RESUMING O lançamento está sendo retomado.
ROLLOUT_STATE_PAUSING O lançamento está sendo pausado.

RolloutStats

RolloutStats contém informações sobre o progresso de um lançamento.

Representação JSON 
{
  "operationsByState": [
    {
      object (Aggregate)
    }
  ]
}
Campos
operationsByState[]

object (Aggregate)

Opcional. Apenas saída. Lista não ordenada. Um detalhamento do progresso das operações acionadas pelo lançamento. Fornece uma contagem de operações por estado. Isso pode ser usado para determinar o número de unidades que foram atualizadas ou estão programadas para serem atualizadas.

Haverá no máximo uma entrada por grupo. Os valores possíveis para grupos de operações são: "SCHEDULED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED" e "CANCELLED".

Agregar

Representa a agregação de um conjunto de população de registros semelhantes por um determinado grupo. Por exemplo, uma coleção de contagens de unidades pode ser agregada e agrupada por estado.

Representação JSON 
{
  "group": string,
  "count": integer
}
Campos
group

string

Obrigatório. Agrupamento por agregação.
count

integer

Obrigatório. Número de registros no grupo.

RolloutControl

O RolloutControl oferece uma maneira de solicitar uma mudança na execução de um Rollout pausando ou cancelando.

Representação JSON 
{
  "action": enum (RolloutAction),

  // Union field action_params can be only one of the following:
  "runParams": {
    object (RunRolloutActionParams)
  }
  // End of list of possible types for union field action_params.
}
Campos
action

enum (RolloutAction)

Obrigatório. Ação a ser realizada na implementação. O comportamento padrão é executar o lançamento até que ele atinja naturalmente um estado final.
Campo de união action_params. Configuração da ação. A configuração precisa corresponder à ação. Por exemplo, "action=RUN" só pode definir "run_params" ou omitir todos os parâmetros. É um erro definir uma configuração que não se aplica à ação. action_params pode ser apenas de um dos tipos a seguir:
runParams

object (RunRolloutActionParams)

Opcional. Parâmetros da ação RUN. É um erro especificar isso se o RolloutAction não estiver definido como RUN. Por padrão, o lançamento vai tentar novamente as operações com falha quando for retomado.

RunRolloutActionParams

Parâmetros para a ação RUN que controlam o comportamento do lançamento quando ele é retomado de um estado PAUSED.

Representação JSON 
{
  "retryFailedOperations": boolean
}
Campos
retryFailedOperations

boolean

Obrigatório. Se for "true", o lançamento vai tentar novamente as operações com falha quando for retomado. Isso só é aplicável se o estado atual do lançamento for PAUSED e a ação solicitada for RUN.

RolloutAction

"RolloutAction" indica a ação a ser realizada no rollout.

Tipos enumerados
ROLLOUT_ACTION_UNSPECIFIED Ação não especificada, será tratada como RUN por padrão.
ROLLOUT_ACTION_RUN Execute o lançamento até que ele atinja naturalmente um estado final. Um lançamento solicitado para execução vai progredir por todos os estados naturais de lançamento (como RUNNING -> SUCCEEDED ou RUNNING -> FAILED). Se erros passíveis de novas tentativas forem encontrados durante o lançamento, ele será pausado por padrão e poderá ser retomado solicitando novamente essa ação RUN.
ROLLOUT_ACTION_PAUSE Pause o lançamento até que ele seja retomado (ou seja, o comando RUN seja solicitado).
ROLLOUT_ACTION_CANCEL Cancela o lançamento permanentemente.

Métodos

create

 Crie um lançamento.

delete

 Exclui um único lançamento.

get

 Recupera um único lançamento.

list

 Recupera uma coleção de lançamentos.

patch

 Atualiza um único lançamento.