REST Resource: projects.locations.targets

Recurso: Target

Um recurso Target na API Cloud Deploy.

Um Target define um local em que uma configuração do Skaffold pode ser implantada.

Representação JSON 
{
  "name": string,
  "targetId": string,
  "uid": string,
  "description": string,
  "annotations": {
    string: string,
    ...
  },
  "labels": {
    string: string,
    ...
  },
  "requireApproval": boolean,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "executionConfigs": [
    {
      object (ExecutionConfig)
    }
  ],
  "deployParameters": {
    string: string,
    ...
  },

  // Union field deployment_target can be only one of the following:
  "gke": {
    object (GkeCluster)
  },
  "anthosCluster": {
    object (AnthosCluster)
  },
  "run": {
    object (CloudRunLocation)
  },
  "multiTarget": {
    object (MultiTarget)
  },
  "customTarget": {
    object (CustomTarget)
  }
  // End of list of possible types for union field deployment_target.
}
Campos
name

string

Opcional. Nome da Target. O formato é projects/{project}/locations/{location}/targets/{target}. O componente target precisa corresponder a [a-z]([a-z0-9-]{0,61}[a-z0-9])?
targetId

string

Apenas saída. ID do recurso do Target.
uid

string

Apenas saída. Identificador exclusivo do Target.
description

string

Opcional. Descrição do Target. O comprimento máximo é de 255 caracteres.
annotations

map (key: string, value: string)

Opcional. Anotações do usuário. Esses atributos só podem ser definidos e usados pelo usuário, e não pelo Cloud Deploy. Consulte https://google.aip.dev/128#annotations para ver mais detalhes sobre limitações de formato e tamanho.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
labels

map (key: string, value: string)

Opcional. Rótulos são atributos que podem ser definidos e usados pelo usuário e pelo Cloud Deploy. Os rótulos precisam atender às seguintes restrições:

  • As chaves e os valores podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços.
  • Todos os caracteres precisam usar a codificação UTF-8. Caracteres internacionais são permitidos.
  • As chaves precisam começar com uma letra minúscula ou um caractere internacional.
  • Cada recurso está limitado a um máximo de 64 rótulos.

As chaves e os valores são restritos a <= 128 bytes.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
requireApproval

boolean

Opcional. Se o Target requer aprovação ou não.
createTime

string (Timestamp format)

Apenas saída. Horário em que o Target foi criado.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Apenas saída. Horário mais recente de atualização do Target.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
etag

string

Opcional. Essa soma de verificação é calculada pelo servidor com base no valor de outros campos e pode ser enviada em solicitações de atualização e exclusão para garantir que o cliente tenha um valor atualizado antes de continuar.
executionConfigs[]

object (ExecutionConfig)

Configurações para todas as execuções relacionadas a Target. Cada valor de ExecutionEnvironmentUsage só pode ser usado em uma única configuração. Usar o mesmo valor várias vezes é um erro. Quando uma ou mais configurações são especificadas, elas precisam incluir os valores RENDER e DEPLOY ExecutionEnvironmentUsage. Quando nenhuma configuração for especificada, a execução usará o padrão especificado em DefaultPool.
deployParameters

map (key: string, value: string)

Opcional. Os parâmetros de implantação a serem usados para esse destino.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Campo de união deployment_target. Destino ao qual a configuração do Skaffold é aplicada durante um lançamento. deployment_target só pode ser de um dos seguintes tipos:
gke

object (GkeCluster)

Opcional. Informações que especificam um cluster do GKE.
anthosCluster

object (AnthosCluster)

Opcional. Informações que especificam um cluster do Anthos.
run

object (CloudRunLocation)

Opcional. Informações que especificam um destino de implantação do Cloud Run.
multiTarget

object (MultiTarget)

Opcional. Informações que especificam um multiTarget.
customTarget

object (CustomTarget)

Opcional. Informações que especificam um destino personalizado.

GkeCluster

Informações que especificam um cluster do GKE.

Representação JSON 
{
  "cluster": string,
  "internalIp": boolean
}
Campos
cluster

string

Opcional. Informações que especificam um cluster do GKE. O formato é projects/{projectId}/locations/{locationId}/clusters/{cluster_id}.
internalIp

boolean

Opcional. Se verdadeiro, cluster será acessado usando o endereço IP particular do endpoint do plano de controle. Caso contrário, o endereço IP padrão do endpoint do plano de controle será usado. O endereço IP padrão é o particular para clusters com endpoints do plano de controle particular. Caso contrário, o endereço IP é público.

Especifique essa opção apenas quando cluster for um cluster particular do GKE.

AnthosCluster

Informações que especificam um cluster do Anthos.

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

string

Opcional. Associação do cluster registrado no GKE Hub ao qual aplicar a configuração do Skaffold. O formato é projects/{project}/locations/{location}/memberships/{membership_name}.

CloudRunLocation

Informações que especificam onde implantar um serviço do Cloud Run.

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

string

Obrigatório. O local do serviço do Cloud Run. O formato precisa ser projects/{project}/locations/{location}.

MultiTarget

Informações que especificam um multiTarget.

Representação JSON 
{
  "targetIds": [
    string
  ]
}
Campos
targetIds[]

string

Obrigatório. Os targetIds desse multiTarget.

CustomTarget

Informações que especificam um destino personalizado.

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

string

Obrigatório. O nome do CustomTargetType. O formato precisa ser projects/{project}/locations/{location}/customTargetTypes/{customTargetType}.

ExecutionConfig

Configuração do ambiente a ser usado ao chamar o Skaffold.

Representação JSON 
{
  "usages": [
    enum (ExecutionEnvironmentUsage)
  ],
  "workerPool": string,
  "serviceAccount": string,
  "artifactStorage": string,
  "executionTimeout": string,
  "verbose": boolean,

  // Union field execution_environment can be only one of the following:
  "defaultPool": {
    object (DefaultPool)
  },
  "privatePool": {
    object (PrivatePool)
  }
  // End of list of possible types for union field execution_environment.
}
Campos
usages[]

enum (ExecutionEnvironmentUsage)

Obrigatório. Usos em que esta configuração precisa ser aplicada.
workerPool

string

Opcional. O nome do recurso da WorkerPool, com o formato projects/{project}/locations/{location}/workerPools/{workerPool}. Se esse campo opcional não for especificado, o pool do Cloud Build padrão será usado.
serviceAccount

string

Opcional. a conta de serviço do Google a ser usada para execução. Se não for especificada, a conta de serviço de execução do projeto (-compute@developer.gserviceaccount.com) será usada.
artifactStorage

string

Opcional. Local do Cloud Storage em que as saídas de execução são armazenadas. Pode ser um bucket ("gs://my-bucket") ou um caminho dentro de um bucket ("gs://my-bucket/my-dir"). Se não for especificado, será usado um bucket padrão localizado na mesma região.
executionTimeout

string (Duration format)

Opcional. Tempo limite de execução do Cloud Build. Precisa ser entre 10 e 24 horas no formato de segundos. Se não for especificado, o tempo limite padrão de 1h será usado.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
verbose

boolean

Opcional. Se verdadeiro, a geração de registros adicional será ativada para execuções do Cloud Build em execução nesse ambiente.
Campo de união execution_environment. Detalhes do ambiente. execution_environment só pode ser de um dos seguintes tipos:
defaultPool

object (DefaultPool)

Opcional. Usar o pool padrão do Cloud Build.
privatePool

object (PrivatePool)

Opcional. Usar o pool particular do Cloud Build.

ExecutionEnvironmentUsage

Possíveis usos desta configuração.

Tipos enumerados
EXECUTION_ENVIRONMENT_USAGE_UNSPECIFIED Valor padrão. Esse valor não é usado.
RENDER Use para renderização.
DEPLOY Use para implantar e implantar hooks.
VERIFY Use para verificação da implantação.
PREDEPLOY Use para a execução do job de pré-implantação.
POSTDEPLOY Use para a execução do job pós-implantação.

DefaultPool

Execução usando o pool padrão do Cloud Build.

Representação JSON 
{
  "serviceAccount": string,
  "artifactStorage": string
}
Campos
serviceAccount

string

Opcional. a conta de serviço do Google a ser usada para execução. Se não for especificada, a conta de serviço de execução do projeto (-compute@developer.gserviceaccount.com) será usada.
artifactStorage

string

Opcional. Local do Cloud Storage em que as saídas da execução precisam ser armazenadas. Pode ser um bucket ("gs://my-bucket") ou um caminho dentro de um bucket ("gs://my-bucket/my-dir"). Se não for especificado, será usado um bucket padrão localizado na mesma região.

PrivatePool

Execução usando um pool particular do Cloud Build.

Representação JSON 
{
  "workerPool": string,
  "serviceAccount": string,
  "artifactStorage": string
}
Campos
workerPool

string

Obrigatório. Nome do recurso do pool de workers do Cloud Build a ser usado. O formato é projects/{project}/locations/{location}/workerPools/{pool}.
serviceAccount

string

Opcional. a conta de serviço do Google a ser usada para execução. Se não for especificada, a conta de serviço de execução do projeto (-compute@developer.gserviceaccount.com) será usada.
artifactStorage

string

Opcional. Local do Cloud Storage em que as saídas da execução precisam ser armazenadas. Pode ser um bucket ("gs://my-bucket") ou um caminho dentro de um bucket ("gs://my-bucket/my-dir"). Se não for especificado, será usado um bucket padrão localizado na mesma região.

Métodos

create

 Cria um novo destino em um determinado projeto e local.

delete

 Exclui um único destino.

get

 Recebe detalhes de um único destino.

getIamPolicy

 Busca a política de controle de acesso de um recurso.

list

 Lista os destinos em um determinado projeto e local.

patch

 Atualiza os parâmetros de um único destino.

setIamPolicy

 Define a política de controle de acesso no recurso especificado.

testIamPermissions

 Retorna permissões do autor da chamada no recurso especificado.