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.
BuildOptions
Optional arguments to enable specific features of builds.
BuildStep
A step in the build pipeline.
BuildTrigger
Configuration for an automated build in response to source repository changes.
BuiltImage
An image built by the pipeline.
CancelBuildRequest
Request to cancel an ongoing build.
CreateBuildRequest
Request to create a new build.
CreateBuildTriggerRequest
Request to create a new BuildTrigger.
CreateWorkerPoolOperationMetadata
Metadata for the CreateWorkerPool operation.
CreateWorkerPoolRequest
Request to create a new WorkerPool.
DeleteBuildTriggerRequest
Request to delete a BuildTrigger.
DeleteWorkerPoolOperationMetadata
Metadata for the DeleteWorkerPool operation.
DeleteWorkerPoolRequest
Request to delete a WorkerPool.
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.
GetBuildTriggerRequest
Returns the BuildTrigger with the specified ID.
GetWorkerPoolRequest
Request to get a WorkerPool with the specified name.
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.
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.
ListBuildTriggersResponse
Response containing existing BuildTriggers.
ListBuildsRequest
Request to list builds.
ListBuildsResponse
Response including listed builds.
ListWorkerPoolsRequest
Request to list WorkerPool\ s.
ListWorkerPoolsResponse
Response containing existing WorkerPools.
PrivatePoolV1Config
Configuration for a V1 PrivatePool.
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.
Results
Artifacts created by the build pipeline.
RetryBuildRequest
Specifies a build to retry.
RunBuildTriggerRequest
Specifies a build trigger to run and the source to use.
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.
Source
Location of the source in a supported storage service.
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; see description
here <https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher>__.
TimeSpan
Start and end times for a build execution phase.
UpdateBuildTriggerRequest
Request to update an existing BuildTrigger.
UpdateWorkerPoolOperationMetadata
Metadata for the UpdateWorkerPool operation.
UpdateWorkerPoolRequest
Request to update a WorkerPool.
Volume
Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.
WebhookConfig
WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL.
WorkerPool
Configuration for a WorkerPool.
Cloud Build owns and maintains a pool of workers for general use and have no access to a project's private network. By default, builds submitted to Cloud Build will use a worker from this pool.
If your build needs access to resources on a private network, create
and use a WorkerPool to run your builds. Private
WorkerPool\ s give your builds access to any single VPC network
that you administer, including any on-prem resources connected to
that VPC network. For an overview of private pools, see Private
pools
overview <https://cloud.google.com/build/docs/private-pools/private-pools-overview>__.