cloudbuild/v1 library

Cloud Build API - v1

Creates and manages builds on Google Cloud Platform.

For more information, see cloud.google.com/cloud-build/docs/

Create an instance of CloudBuildApi to access these resources:

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.
ApproveBuildRequest: Request to approve or reject a pending build.
ArtifactObjects: Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.
Artifacts: Artifacts produced by a build that should be uploaded upon successful completion of all build steps.
BatchCreateBitbucketServerConnectedRepositoriesRequest: RPC request object accepted by BatchCreateBitbucketServerConnectedRepositories RPC method.
BatchCreateGitLabConnectedRepositoriesRequest: RPC request object accepted by BatchCreateGitLabConnectedRepositories RPC method.
BitbucketServerConfig: BitbucketServerConfig represents the configuration for a Bitbucket Server.
BitbucketServerConnectedRepository: / BitbucketServerConnectedRepository represents a connected Bitbucket Server / repository.
BitbucketServerRepository: BitbucketServerRepository represents a repository hosted on a Bitbucket Server.
BitbucketServerRepositoryId: BitbucketServerRepositoryId identifies a specific repository hosted on a Bitbucket Server.
BitbucketServerSecrets: BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server.
BitbucketServerTriggerConfig: BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received.
Build: A build resource in the Cloud Build API.
BuildApproval: BuildApproval describes a build's approval configuration, state, and result.
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.
CloudBuildApi: Creates and manages builds on Google Cloud Platform.
ConnectedRepository: Location of the source in a 2nd-gen Google Cloud Build repository resource.
CreateBitbucketServerConnectedRepositoryRequest: Request to connect a repository from a connected Bitbucket Server host.
CreateGitLabConnectedRepositoryRequest: Request to connect a repository from a connected GitLab host.
DefaultServiceAccount: The default service account used for Builds.
DeveloperConnectConfig: This config defines the location of a source through Developer Connect.
FailureInfo: A fatal problem encountered during the execution of the build.
FileHashes: Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.
GCSLocation: Represents a storage location in Cloud Storage
GitConfig: GitConfig is a configuration for git operations.
GitFileSource: GitFileSource describes a file within a (possibly remote) code repository.
GithubDotComWebhookResource
GitHubEnterpriseConfig: GitHubEnterpriseConfig represents a configuration for a GitHub Enterprise server.
GitHubEnterpriseSecrets: GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server.
GitHubEventsConfig: GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received.
GitLabConfig: GitLabConfig represents the configuration for a GitLab integration.
GitLabConnectedRepository: GitLabConnectedRepository represents a GitLab connected repository request response.
GitLabEnterpriseConfig: GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration.
GitLabEventsConfig: GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received.
GitLabRepository: Proto Representing a GitLabRepository
GitLabRepositoryId: GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise
GitLabSecrets: GitLabSecrets represents the secrets in Secret Manager for a GitLab integration.
GitRepoSource: GitRepoSource describes a repo and ref of a code repository.
GitSource: Location of the source in any accessible Git repository.
Hash: Container message for hash values.
HttpConfig: HttpConfig is a configuration for HTTP related git operations.
InlineSecret: Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.
ListBitbucketServerConfigsResponse: RPC response object returned by ListBitbucketServerConfigs RPC method.
ListBitbucketServerRepositoriesResponse: RPC response object returned by the ListBitbucketServerRepositories RPC method.
ListBuildsResponse: Response including listed builds.
ListBuildTriggersResponse: Response containing existing BuildTriggers.
ListGithubEnterpriseConfigsResponse: RPC response object returned by ListGithubEnterpriseConfigs RPC method.
ListGitLabConfigsResponse: RPC response object returned by ListGitLabConfigs RPC method.
ListGitLabRepositoriesResponse: RPC response object returned by the ListGitLabRepositories RPC method.
ListWorkerPoolsResponse: Response containing existing WorkerPools.
LocationsResource
MavenArtifact: A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.
NetworkConfig: Defines the network configuration for the pool.
NpmPackage: Npm package to upload to Artifact Registry upon successful completion of all build steps.
Operation: This resource represents a long-running operation that is the result of a network API call.
OperationsResource
PoolOption: Details about how a build should be executed on a WorkerPool.
PrivatePoolV1Config: Configuration for a V1 PrivatePool.
ProjectsBuildsResource
ProjectsGithubEnterpriseConfigsResource
ProjectsLocationsBitbucketServerConfigsConnectedRepositoriesResource
ProjectsLocationsBitbucketServerConfigsReposResource
ProjectsLocationsBitbucketServerConfigsResource
ProjectsLocationsBuildsResource
ProjectsLocationsGithubEnterpriseConfigsResource
ProjectsLocationsGitLabConfigsConnectedRepositoriesResource
ProjectsLocationsGitLabConfigsReposResource
ProjectsLocationsGitLabConfigsResource
ProjectsLocationsOperationsResource
ProjectsLocationsResource
ProjectsLocationsTriggersResource
ProjectsLocationsWorkerPoolsResource
ProjectsResource
ProjectsTriggersResource
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.
PythonPackage: Python package to upload to Artifact Registry upon successful completion of all build steps.
RemoveBitbucketServerConnectedRepositoryRequest: RPC request object accepted by RemoveBitbucketServerConnectedRepository RPC method.
RemoveGitLabConnectedRepositoryRequest: RPC request object accepted by RemoveGitLabConnectedRepository RPC method.
RepositoryEventConfig: The configuration of a trigger that creates a build whenever an event from Repo API is received.
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.
SecretManagerSecret: Pairs a secret environment variable with a SecretVersion in Secret Manager.
Secrets: Secrets and secret environment variables.
ServiceDirectoryConfig: ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection.
Source: Location of the source in a supported storage service.
SourceProvenance: Provenance of the source.
StorageSource: Location of the source in an archive file in Cloud Storage.
StorageSourceManifest: Location of the source manifest in Cloud Storage.
TimeSpan: Start and end times for a build execution phase.
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.
V1Resource
Volume: Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.
Warning: A non-fatal problem encountered during the execution of the build.
WebhookConfig: WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL.
WorkerConfig: Defines the configuration to be used for creating workers in the pool.
WorkerPool: Configuration for a WorkerPool.

Typedefs

CancelOperationRequest = $Empty: The request message for Operations.CancelOperation.
Empty = $Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
HttpBody = $HttpBody: Message that represents an arbitrary HTTP body.
ReceiveTriggerWebhookResponse = $Empty: ReceiveTriggerWebhookResponse [Experimental] is the response object for the ReceiveTriggerWebhook method.
Status = $Status: The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.

Exceptions / Errors

ApiRequestError: Represents a general error reported by the API endpoint.
DetailedApiRequestError: Represents a specific error reported by the API endpoint.

cloudbuild/v1 library

Classes

Typedefs

Exceptions / Errors

googleapis package

v1 library