REST Resource: projects.locations.deliveryPipelines.targets

资源:Target

Google Cloud Deploy API 中的 Target 资源。

Target 定义可部署 Skaffold 配置的位置。

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.
}
字段
name

string

可选。Target 的名称。格式为 projects/{project}/locations/{location}/ deliveryPipelines/{deliveryPipeline}/targets/[a-z][a-z0-9-]{0,62}。

targetId

string

仅限输出。Target 的资源 ID。

uid

string

仅限输出。Target 的唯一标识符。

description

string

可选。Target 的说明。长度上限为 255 个字符。

annotations

map (key: string, value: string)

可选。用户注释。这些属性只能由用户设置和使用,Google Cloud Deploy 不能进行设置和使用。如需了解详情(例如格式和大小限制),请参阅 https://google.aip.dev/128#annotations

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

labels

map (key: string, value: string)

可选。标签是用户和 Google Cloud Deploy 可以设置和使用的属性。标签必须满足以下限制条件:每项资源最多只能包含 64 个标签。键必须符合正则表达式:[a-zA-Z][a-zA-Z0-9_-]{0,62} 值必须符合正则表达式:[a-zA-Z0-9_-]{0,63}。此外,键和值的大小都不得超过 128 个字节。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

requireApproval

boolean

可选。Target 是否需要批准。

createTime

string (Timestamp format)

仅限输出。Target 的创建时间。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

仅限输出。Target 的最近更新时间。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

etag

string

可选。此校验和由服务器根据其他字段的值计算,并且可能会在更新和删除请求时发送,以确保客户端在继续操作之前拥有最新的值。

executionConfigs[]

object (ExecutionConfig)

与此 Target 相关的所有执行的配置。每个 ExecutionEnvironmentUsage 值只能在一项配置中使用;多次使用相同的值是错误的。如果指定了一项或多项配置,这些配置必须包含 RENDERDEPLOY ExecutionEnvironmentUsage 值。如果未指定任何配置,执行将使用 DefaultPool 中指定的默认值。

联合字段 deployment_target。在发布期间应用 Skaffold 配置的目标位置。deployment_target 只能是下列其中一项:
gkeCluster

object (GKECluster)

指定 GKE 集群的信息。

cluster

object (GkeCluster)

指定 GKE 集群的信息。

gke

object (GkeCluster)

指定 GKE 集群的信息。

GKECluster

指定 GKE 集群的信息。

JSON 表示法
{
  "project": string,
  "cluster": string,
  "location": string
}
字段
project

string

集群所在的项目。

cluster

string

集群的名称

location

string

集群的位置。

GkeCluster

指定 GKE 集群的信息。

JSON 表示法
{
  "cluster": string
}
字段
cluster

string

指定 GKE 集群的信息。格式为“projects/{projectId}/locations/{locationId}/clusters/{cluster_id}”。

ExecutionConfig

配置调用 Skaffold 时使用的环境。

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.
}
字段
usages[]

enum (ExecutionEnvironmentUsage)

必需。应该应用此配置时使用的使用情况。

联合字段 execution_environment。环境的详细信息。execution_environment 只能是下列其中一项:
defaultPool

object (DefaultPool)

可选。使用默认 Cloud Build 池。

privatePool

object (PrivatePool)

可选。使用专用 Cloud Build 池。

ExecutionEnvironmentUsage

此配置的可能用法。

枚举
EXECUTION_ENVIRONMENT_USAGE_UNSPECIFIED 默认值。此值未使用。
RENDER 用于渲染。
DEPLOY 用于部署和部署钩子。

DefaultPool

使用默认 Cloud Build 池执行。

JSON 表示法
{
  "serviceAccount": string,
  "artifactStorage": string
}
字段
serviceAccount

string

可选。用于执行的 Google 服务帐号。如果未指定,系统将使用项目执行服务帐号 (-compute@developer.gserviceaccount.com)

artifactStorage

string

可选。应存储执行输出的 Cloud Storage 位置。这可以是存储桶(“gs://my-bucket”)或存储桶中的路径(“gs://my-bucket/my-dir”)。如果未指定,系统将使用位于同一区域的默认存储桶。

PrivatePool

使用专用 Cloud Build 池执行。

JSON 表示法
{
  "workerPool": string,
  "serviceAccount": string,
  "artifactStorage": string
}
字段
workerPool

string

必需。要使用的 Cloud Build 工作器池的资源名称。格式为 projects/{project}/locations/{location}/workerPools/{pool}

serviceAccount

string

可选。用于执行的 Google 服务帐号。如果未指定,系统将使用项目执行服务帐号 (-compute@developer.gserviceaccount.com)

artifactStorage

string

可选。应存储执行输出的 Cloud Storage 位置。这可以是存储桶(“gs://my-bucket”)或存储桶中的路径(“gs://my-bucket/my-dir”)。如果未指定,系统将使用位于同一区域的默认存储桶。

方法

create

在给定的项目和位置中创建新目标。

delete

删除单个共享目标。

get

获取单个共享目标的详细信息。

list

列出给定项目和位置中的目标。

patch

更新单个共享目标的参数。