REST Resource: projects.locations.customTargetTypes

Recurso: CustomTargetType

Un recurso CustomTargetType en la API de Cloud Deploy.

Un CustomTargetType define un tipo de destino personalizado al que se puede hacer referencia en un Target para facilitar la implementación en otros sistemas además de los entornos de ejecución compatibles.

Representación 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. Es el nombre del CustomTargetType. El formato es projects/{project}/locations/{location}/customTargetTypes/{customTargetType}. El componente customTargetType debe coincidir con [a-z]([a-z0-9-]{0,61}[a-z0-9])?.
customTargetTypeId

string

Solo salida. Es el ID de recurso de CustomTargetType.
uid

string

Solo salida. Es el identificador único de CustomTargetType.
description

string

Opcional. Descripción de CustomTargetType. La longitud máxima es de 255 caracteres.
annotations

map (key: string, value: string)

Opcional. Anotaciones de usuario Solo el usuario puede configurar y usar estos atributos, no Cloud Deploy. Consulta https://google.aip.dev/128#annotations para obtener más detalles, como las limitaciones de formato y tamaño.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
labels

map (key: string, value: string)

Opcional. Las etiquetas son atributos que el usuario y Cloud Deploy pueden configurar y usar. Las etiquetas deben cumplir con las siguientes restricciones:

  • Las claves y los valores solo pueden contener letras minúsculas, caracteres numéricos, guiones bajos y guiones.
  • Todos los caracteres deben usar la codificación UTF-8 y se permiten los caracteres internacionales.
  • Las claves deben comenzar con una letra en minúscula o un carácter internacional.
  • Cada recurso tiene un límite de 64 etiquetas.

Las claves y los valores tienen restricciones adicionales para ser <= 128 bytes.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Solo salida. Hora a la que se creó el objeto CustomTargetType.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Solo salida. Hora más reciente en la que se actualizó CustomTargetType.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
etag

string

Opcional. El servidor calcula esta suma de comprobación en función del valor de otros campos, y es posible que se envíe en solicitudes de actualización y eliminación para garantizar que el cliente tenga un valor actualizado antes de continuar.
Campo de unión definition. Define el procesador y el implementador de CustomTargetType. definition puede ser solo uno de los siguientes:
customActions

object (CustomTargetSkaffoldActions)

Configura la renderización y la implementación para CustomTargetType con las acciones personalizadas de Skaffold.

CustomTargetSkaffoldActions

CustomTargetSkaffoldActions representa la configuración de CustomTargetType con acciones personalizadas de Skaffold.

Representación JSON 
{
  "renderAction": string,
  "deployAction": string,
  "includeSkaffoldModules": [
    {
      object (SkaffoldModules)
    }
  ]
}
Campos
renderAction

string

Opcional. La acción personalizada de Skaffold responsable de las operaciones de renderización. Si no se proporciona, Cloud Deploy realizará las operaciones de renderización mediante skaffold render.
deployAction

string

Obligatorio. La acción personalizada de Skaffold responsable de las operaciones de implementación.
includeSkaffoldModules[]

object (SkaffoldModules)

Opcional. Lista de módulos de Skaffold que Cloud Deploy incluirá en la configuración de Skaffold según sea necesario antes de realizar el diagnóstico.

SkaffoldModules

Módulos de Skaffold Config y su fuente remota.

Representación 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. Los módulos de configuración de Skaffold que se usarán de la fuente especificada.
Campo de unión source. Es la fuente que contiene los módulos de configuración de Skaffold. source puede ser solo uno de los siguientes:
git

object (SkaffoldGitSource)

Repositorio de Git remoto que contiene los módulos de configuración de Skaffold.
googleCloudStorage

object (SkaffoldGCSSource)

Bucket de Cloud Storage que contiene los módulos de configuración de Skaffold.
googleCloudBuildRepo

object (SkaffoldGCBRepoSource)

Repositorio de Cloud Build V2 que contiene los módulos de configuración de Skaffold.

SkaffoldGitSource

Repositorio de Git que contiene los módulos de configuración de Skaffold.

Representación JSON 
{
  "repo": string,
  "path": string,
  "ref": string
}
Campos
repo

string

Obligatorio. Es el repositorio de Git desde el que se debería clonar el paquete.
path

string

Opcional. Ruta de acceso relativa de la raíz del repositorio al archivo de Skaffold.
ref

string

Opcional. Rama o etiqueta de Git para usar cuando se clona el repositorio.

SkaffoldGCSSource

Bucket de Cloud Storage que contiene los módulos de configuración de Skaffold.

Representación JSON 
{
  "source": string,
  "path": string
}
Campos
source

string

Obligatorio. Rutas de acceso de origen de Cloud Storage para copiar de forma recursiva. Por ejemplo, si proporcionas “gs://my-bucket/dir/configs/*”, Skaffold copiará todos los archivos dentro del directorio “dir/configs” en el bucket “my-bucket”.
path

string

Opcional. Ruta de acceso relativa desde la fuente al archivo de Skaffold.

SkaffoldGCBRepoSource

Repositorio de Cloud Build V2 que contiene parámetros de configuración de Skaffold.

Representación JSON 
{
  "repository": string,
  "path": string,
  "ref": string
}
Campos
repository

string

Obligatorio. Nombre del repositorio de Cloud Build V2. El formato es projects/{project}/locations/{location}/connections/{connection}/repositories/{repository}.
path

string

Opcional. Ruta de acceso relativa de la raíz del repositorio al archivo de configuración de Skaffold.
ref

string

Opcional. Rama o etiqueta que se usa cuando se clona el repositorio.

Métodos

create

 Crea un CustomTargetType nuevo en una ubicación y proyecto determinados.

delete

 Borra un solo CustomTargetType.

get

 Obtiene detalles de un solo CustomTargetType.

getIamPolicy

 Permite obtener la política de control de acceso de un recurso.

list

 Muestra una lista de CustomTargetTypes en un proyecto y una ubicación determinados.

patch

 Actualiza un solo CustomTargetType.

setIamPolicy

 Permite configurar la política de control de acceso en el recurso especificado.