ApprovalConfig describes configuration for manual approval of a build.
ApprovalResult describes the decision and associated metadata of a manual approval of a build.
Request to approve or reject a pending build.
Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.
Artifacts produced by a build that should be uploaded upon successful completion of all build steps.
RPC request object accepted by BatchCreateBitbucketServerConnectedRepositories RPC method.
RPC request object accepted by BatchCreateGitLabConnectedRepositories RPC method.
BitbucketServerConfig represents the configuration for a Bitbucket Server.
/ BitbucketServerConnectedRepository represents a connected Bitbucket Server / repository.
BitbucketServerRepository represents a repository hosted on a Bitbucket Server.
BitbucketServerRepositoryId identifies a specific repository hosted on a Bitbucket Server.
BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server.
BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received.
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.
BuildApproval describes a build’s approval configuration, state, and result.
Optional arguments to enable specific features of builds.
A step in the build pipeline.
Configuration for an automated build in response to source repository changes.
An image built by the pipeline.
Request to cancel an ongoing build.
The request message for Operations.CancelOperation.
Central instance to access all CloudBuild related resource activities
Location of the source in a 2nd-gen Google Cloud Build repository resource.
Request to connect a repository from a connected Bitbucket Server host.
Request to connect a repository from a connected GitLab host.
The default service account used for Builds.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
A fatal problem encountered during the execution of the build.
Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.
GitFileSource describes a file within a (possibly remote) code repository.
GitHubEnterpriseConfig represents a configuration for a GitHub Enterprise server.
GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/.
GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received.
GitLabConfig represents the configuration for a GitLab integration.
GitLabConnectedRepository represents a GitLab connected repository request response.
GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration.
GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received.
Proto Representing a GitLabRepository
GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise
GitLabSecrets represents the secrets in Secret Manager for a GitLab integration.
GitRepoSource describes a repo and ref of a code repository.
Location of the source in any accessible Git repository.
A builder providing access to all methods supported on
githubDotComWebhook resources.
It is not used directly, but through the
CloudBuild hub.
ReceiveGitHubDotComWebhook is called when the API receives a github.com webhook.
Container message for hash values.
Message that represents an arbitrary HTTP body. It should only be used for payload formats that can’t be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.
RPC response object returned by ListBitbucketServerConfigs RPC method.
RPC response object returned by the ListBitbucketServerRepositories RPC method.
Response containing existing BuildTriggers.
Response including listed builds.
RPC response object returned by ListGitLabConfigs RPC method.
RPC response object returned by the ListGitLabRepositories RPC method.
RPC response object returned by ListGithubEnterpriseConfigs RPC method.
Response containing existing WorkerPools.
A builder providing access to all methods supported on
location resources.
It is not used directly, but through the
CloudBuild hub.
ReceiveRegionalWebhook is called when the API receives a regional GitHub webhook.
A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.
A builder providing access to all free methods, which are not associated with a particular resource.
It is not used directly, but through the
CloudBuild hub.
ReceiveWebhook is called when the API receives a GitHub webhook.
Defines the network configuration for the pool.
Npm package to upload to Artifact Registry upon successful completion of all build steps.
This resource represents a long-running operation that is the result of a network API call.
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
A builder providing access to all methods supported on
operation resources.
It is not used directly, but through the
CloudBuild hub.
Configuration for a V1 PrivatePool.
Defines the Private Service Connect network configuration for the pool.
Approves or rejects a pending build. If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call. If rejected, the returned LRO will be immediately done.
Cancels a build in progress.
Starts a build with the specified configuration. This method returns a long-running Operation, which includes the build ID. Pass the build ID to GetBuild to determine the build status (such as SUCCESS or FAILURE).
Returns information about a previously requested build. The Build that is returned includes its status (such as SUCCESS, FAILURE, or WORKING), and timing information.
Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.
Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify RepoSource: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify StorageSource: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket’s lifecycle management settings.
Create an association between a GCP project and a GitHub Enterprise server.
Delete an association between a GCP project and a GitHub Enterprise server.
Retrieve a GitHubEnterpriseConfig.
List all GitHubEnterpriseConfigs for a given project.
Update an association between a GCP project and a GitHub Enterprise server.
Batch connecting Bitbucket Server repositories to Cloud Build.
Creates a new BitbucketServerConfig. This API is experimental.
Delete a BitbucketServerConfig. This API is experimental.
Retrieve a BitbucketServerConfig. This API is experimental.
List all BitbucketServerConfigs for a given project. This API is experimental.
Updates an existing BitbucketServerConfig. This API is experimental.
Remove a Bitbucket Server repository from a given BitbucketServerConfig’s connected repositories. This API is experimental.
List all repositories for a given BitbucketServerConfig. This API is experimental.
Approves or rejects a pending build. If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call. If rejected, the returned LRO will be immediately done.
Cancels a build in progress.
Starts a build with the specified configuration. This method returns a long-running Operation, which includes the build ID. Pass the build ID to GetBuild to determine the build status (such as SUCCESS or FAILURE).
Returns information about a previously requested build. The Build that is returned includes its status (such as SUCCESS, FAILURE, or WORKING), and timing information.
Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.
Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify RepoSource: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify StorageSource: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket’s lifecycle management settings.
Returns the DefaultServiceAccount used by the project.
Batch connecting GitLab repositories to Cloud Build. This API is experimental.
Creates a new GitLabConfig. This API is experimental
Delete a GitLabConfig. This API is experimental
Retrieves a GitLabConfig. This API is experimental
List all GitLabConfigs for a given project. This API is experimental
Updates an existing GitLabConfig. This API is experimental
Remove a GitLab repository from a given GitLabConfig’s connected repositories. This API is experimental.
List all repositories for a given GitLabConfig. This API is experimental
Create an association between a GCP project and a GitHub Enterprise server.
Delete an association between a GCP project and a GitHub Enterprise server.
Retrieve a GitHubEnterpriseConfig.
List all GitHubEnterpriseConfigs for a given project.
Update an association between a GCP project and a GitHub Enterprise server.
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Creates a new BuildTrigger.
Deletes a BuildTrigger by its project ID and trigger ID.
Returns information about a BuildTrigger.
Lists existing BuildTriggers.
Updates a BuildTrigger by its project ID and trigger ID.
Runs a BuildTrigger at a particular source revision. To run a regional or global trigger, use the POST request that includes the location endpoint in the path (ex. v1/projects/{projectId}/locations/{region}/triggers/{triggerId}:run). The POST request that does not include the location endpoint in the path can only be used when running global triggers.
ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger.
Creates a WorkerPool.
Deletes a WorkerPool.
Returns details of a WorkerPool.
Lists WorkerPools.
Updates a WorkerPool.
A builder providing access to all methods supported on
project resources.
It is not used directly, but through the
CloudBuild hub.
Creates a new BuildTrigger.
Deletes a BuildTrigger by its project ID and trigger ID.
Returns information about a BuildTrigger.
Lists existing BuildTriggers.
Updates a BuildTrigger by its project ID and trigger ID.
Runs a BuildTrigger at a particular source revision. To run a regional or global trigger, use the POST request that includes the location endpoint in the path (ex. v1/projects/{projectId}/locations/{region}/triggers/{triggerId}:run). The POST request that does not include the location endpoint in the path can only be used when running global triggers.
ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger.
PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.
PullRequestFilter contains filter properties for matching GitHub Pull Requests.
Push contains filter properties for matching GitHub git pushes.
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.
ReceiveTriggerWebhookResponse [Experimental] is the response object for the ReceiveTriggerWebhook method.
RPC request object accepted by RemoveBitbucketServerConnectedRepository RPC method.
RPC request object accepted by RemoveGitLabConnectedRepository RPC method.
Location of the source in a Google Cloud Source Repository.
The configuration of a trigger that creates a build whenever an event from Repo API is received.
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.
Secrets and secret environment variables.
ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection.
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.
The
Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by
gRPC. Each
Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the
API Design Guide.
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.
Start and end times for a build execution phase.
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.
A non-fatal problem encountered during the execution of the build.
WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger’s webhook URL.
Defines the configuration to be used for creating workers in the pool.
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.