Google Cloud Deploy V1 Client - Class Release (1.5.0)

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

A Release resource in the Cloud Deploy API.

A Release defines a specific Skaffold configuration instance that can be deployed.

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

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 `Release`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`. The `release` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
`↳ uid`	`string` Output only. Unique identifier of the `Release`.
`↳ description`	`string` Description of the `Release`. Max length is 255 characters.
`↳ annotations`	`array\|Google\Protobuf\Internal\MapField` 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` 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.
`↳ abandoned`	`bool` Output only. Indicates whether this is an abandoned release.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Time at which the `Release` was created.
`↳ render_start_time`	`Google\Protobuf\Timestamp` Output only. Time at which the render began.
`↳ render_end_time`	`Google\Protobuf\Timestamp` Output only. Time at which the render completed.
`↳ skaffold_config_uri`	`string` Cloud Storage URI of tar.gz archive containing Skaffold configuration.
`↳ skaffold_config_path`	`string` Filepath of the Skaffold config inside of the config URI.
`↳ build_artifacts`	`array<BuildArtifact>` List of artifacts to pass through to Skaffold command.
`↳ delivery_pipeline_snapshot`	`DeliveryPipeline` Output only. Snapshot of the parent pipeline taken at release creation time.
`↳ target_snapshots`	`array<Target>` Output only. Snapshot of the targets taken at release creation time.
`↳ custom_target_type_snapshots`	`array<CustomTargetType>` Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.
`↳ render_state`	`int` Output only. Current state of the render operation.
`↳ etag`	`string` 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.
`↳ skaffold_version`	`string` Optional. The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set of versions. If unset, the most recent supported Skaffold version will be used.
`↳ target_artifacts`	`array\|Google\Protobuf\Internal\MapField` Output only. Map from target ID to the target artifacts created during the render operation.
`↳ target_renders`	`array\|Google\Protobuf\Internal\MapField` Output only. Map from target ID to details of the render operation for that target.
`↳ condition`	`Release\ReleaseCondition` Output only. Information around the state of the Release.
`↳ deploy_parameters`	`array\|Google\Protobuf\Internal\MapField` Optional. The deploy parameters to use for all targets in this release.

getName

Optional. Name of the Release. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}.

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

Returns
Type	Description
`string`

setName

Optional. Name of the Release. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUid

Output only. Unique identifier of the Release.

Returns
Type	Description
`string`

setUid

Output only. Unique identifier of the Release.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

Description of the Release. Max length is 255 characters.

Returns
Type	Description
`string`

setDescription

Description of the Release. Max length is 255 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAnnotations

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

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

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

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`

getAbandoned

Output only. Indicates whether this is an abandoned release.

Returns
Type	Description
`bool`

setAbandoned

Output only. Indicates whether this is an abandoned release.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getCreateTime

Output only. Time at which the Release was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time at which the Release was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getRenderStartTime

Output only. Time at which the render began.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasRenderStartTime

clearRenderStartTime

setRenderStartTime

Output only. Time at which the render began.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getRenderEndTime

Output only. Time at which the render completed.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasRenderEndTime

clearRenderEndTime

setRenderEndTime

Output only. Time at which the render completed.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getSkaffoldConfigUri

Cloud Storage URI of tar.gz archive containing Skaffold configuration.

Returns
Type	Description
`string`

setSkaffoldConfigUri

Cloud Storage URI of tar.gz archive containing Skaffold configuration.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSkaffoldConfigPath

Filepath of the Skaffold config inside of the config URI.

Returns
Type	Description
`string`

setSkaffoldConfigPath

Filepath of the Skaffold config inside of the config URI.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getBuildArtifacts

List of artifacts to pass through to Skaffold command.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setBuildArtifacts

List of artifacts to pass through to Skaffold command.

Parameter
Name	Description
`var`	`array<BuildArtifact>`

Returns
Type	Description
`$this`

getDeliveryPipelineSnapshot

Output only. Snapshot of the parent pipeline taken at release creation time.

Returns
Type	Description
`DeliveryPipeline\|null`

hasDeliveryPipelineSnapshot

clearDeliveryPipelineSnapshot

setDeliveryPipelineSnapshot

Output only. Snapshot of the parent pipeline taken at release creation time.

Parameter
Name	Description
`var`	`DeliveryPipeline`

Returns
Type	Description
`$this`

getTargetSnapshots

Output only. Snapshot of the targets taken at release creation time.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setTargetSnapshots

Output only. Snapshot of the targets taken at release creation time.

Parameter
Name	Description
`var`	`array<Target>`

Returns
Type	Description
`$this`

getCustomTargetTypeSnapshots

Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setCustomTargetTypeSnapshots

Output only. Snapshot of the custom target types referenced by the targets taken at release creation time.

Parameter
Name	Description
`var`	`array<CustomTargetType>`

Returns
Type	Description
`$this`

getRenderState

Output only. Current state of the render operation.

Returns
Type	Description
`int`

setRenderState

Output only. Current state of the render operation.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getEtag

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

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`

getSkaffoldVersion

Optional. The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set of versions.

If unset, the most recent supported Skaffold version will be used.

Returns
Type	Description
`string`

setSkaffoldVersion

Optional. The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set of versions.

If unset, the most recent supported Skaffold version will be used.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTargetArtifacts

Output only. Map from target ID to the target artifacts created during the render operation.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setTargetArtifacts

Output only. Map from target ID to the target artifacts created during the render operation.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getTargetRenders

Output only. Map from target ID to details of the render operation for that target.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setTargetRenders

Output only. Map from target ID to details of the render operation for that target.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getCondition

Output only. Information around the state of the Release.

Returns
Type	Description
`Release\ReleaseCondition\|null`

hasCondition

clearCondition

setCondition

Output only. Information around the state of the Release.

Parameter
Name	Description
`var`	`Release\ReleaseCondition`

Returns
Type	Description
`$this`

getDeployParameters

Optional. The deploy parameters to use for all targets in this release.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setDeployParameters

Optional. The deploy parameters to use for all targets in this release.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`