Reference documentation and code samples for the Google Cloud Deploy V1 Client class Target.
A Target
resource in the Google Cloud Deploy API.
A Target
defines a location to which a Skaffold configuration
can be deployed.
Generated from protobuf message google.cloud.deploy.v1.Target
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Optional. Name of the Target
. Format is projects/{project}/locations/{location}/targets/[a-z][a-z0-9-]{0,62}.
↳ target_id
string
Output only. Resource id of the Target
.
↳ uid
string
Output only. Unique identifier of the Target
.
↳ description
string
Optional. Description of the Target
. Max length is 255 characters.
↳ annotations
array| Google\Protobuf\Internal\MapField
Optional. User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
↳ labels
array| Google\Protobuf\Internal\MapField
Optional. Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
↳ require_approval
bool
Optional. Whether or not the Target
requires approval.
↳ create_time
↳ update_time
↳ gke
↳ anthos_cluster
↳ run
↳ multi_target
↳ etag
string
Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
↳ execution_configs
array< Google\Cloud\Deploy\V1\ExecutionConfig
>
Configurations for all execution that relates to this Target
. Each ExecutionEnvironmentUsage
value may only be used in a single configuration; using the same value multiple times is an error. When one or more configurations are specified, they must include the RENDER
and DEPLOY
ExecutionEnvironmentUsage
values. When no configurations are specified, execution will use the default specified in DefaultPool
.
getName
Optional. Name of the Target
. Format is
projects/{project}/locations/{location}/targets/[a-z][a-z0-9-]{0,62}.
string
setName
Optional. Name of the Target
. Format is
projects/{project}/locations/{location}/targets/[a-z][a-z0-9-]{0,62}.
var
string
$this
getTargetId
Output only. Resource id of the Target
.
string
setTargetId
Output only. Resource id of the Target
.
var
string
$this
getUid
Output only. Unique identifier of the Target
.
string
setUid
Output only. Unique identifier of the Target
.
var
string
$this
getDescription
Optional. Description of the Target
. Max length is 255 characters.
string
setDescription
Optional. Description of the Target
. Max length is 255 characters.
var
string
$this
getAnnotations
Optional. User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
setAnnotations
Optional. User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
$this
getLabels
Optional. Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints:
-
Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
-
All characters must use UTF-8 encoding, and international characters are allowed.
- Keys must start with a lowercase letter or international character.
- Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
setLabels
Optional. Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints:
-
Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
-
All characters must use UTF-8 encoding, and international characters are allowed.
- Keys must start with a lowercase letter or international character.
- Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
$this
getRequireApproval
Optional. Whether or not the Target
requires approval.
bool
setRequireApproval
Optional. Whether or not the Target
requires approval.
var
bool
$this
getCreateTime
Output only. Time at which the Target
was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time at which the Target
was created.
$this
getUpdateTime
Output only. Most recent time at which the Target
was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Most recent time at which the Target
was updated.
$this
getGke
Information specifying a GKE Cluster.
hasGke
setGke
Information specifying a GKE Cluster.
$this
getAnthosCluster
Information specifying an Anthos Cluster.
hasAnthosCluster
setAnthosCluster
Information specifying an Anthos Cluster.
$this
getRun
Information specifying a Cloud Run deployment target.
hasRun
setRun
Information specifying a Cloud Run deployment target.
$this
getMultiTarget
Information specifying a multiTarget.
hasMultiTarget
setMultiTarget
Information specifying a multiTarget.
$this
getEtag
Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
string
setEtag
Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
var
string
$this
getExecutionConfigs
Configurations for all execution that relates to this Target
.
Each ExecutionEnvironmentUsage
value may only be used in a single
configuration; using the same value multiple times is an error.
When one or more configurations are specified, they must include the RENDER
and DEPLOY
ExecutionEnvironmentUsage
values.
When no configurations are specified, execution will use the default
specified in DefaultPool
.
setExecutionConfigs
Configurations for all execution that relates to this Target
.
Each ExecutionEnvironmentUsage
value may only be used in a single
configuration; using the same value multiple times is an error.
When one or more configurations are specified, they must include the RENDER
and DEPLOY
ExecutionEnvironmentUsage
values.
When no configurations are specified, execution will use the default
specified in DefaultPool
.
$this
getDeploymentTarget
string
