REST Resource: projects.locations.targets

Recurso: Target

Un recurso Target en la API de 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)
    }
  ],
  "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. Es el nombre del Target. El formato es projects/{project}/locations/{location}/targets/{target}. El componente target debe coincidir con [a-z]([a-z0-9-]{0,61}[a-z0-9])?.
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 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" }.
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.
deployParameters

map (key: string, value: string)

Opcional. Los parámetros de implementación que se usarán para este destino.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
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:
gke

object (GkeCluster)

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

object (AnthosCluster)

Opcional. Información que especifica un clúster de Anthos.
run

object (CloudRunLocation)

Opcional. Información que especifica un destino de implementación de Cloud Run.
multiTarget

object (MultiTarget)

Opcional. Información que especifica un multiTarget.
customTarget

object (CustomTarget)

Opcional. Información que especifica un objetivo personalizado.

GkeCluster

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

Representación JSON 
{
  "cluster": string,
  "internalIp": boolean
}
Campos
cluster

string

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

boolean

Opcional. Si es verdadero, se accede a cluster mediante la dirección IP privada del extremo del plano de control. De lo contrario, se usa la dirección IP predeterminada del extremo del plano de control. La dirección IP predeterminada es la dirección IP privada para los clústeres con extremos del plano de control privados y, de lo contrario, la dirección IP pública.

Solo especifica esta opción cuando cluster sea un clúster de GKE privado.

AnthosCluster

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

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

string

Opcional. Membresía del clúster registrado en GKE Hub al que se aplicará la configuración de Skaffold. El formato es projects/{project}/locations/{location}/memberships/{membership_name}.

CloudRunLocation

Información que especifica dónde implementar el servicio de Cloud Run.

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

string

Obligatorio. Es la ubicación del servicio de Cloud Run. El formato debe ser projects/{project}/locations/{location}.

MultiTarget

Información que especifica un multiTarget.

Representación JSON 
{
  "targetIds": [
    string
  ]
}
Campos
targetIds[]

string

Obligatorio. Los targetIds de este multiTarget.

CustomTarget

Información que especifica un objetivo personalizado.

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

string

Obligatorio. Es el nombre del CustomTargetType. El formato debe ser projects/{project}/locations/{location}/customTargetTypes/{customTargetType}.

ExecutionConfig

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

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

Obligatorio. Usos en los que se debe aplicar esta configuración.
workerPool

string

Opcional. El nombre del recurso de WorkerPool, con el formato projects/{project}/locations/{location}/workerPools/{workerPool}. Si no se especifica este campo opcional, se usará el grupo predeterminado de Cloud Build.
serviceAccount

string

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

string

Opcional. Ubicación de Cloud Storage en la que se almacenan 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.
executionTimeout

string (Duration format)

Opcional. Tiempo de espera de ejecución para Cloud Build Execution. Debe ser de entre 10 min y 24 h en formato de segundos. Si no se especifica, se usa un tiempo de espera predeterminado de 1 h.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".
verbose

boolean

Opcional. Si es verdadero, se habilitará el registro adicional para las ejecuciones de Cloud Build que se ejecuten en este entorno de ejecució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.
VERIFY Se usa para verificar la implementación.
PREDEPLOY Se usa para la ejecución de trabajos previos a la implementación.
POSTDEPLOY Se usa para la ejecución del trabajo posterior a la 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 solo destino.

get

 Obtiene detalles de un solo destino.

getIamPolicy

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

list

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

patch

 Actualiza los parámetros de un solo destino.

setIamPolicy

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

testIamPermissions

 Permite mostrar los permisos que tiene un emisor para un recurso específico.