REST Resource: projects.locations.deliveryPipelines.targets

Recurso: Target

Un recurso Target en la API de Google Cloud Deploy

Un elemento Target define una ubicación en la que se puede implementar una configuración de Skaffold.

Representación 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)
    }
  ],

  // Union field deployment_target can be only one of the following:
  "gkeCluster": {
    object (GKECluster)
  },
  "cluster": {
    object (GkeCluster)
  },
  "gke": {
    object (GkeCluster)
  }
  // End of list of possible types for union field deployment_target.
}
Campos
name

string

Opcional. Es el nombre del Target. El formato es projects/{project}/locations/{location}/ deliveryPipelines/{deliveryPipeline}/targets/[a-z][a-z0-9-]{0,62}.
targetId

string

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

string

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

string

Opcional. Descripción de Target. 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 Google 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 Google Cloud Deploy pueden configurar y usar. Las etiquetas deben cumplir con las siguientes restricciones: cada recurso tiene un límite de 64 etiquetas. Las claves deben cumplir con la regexp: [a-zA-Z][a-zA-Z0-9_-]{0,62} Los valores deben cumplir con la regexp: [a-zA-Z0-9_-]{0,63} Las claves y los valores tienen una limitación adicional de <= 128 bytes de tamaño.

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

boolean

Opcional. Indica si Target requiere aprobación o no.
createTime

string (Timestamp format)

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

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ó Target.

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.
executionConfigs[]

object (ExecutionConfig)

Configuraciones de todas las ejecuciones relacionadas con este Target. Cada valor de ExecutionEnvironmentUsage solo se puede usar en una única configuración. Si usas el mismo valor varias veces, se generará un error. Cuando se especifican uno o más parámetros de configuración, deben incluir los valores RENDER y DEPLOY ExecutionEnvironmentUsage. Si no se especifican parámetros de configuración, la ejecución usará el valor predeterminado especificado en DefaultPool.
Campo de unión deployment_target. El destino al que se aplica la configuración de Skaffold durante un lanzamiento. deployment_target puede ser solo uno de los siguientes:
gkeCluster

object (GKECluster)

Información que especifica un clúster de GKE.
cluster

object (GkeCluster)

Información que especifica un clúster de GKE.
gke

object (GkeCluster)

Información que especifica un clúster de GKE.

GKECluster

Información que especifica un clúster de GKE.

Representación JSON 
{
  "project": string,
  "cluster": string,
  "location": string
}
Campos
project

string

Proyecto en el que se encuentra el clúster.
cluster

string

Nombre del clúster.
location

string

Ubicación del clúster.

GkeCluster

Información que especifica un clúster de GKE.

Representación JSON 
{
  "cluster": string
}
Campos
cluster

string

Información que especifica un clúster de GKE. El formato es `projects/{projectId}/locations/{locationId}/clusters/{cluster_id}.

ExecutionConfig

Configuración del entorno que se usará cuando se llame a Skaffold.

Representación JSON 
{
  "usages": [
    enum (ExecutionEnvironmentUsage)
  ],

  // 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)

Obligatorio. Usos en los que se debe aplicar esta configuración.
Campo de unión execution_environment. Detalles del entorno. execution_environment puede ser solo uno de los siguientes:
defaultPool

object (DefaultPool)

Opcional. Usa el grupo predeterminado de Cloud Build.
privatePool

object (PrivatePool)

Opcional. Usa el grupo privado de Cloud Build.

ExecutionEnvironmentUsage

Posibles usos de esta configuración.

Enums
EXECUTION_ENVIRONMENT_USAGE_UNSPECIFIED Valor predeterminado Este valor no se usa.
RENDER Se usa para la renderización.
DEPLOY Se usa para la implementación y los hooks de implementación.

DefaultPool

Ejecución con el grupo predeterminado de Cloud Build.

Representación JSON 
{
  "serviceAccount": string,
  "artifactStorage": string
}
Campos
serviceAccount

string

Opcional. Cuenta de servicio de Google para usar en la ejecución. Si no se especifica, se usará la cuenta de servicio de ejecución del proyecto (-compute@developer.gserviceaccount.com).
artifactStorage

string

Opcional. Ubicación de Cloud Storage donde se deben almacenar los resultados de la ejecución. Puede ser un bucket (“gs://my-bucket”) o una ruta dentro de un bucket (“gs://my-bucket/my-dir”). Si no se especifica, se usará un bucket predeterminado ubicado en la misma región.

PrivatePool

Ejecución con un grupo privado de Cloud Build.

Representación JSON 
{
  "workerPool": string,
  "serviceAccount": string,
  "artifactStorage": string
}
Campos
workerPool

string

Obligatorio. Nombre del recurso del grupo de trabajadores de Cloud Build que se usará. El formato es projects/{project}/locations/{location}/workerPools/{pool}.
serviceAccount

string

Opcional. Cuenta de servicio de Google para usar en la ejecución. Si no se especifica, se usará la cuenta de servicio de ejecución del proyecto (-compute@developer.gserviceaccount.com).
artifactStorage

string

Opcional. Ubicación de Cloud Storage donde se deben almacenar los resultados de la ejecución. Puede ser un bucket (“gs://my-bucket”) o una ruta dentro de un bucket (“gs://my-bucket/my-dir”). Si no se especifica, se usará un bucket predeterminado ubicado en la misma región.

Métodos

create

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

delete

 Borra un único destino compartido.

get

 Obtiene los detalles de un único destino compartido.

list

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

patch

 Actualiza los parámetros de un único Target compartido.