Reference documentation and code samples for the Google Cloud Deploy V1 Client class Target.
A Target resource in the 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
Namespace
Google \ Cloud \ Deploy \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Optional. Name of the |
↳ target_id |
string
Output only. Resource id of the |
↳ uid |
string
Output only. Unique identifier of the |
↳ description |
string
Optional. Description of the |
↳ annotations |
array|Google\Protobuf\Internal\MapField
Optional. User annotations. These attributes can only be set and used by the user, and not by 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 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 |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time at which the |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Most recent time at which the |
↳ gke |
Google\Cloud\Deploy\V1\GkeCluster
Optional. Information specifying a GKE Cluster. |
↳ anthos_cluster |
Google\Cloud\Deploy\V1\AnthosCluster
Optional. Information specifying an Anthos Cluster. |
↳ run |
Google\Cloud\Deploy\V1\CloudRunLocation
Optional. Information specifying a Cloud Run deployment target. |
↳ multi_target |
Google\Cloud\Deploy\V1\MultiTarget
Optional. Information specifying a multiTarget. |
↳ 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 |
↳ deploy_parameters |
array|Google\Protobuf\Internal\MapField
Optional. The deploy parameters to use for this target. |
getName
Optional. Name of the Target. Format is
projects/{project}/locations/{location}/targets/[a-z][a-z0-9-]{0,62}.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Optional. Name of the Target. Format is
projects/{project}/locations/{location}/targets/[a-z][a-z0-9-]{0,62}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTargetId
Output only. Resource id of the Target.
| Returns | |
|---|---|
| Type | Description |
string | |
setTargetId
Output only. Resource id of the Target.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUid
Output only. Unique identifier of the Target.
| Returns | |
|---|---|
| Type | Description |
string | |
setUid
Output only. Unique identifier of the Target.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Optional. Description of the Target. Max length is 255 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Optional. Description of the Target. Max length is 255 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAnnotations
Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setAnnotations
Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
Optional. Labels are attributes that can be set and used by both the user and by 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
Optional. Labels are attributes that can be set and used by both the user and by 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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequireApproval
Optional. Whether or not the Target requires approval.
| Returns | |
|---|---|
| Type | Description |
bool | |
setRequireApproval
Optional. Whether or not the Target requires approval.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Time at which the Target was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time at which the Target was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Most recent time at which the Target was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Most recent time at which the Target was updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGke
Optional. Information specifying a GKE Cluster.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\GkeCluster|null | |
hasGke
setGke
Optional. Information specifying a GKE Cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Deploy\V1\GkeCluster
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAnthosCluster
Optional. Information specifying an Anthos Cluster.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\AnthosCluster|null | |
hasAnthosCluster
setAnthosCluster
Optional. Information specifying an Anthos Cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Deploy\V1\AnthosCluster
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRun
Optional. Information specifying a Cloud Run deployment target.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\CloudRunLocation|null | |
hasRun
setRun
Optional. Information specifying a Cloud Run deployment target.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Deploy\V1\CloudRunLocation
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMultiTarget
Optional. Information specifying a multiTarget.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\MultiTarget|null | |
hasMultiTarget
setMultiTarget
Optional. Information specifying a multiTarget.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Deploy\V1\MultiTarget
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Deploy\V1\ExecutionConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeployParameters
Optional. The deploy parameters to use for this target.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setDeployParameters
Optional. The deploy parameters to use for this target.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeploymentTarget
| Returns | |
|---|---|
| Type | Description |
string | |