Google Cloud Deploy V1 Client - Class CustomTargetType (2.0.0)

Reference documentation and code samples for the Google Cloud Deploy V1 Client class CustomTargetType.

A CustomTargetType resource in the Cloud Deploy API.

A CustomTargetType defines a type of custom target that can be referenced in a Target in order to facilitate deploying to other systems besides the supported runtimes.

Generated from protobuf message google.cloud.deploy.v1.CustomTargetType

Namespace

Google \ Cloud \ Deploy \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Optional. Name of the CustomTargetType. Format is projects/{project}/locations/{location}/customTargetTypes/{customTargetType}. The customTargetType component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?
↳ custom_target_type_id string

Output only. Resource id of the CustomTargetType.
↳ uid string

Output only. Unique identifier of the CustomTargetType.
↳ description string

Optional. Description of the CustomTargetType. 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 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.
↳ create_time Google\Protobuf\Timestamp

Output only. Time at which the CustomTargetType was created.
↳ update_time Google\Protobuf\Timestamp

Output only. Most recent time at which the CustomTargetType was updated.
↳ 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.
↳ custom_actions Google\Cloud\Deploy\V1\CustomTargetSkaffoldActions

Configures render and deploy for the CustomTargetType using Skaffold custom actions.

getName

Optional. Name of the CustomTargetType. Format is projects/{project}/locations/{location}/customTargetTypes/{customTargetType}.

The customTargetType component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?

Returns
Type Description
string

setName

Optional. Name of the CustomTargetType. Format is projects/{project}/locations/{location}/customTargetTypes/{customTargetType}.

The customTargetType component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?

Parameter
Name Description
var string
Returns
Type Description
$this

getCustomTargetTypeId

Output only. Resource id of the CustomTargetType.

Returns
Type Description
string

setCustomTargetTypeId

Output only. Resource id of the CustomTargetType.

Parameter
Name Description
var string
Returns
Type Description
$this

getUid

Output only. Unique identifier of the CustomTargetType.

Returns
Type Description
string

setUid

Output only. Unique identifier of the CustomTargetType.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. Description of the CustomTargetType. Max length is 255 characters.

Returns
Type Description
string

setDescription

Optional. Description of the CustomTargetType. 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

getCreateTime

Output only. Time at which the CustomTargetType was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time at which the CustomTargetType was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Most recent time at which the CustomTargetType was updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Most recent time at which the CustomTargetType was updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
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

getCustomActions

Configures render and deploy for the CustomTargetType using Skaffold custom actions.

Returns
Type Description
Google\Cloud\Deploy\V1\CustomTargetSkaffoldActions|null

hasCustomActions

setCustomActions

Configures render and deploy for the CustomTargetType using Skaffold custom actions.

Parameter
Name Description
var Google\Cloud\Deploy\V1\CustomTargetSkaffoldActions
Returns
Type Description
$this

getDefinition

Returns
Type Description
string