REST Resource: projects.locations.customTargetTypes

Recurso: CustomTargetType

Um recurso CustomTargetType na API Cloud Deploy.

Um CustomTargetType define um tipo de destino personalizado que pode ser referenciado em um Target para facilitar a implantação em outros sistemas além dos ambientes de execução compatíveis.

Representação JSON
{
  "name": string,
  "customTargetTypeId": string,
  "uid": string,
  "description": string,
  "annotations": {
    string: string,
    ...
  },
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,

  // Union field definition can be only one of the following:
  "customActions": {
    object (CustomTargetSkaffoldActions)
  }
  // End of list of possible types for union field definition.
}
Campos
name

string

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

customTargetTypeId

string

Apenas saída. ID do recurso do CustomTargetType.

uid

string

Apenas saída. Identificador exclusivo do CustomTargetType.

description

string

Opcional. Descrição do CustomTargetType. 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" }.

createTime

string (Timestamp format)

Apenas saída. Horário em que o CustomTargetType 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 CustomTargetType.

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.

Campo de união definition. Define o renderizador e o implantador CustomTargetType. definition pode ser apenas de um dos tipos a seguir:
customActions

object (CustomTargetSkaffoldActions)

Configura a renderização e a implantação para o CustomTargetType usando ações personalizadas do Skaffold.

CustomTargetSkaffoldActions

CustomTargetSkaffoldActions representa a configuração CustomTargetType usando ações personalizadas do Skaffold.

Representação JSON
{
  "renderAction": string,
  "deployAction": string,
  "includeSkaffoldModules": [
    {
      object (SkaffoldModules)
    }
  ]
}
Campos
renderAction

string

Opcional. A ação personalizada do Skaffold responsável pelas operações de renderização. Se não for fornecido, o Cloud Deploy vai executar as operações de renderização usando skaffold render.

deployAction

string

Obrigatório. A ação personalizada do Skaffold responsável pelas operações de implantação.

includeSkaffoldModules[]

object (SkaffoldModules)

Opcional. Lista de módulos do Skaffold que o Cloud Deploy vai incluir no Skaffold Config conforme necessário antes de realizar o diagnóstico.

SkaffoldModules

módulos do Skaffold Config e a fonte remota deles;

Representação JSON
{
  "configs": [
    string
  ],

  // Union field source can be only one of the following:
  "git": {
    object (SkaffoldGitSource)
  },
  "googleCloudStorage": {
    object (SkaffoldGCSSource)
  },
  "googleCloudBuildRepo": {
    object (SkaffoldGCBRepoSource)
  }
  // End of list of possible types for union field source.
}
Campos
configs[]

string

Opcional. Os módulos do Skaffold Config que serão usados da origem especificada.

Campo de união source. A fonte que contém os módulos de configuração do Skaffold. source só pode ser de um dos seguintes tipos:
git

object (SkaffoldGitSource)

Repositório git remoto que contém os módulos de configuração do Skaffold.

googleCloudStorage

object (SkaffoldGCSSource)

Bucket do Cloud Storage que contém os módulos de configuração do Skaffold.

googleCloudBuildRepo

object (SkaffoldGCBRepoSource)

Repositório do Cloud Build V2 que contém os módulos de configuração do Skaffold.

SkaffoldGitSource

Repositório Git contendo módulos de configuração do Skaffold.

Representação JSON
{
  "repo": string,
  "path": string,
  "ref": string
}
Campos
repo

string

Obrigatório. Repositório Git do pacote que será clonado.

path

string

Opcional. O caminho relativo da raiz do repositório para o arquivo do Skaffold.

ref

string

Opcional. Ramificação ou tag do Git a ser usada ao clonar o repositório.

SkaffoldGCSSource

Bucket do Cloud Storage que contém módulos de configuração do Skaffold.

Representação JSON
{
  "source": string,
  "path": string
}
Campos
source

string

Obrigatório. Caminhos de origem do Cloud Storage para copiar recursivamente. Por exemplo, fornecer "gs://my-bucket/dir/configs/*" vai fazer com que o Skaffold copie todos os arquivos do diretório "dir/configs" no bucket "my-bucket".

path

string

Opcional. Caminho relativo da origem para o arquivo do Skaffold.

SkaffoldGCBRepoSource

Repositório do Cloud Build V2 contendo configurações do Skaffold.

Representação JSON
{
  "repository": string,
  "path": string,
  "ref": string
}
Campos
repository

string

Obrigatório. Nome do repositório do Cloud Build V2. O formato é projects/{project}/locations/{location}/connections/{connection}/repositories/{repository}.

path

string

Opcional. Caminho relativo da raiz do repositório para o arquivo de configuração do Skaffold.

ref

string

Opcional. Ramificação ou tag a ser usada ao clonar o repositório.

Métodos

create

Cria um novo CustomTargetType em um determinado projeto e local.

delete

Exclui um único CustomTargetType.

get

Recebe detalhes de um único CustomTargetType.

getIamPolicy

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

list

Lista os CustomTargetTypes em um determinado projeto e local.

patch

Atualiza um único CustomTargetType.

setIamPolicy

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