API documentation for devtools.cloudbuild_v1.types package.
Classes
ArtifactResult
An artifact that was uploaded during a build. This is a single record in the artifact manifest JSON file.
Artifacts
Artifacts produced by a build that should be uploaded upon successful completion of all build steps.
Build
A build resource in the Cloud Build API.
At a high level, a Build describes where to find source code,
how to build it (for example, the builder image to run on the
source), and where to store the built artifacts.
Fields can include the following variables, which will be expanded when the build is created:
- $PROJECT_ID: the project ID of the build.
- $PROJECT_NUMBER: the project number of the build.
- $BUILD_ID: the autogenerated ID of the build.
- $REPO_NAME: the source repository name specified by RepoSource.
- $BRANCH_NAME: the branch name specified by RepoSource.
- $TAG_NAME: the tag name specified by RepoSource.
- $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag.
- $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
BuildOperationMetadata
Metadata for build operations. .. attribute:: build
The build that the operation is tracking.
:type: google.cloud.devtools.cloudbuild_v1.types.Build
BuildOptions
Optional arguments to enable specific features of builds. .. attribute:: source_provenance_hash
Requested hash for SourceProvenance.
:type: Sequence[google.cloud.devtools.cloudbuild_v1.types.Hash.HashType]
BuildStep
A step in the build pipeline. .. attribute:: name
Required. The name of the container image that will run this particular build step.
If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary.
The Docker daemon's cache will already have the latest versions of all of the officially supported build steps (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them.
If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.
:type: str
BuildTrigger
Configuration for an automated build in response to source repository changes.
BuiltImage
An image built by the pipeline. .. attribute:: name
Name used to push the container image to Google Container
Registry, as presented to docker push.
:type: str
CancelBuildRequest
Request to cancel an ongoing build. .. attribute:: name
The name of the Build to cancel. Format:
projects/{project}/locations/{location}/builds/{build}
:type: str
CreateBuildRequest
Request to create a new build. .. attribute:: parent
The parent resource where this build will be created.
Format: projects/{project}/locations/{location}
:type: str
CreateBuildTriggerRequest
Request to create a new BuildTrigger.
.. attribute:: project_id
Required. ID of the project for which to configure automatic builds.
:type: str
CreateWorkerPoolRequest
Request to create a new WorkerPool.
.. attribute:: parent
ID of the parent project.
:type: str
DeleteBuildTriggerRequest
Request to delete a BuildTrigger.
.. attribute:: project_id
Required. ID of the project that owns the trigger.
:type: str
DeleteWorkerPoolRequest
Request to delete a WorkerPool.
.. attribute:: name
The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name".
:type: str
FileHashes
Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.
GetBuildRequest
Request to get a build. .. attribute:: name
The name of the Build to retrieve. Format:
projects/{project}/locations/{location}/builds/{build}
:type: str
GetBuildTriggerRequest
Returns the BuildTrigger with the specified ID.
.. attribute:: project_id
Required. ID of the project that owns the trigger.
:type: str
GetWorkerPoolRequest
Request to get a WorkerPool with the specified name.
.. attribute:: name
The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name".
:type: str
GitHubEventsConfig
GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental.
Hash
Container message for hash values. .. attribute:: type_
The type of hash that was performed.
:type: google.cloud.devtools.cloudbuild_v1.types.Hash.HashType
InlineSecret
Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.
ListBuildTriggersRequest
Request to list existing BuildTriggers.
.. attribute:: project_id
Required. ID of the project for which to list BuildTriggers.
:type: str
ListBuildTriggersResponse
Response containing existing BuildTriggers.
.. attribute:: triggers
BuildTriggers for the project, sorted by create_time
descending.
:type: Sequence[google.cloud.devtools.cloudbuild_v1.types.BuildTrigger]
ListBuildsRequest
Request to list builds. .. attribute:: parent
The parent of the collection of Builds. Format:
projects/{project}/locations/location
:type: str
ListBuildsResponse
Response including listed builds. .. attribute:: builds
Builds will be sorted by create_time, descending.
:type: Sequence[google.cloud.devtools.cloudbuild_v1.types.Build]
ListWorkerPoolsRequest
Request to list WorkerPools.
.. attribute:: parent
ID of the parent project.
:type: str
ListWorkerPoolsResponse
Response containing existing WorkerPools.
.. attribute:: worker_pools
WorkerPools for the project.
:type: Sequence[google.cloud.devtools.cloudbuild_v1.types.WorkerPool]
Network
Network describes the GCP network used to create workers in. .. attribute:: project_id
Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id.
:type: str
PubsubConfig
PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.
PullRequestFilter
PullRequestFilter contains filter properties for matching GitHub Pull Requests.
PushFilter
Push contains filter properties for matching GitHub git pushes.
ReceiveTriggerWebhookRequest
ReceiveTriggerWebhookRequest [Experimental] is the request object accepted by the ReceiveTriggerWebhook method.
ReceiveTriggerWebhookResponse
ReceiveTriggerWebhookResponse [Experimental] is the response object for the ReceiveTriggerWebhook method.
RepoSource
Location of the source in a Google Cloud Source Repository. .. attribute:: project_id
ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
:type: str
Results
Artifacts created by the build pipeline. .. attribute:: images
Container images that were built as a part of the build.
:type: Sequence[google.cloud.devtools.cloudbuild_v1.types.BuiltImage]
RetryBuildRequest
Specifies a build to retry. .. attribute:: name
The name of the Build to retry. Format:
projects/{project}/locations/{location}/builds/{build}
:type: str
RunBuildTriggerRequest
Specifies a build trigger to run and the source to use. .. attribute:: project_id
Required. ID of the project.
:type: str
Secret
Pairs a set of secret environment variables containing encrypted
values with the Cloud KMS key to use to decrypt the value. Note: Use
kmsKeyName with available_secrets instead of using
kmsKeyName with secret. For instructions see:
https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.
SecretManagerSecret
Pairs a secret environment variable with a SecretVersion in Secret Manager.
Secrets
Secrets and secret environment variables. .. attribute:: secret_manager
Secrets in Secret Manager and associated secret environment variable.
:type: Sequence[google.cloud.devtools.cloudbuild_v1.types.SecretManagerSecret]
Source
Location of the source in a supported storage service. .. attribute:: storage_source
If provided, get the source from this location in Google Cloud Storage.
:type: google.cloud.devtools.cloudbuild_v1.types.StorageSource
SourceProvenance
Provenance of the source. Ways to find the original source, or verify that some source was used for this build.
StorageSource
Location of the source in an archive file in Google Cloud Storage.
StorageSourceManifest
Location of the source manifest in Google Cloud Storage. This feature is in Preview.
TimeSpan
Start and end times for a build execution phase. .. attribute:: start_time
Start of time span.
:type: google.protobuf.timestamp_pb2.Timestamp
UpdateBuildTriggerRequest
Request to update an existing BuildTrigger.
.. attribute:: project_id
Required. ID of the project that owns the trigger.
:type: str
UpdateWorkerPoolRequest
Request to update a WorkerPool.
.. attribute:: name
The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name".
:type: str
Volume
Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.
WorkerConfig
WorkerConfig defines the configuration to be used for a creating workers in the pool.
WorkerPool
Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool.