Classes
ApprovalConfig
ApprovalConfig describes configuration for manual approval of a build.
ApprovalResult
ApprovalResult describes the decision and associated metadata of a manual approval of a build.
ApprovalResult.Types
Container for nested types declared in the ApprovalResult message type.
ApproveBuildRequest
Request to approve or reject a pending build.
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.
Artifacts.Types
Container for nested types declared in the Artifacts message type.
Artifacts.Types.ArtifactObjects
Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.
Artifacts.Types.MavenArtifact
A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.
Artifacts.Types.NpmPackage
Npm package to upload to Artifact Registry upon successful completion of all build steps.
Artifacts.Types.PythonPackage
Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository.
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.
- $LOCATION: the location/region 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.
Build.Types
Container for nested types declared in the Build message type.
Build.Types.FailureInfo
A fatal problem encountered during the execution of the build.
Build.Types.FailureInfo.Types
Container for nested types declared in the FailureInfo message type.
Build.Types.Warning
A non-fatal problem encountered during the execution of the build.
Build.Types.Warning.Types
Container for nested types declared in the Warning message type.
BuildApproval
BuildApproval describes a build's approval configuration, state, and result.
BuildApproval.Types
Container for nested types declared in the BuildApproval message type.
BuildName
Resource name for the Build
resource.
BuildOperationMetadata
Metadata for build operations.
BuildOptions
Optional arguments to enable specific features of builds.
BuildOptions.Types
Container for nested types declared in the BuildOptions message type.
BuildOptions.Types.PoolOption
Details about how a build should be executed on a WorkerPool
.
See running builds in a private pool for more information.
BuildStep
A step in the build pipeline.
BuildTrigger
Configuration for an automated build in response to source repository changes.
BuildTriggerName
Resource name for the BuildTrigger
resource.
BuiltImage
An image built by the pipeline.
CancelBuildRequest
Request to cancel an ongoing build.
CloudBuild
Creates and manages builds on Google Cloud Platform.
The main concept used by this API is a Build
, which describes the location
of the source to build, how to build the source, and where to store the
built artifacts, if any.
A user can list previously-requested builds or get builds by their ID to determine the status of the build.
CloudBuild.CloudBuildBase
Base class for server-side implementations of CloudBuild
CloudBuild.CloudBuildClient
Client for CloudBuild
CloudBuildClient
CloudBuild client wrapper, for convenient use.
CloudBuildClientBuilder
Builder class for CloudBuildClient to provide simple configuration of credentials, endpoint etc.
CloudBuildClientImpl
CloudBuild client wrapper implementation, for convenient use.
CloudBuildSettings
Settings for CloudBuildClient instances.
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
.
CryptoKeyName
Resource name for the CryptoKey
resource.
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.
GitFileSource
GitFileSource describes a file within a (possibly remote) code repository.
GitFileSource.Types
Container for nested types declared in the GitFileSource message type.
GitHubEnterpriseConfig
GitHubEnterpriseSecrets
GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects/<project number>/secrets/<secret name>.
GitHubEventsConfig
GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received.
GitRepoSource
GitRepoSource describes a repo and ref of a code repository.
GitSource
Location of the source in any accessible Git repository.
GithubEnterpriseConfigName
Resource name for the GithubEnterpriseConfig
resource.
Hash
Container message for hash values.
Hash.Types
Container for nested types declared in the Hash message type.
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
.
MembershipName
Resource name for the Membership
resource.
NetworkAttachmentName
Resource name for the NetworkAttachment
resource.
NetworkName
Resource name for the Network
resource.
PrivatePoolV1Config
Configuration for a V1 PrivatePool
.
PrivatePoolV1Config.Types
Container for nested types declared in the PrivatePoolV1Config message type.
PrivatePoolV1Config.Types.NetworkConfig
Defines the network configuration for the pool.
PrivatePoolV1Config.Types.NetworkConfig.Types
Container for nested types declared in the NetworkConfig message type.
PrivatePoolV1Config.Types.PrivateServiceConnect
Defines the Private Service Connect network configuration for the pool.
PrivatePoolV1Config.Types.WorkerConfig
Defines the configuration to be used for creating workers in the pool.
PubsubConfig
PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.
PubsubConfig.Types
Container for nested types declared in the PubsubConfig message type.
PullRequestFilter
PullRequestFilter contains filter properties for matching GitHub Pull Requests.
PullRequestFilter.Types
Container for nested types declared in the PullRequestFilter message type.
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.
RepositoryEventConfig
The configuration of a trigger that creates a build whenever an event from Repo API is received.
RepositoryEventConfig.Types
Container for nested types declared in the RepositoryEventConfig message type.
RepositoryName
Resource name for the Repository
resource.
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.
SecretName
Resource name for the Secret
resource.
SecretVersionName
Resource name for the SecretVersion
resource.
Secrets
Secrets and secret environment variables.
ServiceAccountName
Resource name for the ServiceAccount
resource.
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 Cloud Storage.
StorageSource.Types
Container for nested types declared in the StorageSource message type.
StorageSourceManifest
Location of the source manifest in Cloud Storage. This feature is in Preview; see description here.
SubscriptionName
Resource name for the Subscription
resource.
TimeSpan
Start and end times for a build execution phase.
TopicName
Resource name for the Topic
resource.
UpdateBuildTriggerRequest
Request to update an existing BuildTrigger
.
UpdateWorkerPoolOperationMetadata
Metadata for the UpdateWorkerPool
operation.
UpdateWorkerPoolRequest
Request to update a WorkerPool
.
UploadedMavenArtifact
A Maven artifact uploaded using the MavenArtifact directive.
UploadedNpmPackage
An npm package uploaded to Artifact Registry using the NpmPackage directive.
UploadedPythonPackage
Artifact uploaded using the PythonPackage directive.
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.
WebhookConfig.Types
Container for nested types declared in the WebhookConfig message type.
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.
WorkerPool.Types
Container for nested types declared in the WorkerPool message type.
WorkerPoolName
Resource name for the WorkerPool
resource.
Enums
ApprovalResult.Types.Decision
Specifies whether or not this manual approval result is to approve or reject a build.
Build.Types.FailureInfo.Types.FailureType
The name of a fatal problem encountered during the execution of the build.
Build.Types.Status
Possible status of a build or build step.
Build.Types.Warning.Types.Priority
The relative importance of this warning.
BuildApproval.Types.State
Specifies the current state of a build's approval.
BuildName.ResourceNameType
The possible contents of BuildName.
BuildOptions.Types.DefaultLogsBucketBehavior
Default Cloud Storage log bucket behavior options.
BuildOptions.Types.LogStreamingOption
Specifies the behavior when writing build logs to Cloud Storage.
BuildOptions.Types.LoggingMode
Specifies the logging mode.
BuildOptions.Types.MachineType
Supported Compute Engine machine types. For more information, see Machine types.
BuildOptions.Types.SubstitutionOption
Specifies the behavior when there is an error in the substitution checks.
BuildOptions.Types.VerifyOption
Specifies the manner in which the build should be verified, if at all.
If a verified build is requested, and any part of the process to generate and upload provenance fails, the build will also fail.
If the build does not request verification then that process may occur, but is not guaranteed to. If it does occur and fails, the build will not fail.
For more information, see Viewing Build Provenance.
BuildTrigger.BuildTemplateOneofCase
Enum of possible cases for the "build_template" oneof.
BuildTriggerName.ResourceNameType
The possible contents of BuildTriggerName.
CryptoKeyName.ResourceNameType
The possible contents of CryptoKeyName.
GitFileSource.EnterpriseConfigOneofCase
Enum of possible cases for the "enterprise_config" oneof.
GitFileSource.SourceOneofCase
Enum of possible cases for the "source" oneof.
GitFileSource.Types.RepoType
The type of the repo, since it may not be explicit from the repo
field
(e.g from a URL).
GitHubEventsConfig.EventOneofCase
Enum of possible cases for the "event" oneof.
GitRepoSource.EnterpriseConfigOneofCase
Enum of possible cases for the "enterprise_config" oneof.
GitRepoSource.SourceOneofCase
Enum of possible cases for the "source" oneof.
GithubEnterpriseConfigName.ResourceNameType
The possible contents of GithubEnterpriseConfigName.
Hash.Types.HashType
Specifies the hash algorithm, if any.
MembershipName.ResourceNameType
The possible contents of MembershipName.
NetworkAttachmentName.ResourceNameType
The possible contents of NetworkAttachmentName.
NetworkName.ResourceNameType
The possible contents of NetworkName.
PrivatePoolV1Config.Types.NetworkConfig.Types.EgressOption
Defines the egress option for the pool.
PubsubConfig.Types.State
Enumerates potential issues with the underlying Pub/Sub subscription configuration.
PullRequestFilter.GitRefOneofCase
Enum of possible cases for the "git_ref" oneof.
PullRequestFilter.Types.CommentControl
Controls behavior of Pull Request comments.
PushFilter.GitRefOneofCase
Enum of possible cases for the "git_ref" oneof.
RepoSource.RevisionOneofCase
Enum of possible cases for the "revision" oneof.
RepositoryEventConfig.FilterOneofCase
Enum of possible cases for the "filter" oneof.
RepositoryEventConfig.Types.RepositoryType
All possible SCM repo types from Repo API.
RepositoryName.ResourceNameType
The possible contents of RepositoryName.
SecretName.ResourceNameType
The possible contents of SecretName.
SecretVersionName.ResourceNameType
The possible contents of SecretVersionName.
ServiceAccountName.ResourceNameType
The possible contents of ServiceAccountName.
Source.SourceOneofCase
Enum of possible cases for the "source" oneof.
StorageSource.Types.SourceFetcher
Specifies the tool to fetch the source file for the build.
SubscriptionName.ResourceNameType
The possible contents of SubscriptionName.
TopicName.ResourceNameType
The possible contents of TopicName.
WebhookConfig.AuthMethodOneofCase
Enum of possible cases for the "auth_method" oneof.
WebhookConfig.Types.State
Enumerates potential issues with the Secret Manager secret provided by the user.
WorkerPool.ConfigOneofCase
Enum of possible cases for the "config" oneof.
WorkerPool.Types.State
State of the WorkerPool
.
WorkerPoolName.ResourceNameType
The possible contents of WorkerPoolName.