Google Cloud Build V1 Client - Class Artifacts (0.5.1)

Reference documentation and code samples for the Google Cloud Build V1 Client class Artifacts.

Artifacts produced by a build that should be uploaded upon successful completion of all build steps.

Generated from protobuf message google.devtools.cloudbuild.v1.Artifacts

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ images array

A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.

↳ objects Google\Cloud\Build\V1\Artifacts\ArtifactObjects

A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE.

↳ maven_artifacts array<Google\Cloud\Build\V1\Artifacts\MavenArtifact>

A list of Maven artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. Artifacts in the workspace matching specified paths globs will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any artifacts fail to be pushed, the build is marked FAILURE.

↳ python_packages array<Google\Cloud\Build\V1\Artifacts\PythonPackage>

A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE.

getImages

A list of images to be pushed upon the successful completion of all build steps.

The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setImages

A list of images to be pushed upon the successful completion of all build steps.

The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getObjects

A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps.

Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE.

Returns
TypeDescription
Google\Cloud\Build\V1\Artifacts\ArtifactObjects|null

hasObjects

clearObjects

setObjects

A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps.

Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE.

Parameter
NameDescription
var Google\Cloud\Build\V1\Artifacts\ArtifactObjects
Returns
TypeDescription
$this

getMavenArtifacts

A list of Maven artifacts to be uploaded to Artifact Registry upon successful completion of all build steps.

Artifacts in the workspace matching specified paths globs will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any artifacts fail to be pushed, the build is marked FAILURE.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMavenArtifacts

A list of Maven artifacts to be uploaded to Artifact Registry upon successful completion of all build steps.

Artifacts in the workspace matching specified paths globs will be uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any artifacts fail to be pushed, the build is marked FAILURE.

Parameter
NameDescription
var array<Google\Cloud\Build\V1\Artifacts\MavenArtifact>
Returns
TypeDescription
$this

getPythonPackages

A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps.

The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setPythonPackages

A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps.

The build service account credentials will be used to perform the upload. If any objects fail to be pushed, the build is marked FAILURE.

Parameter
NameDescription
var array<Google\Cloud\Build\V1\Artifacts\PythonPackage>
Returns
TypeDescription
$this