Cloud Build v1 API - Namespace Google.Cloud.CloudBuild.V1 (2.6.0)

ApprovalConfig describes configuration for manual approval of a build.

ApprovalResult describes the decision and associated metadata of a manual approval of a build.

Container for nested types declared in the ApprovalResult message type.

Request to approve or reject a pending build.

An artifact that was uploaded during a build. This is a single record in the artifact manifest JSON file.

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

Container for nested types declared in the Artifacts message type.

Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.

A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.

Npm package to upload to Artifact Registry upon successful completion of all build steps.

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.

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.

Container for nested types declared in the Build message type.

A fatal problem encountered during the execution of the build.

Container for nested types declared in the FailureInfo message type.

A non-fatal problem encountered during the execution of the build.

Container for nested types declared in the Warning message type.

BuildApproval describes a build's approval configuration, state, and result.

Container for nested types declared in the BuildApproval message type.

Resource name for the Build resource.

Metadata for build operations.

Optional arguments to enable specific features of builds.

Container for nested types declared in the BuildOptions message type.

Details about how a build should be executed on a WorkerPool.

See running builds in a private pool for more information.

A step in the build pipeline.

Configuration for an automated build in response to source repository changes.

Resource name for the BuildTrigger resource.

An image built by the pipeline.

Request to cancel an ongoing build.

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.

Base class for server-side implementations of CloudBuild

Client for CloudBuild

CloudBuild client wrapper, for convenient use.

Builder class for CloudBuildClient to provide simple configuration of credentials, endpoint etc.

CloudBuild client wrapper implementation, for convenient use.

Settings for CloudBuildClient instances.

Request to create a new build.

Request to create a new BuildTrigger.

Metadata for the CreateWorkerPool operation.

Request to create a new WorkerPool.

Resource name for the CryptoKey resource.

Request to delete a BuildTrigger.

Metadata for the DeleteWorkerPool operation.

Request to delete a WorkerPool.

Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.

Request to get a build.

Returns the BuildTrigger with the specified ID.

Request to get a WorkerPool with the specified name.

GitFileSource describes a file within a (possibly remote) code repository.

Container for nested types declared in the GitFileSource message type.

Resource name for the GithubEnterpriseConfig resource.

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 describes the configuration of a trigger that creates a build whenever a GitHub event is received.

GitRepoSource describes a repo and ref of a code repository.

Location of the source in any accessible Git repository.

Container message for hash values.

Container for nested types declared in the Hash message type.

Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.

Request to list builds.

Response including listed builds.

Request to list existing BuildTriggers.

Response containing existing BuildTriggers.

Request to list WorkerPools.

Response containing existing WorkerPools.

Resource name for the Membership resource.

Resource name for the Network resource.

Configuration for a V1 PrivatePool.

Container for nested types declared in the PrivatePoolV1Config message type.

Defines the network configuration for the pool.

Container for nested types declared in the NetworkConfig message type.

Defines the configuration to be used for creating workers in the pool.

PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.

Container for nested types declared in the PubsubConfig message type.

PullRequestFilter contains filter properties for matching GitHub Pull Requests.

Container for nested types declared in the PullRequestFilter message type.

Push contains filter properties for matching GitHub git pushes.

ReceiveTriggerWebhookRequest [Experimental] is the request object accepted by the ReceiveTriggerWebhook method.

ReceiveTriggerWebhookResponse [Experimental] is the response object for the ReceiveTriggerWebhook method.

The configuration of a trigger that creates a build whenever an event from Repo API is received.

Container for nested types declared in the RepositoryEventConfig message type.

Resource name for the Repository resource.

Location of the source in a Google Cloud Source Repository.

Artifacts created by the build pipeline.

Specifies a build to retry.

Specifies a build trigger to run and the source to use.

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.

Pairs a secret environment variable with a SecretVersion in Secret Manager.

Resource name for the Secret resource.

Secrets and secret environment variables.

Resource name for the SecretVersion resource.

Resource name for the ServiceAccount resource.

Location of the source in a supported storage service.

Provenance of the source. Ways to find the original source, or verify that some source was used for this build.

Location of the source in an archive file in Cloud Storage.

Location of the source manifest in Cloud Storage. This feature is in Preview; see description here.

Resource name for the Subscription resource.

Start and end times for a build execution phase.

Resource name for the Topic resource.

Request to update an existing BuildTrigger.

Metadata for the UpdateWorkerPool operation.

Request to update a WorkerPool.

A Maven artifact uploaded using the MavenArtifact directive.

An npm package uploaded to Artifact Registry using the NpmPackage directive.

Artifact uploaded using the PythonPackage directive.

Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.

WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL.

Container for nested types declared in the WebhookConfig message type.

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 WorkerPools 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.

Container for nested types declared in the WorkerPool message type.

Resource name for the WorkerPool resource.

Specifies whether or not this manual approval result is to approve or reject a build.

The name of a fatal problem encountered during the execution of the build.

Possible status of a build or build step.

The relative importance of this warning.

Specifies the current state of a build's approval.

The possible contents of BuildName.

Default GCS log bucket behavior options.

Specifies the logging mode.

Specifies the behavior when writing build logs to Cloud Storage.

Supported Compute Engine machine types. For more information, see Machine types.

Specifies the behavior when there is an error in the substitution checks.

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.

Enum of possible cases for the "build_template" oneof.

The possible contents of BuildTriggerName.

The possible contents of CryptoKeyName.

Enum of possible cases for the "enterprise_config" oneof.

Enum of possible cases for the "source" oneof.

The type of the repo, since it may not be explicit from the repo field (e.g from a URL).

The possible contents of GithubEnterpriseConfigName.

Enum of possible cases for the "event" oneof.

Enum of possible cases for the "enterprise_config" oneof.

Enum of possible cases for the "source" oneof.

Specifies the hash algorithm, if any.

The possible contents of MembershipName.

The possible contents of NetworkName.

Defines the egress option for the pool.

Enumerates potential issues with the underlying Pub/Sub subscription configuration.

Enum of possible cases for the "git_ref" oneof.

Controls behavior of Pull Request comments.

Enum of possible cases for the "git_ref" oneof.

Enum of possible cases for the "filter" oneof.

All possible SCM repo types from Repo API.

The possible contents of RepositoryName.

Enum of possible cases for the "revision" oneof.

The possible contents of SecretName.

The possible contents of SecretVersionName.

The possible contents of ServiceAccountName.

Enum of possible cases for the "source" oneof.

The possible contents of SubscriptionName.

The possible contents of TopicName.

Enum of possible cases for the "auth_method" oneof.

Enumerates potential issues with the Secret Manager secret provided by the user.

Enum of possible cases for the "config" oneof.

State of the WorkerPool.

The possible contents of WorkerPoolName.