cloudbuild.v1 library Null safety

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.
ArtifactResult
An artifact that was uploaded during a build. [...]
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. [...]
BuildApproval
BuildApproval describes a build's approval configuration, state, and result.
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.
CloudBuildApi
Creates and manages builds on Google Cloud Platform.
CreateWorkerPoolOperationMetadata
Metadata for the CreateWorkerPool operation.
DeleteGitHubEnterpriseConfigOperationMetadata
Metadata for DeleteGitHubEnterpriseConfig operation.
DeleteWorkerPoolOperationMetadata
Metadata for the DeleteWorkerPool operation.
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.
GitFileSource
GitFileSource describes a file within a (possibly remote) code repository.
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.
GitRepoSource
GitRepoSource describes a repo and ref of a code repository.
Hash
Container message for hash values.
HTTPDelivery
HTTPDelivery is the delivery configuration for an HTTP notification.
InlineSecret
Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.
ListBuildsResponse
Response including listed builds.
ListBuildTriggersResponse
Response containing existing BuildTriggers.
ListGithubEnterpriseConfigsResponse
RPC response object returned by ListGithubEnterpriseConfigs RPC method.
ListWorkerPoolsResponse
Response containing existing WorkerPools.
NetworkConfig
Defines the network configuration for the pool.
Notification
Notification is the container which holds the data that is relevant to this particular notification.
NotifierConfig
NotifierConfig is the top-level configuration message.
NotifierMetadata
NotifierMetadata contains the data which can be used to reference or describe this notifier.
NotifierSecret
NotifierSecret is the container that maps a secret name (reference) to its Google Cloud Secret Manager resource path.
NotifierSecretRef
NotifierSecretRef contains the reference to a secret stored in the corresponding NotifierSpec.
NotifierSpec
NotifierSpec is the configuration container for notifications.
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
ProjectsLocationsBuildsResource
ProjectsLocationsGithubEnterpriseConfigsResource
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.
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.
SlackDelivery
SlackDelivery is the delivery configuration for delivering Slack messages via webhooks. [...]
SMTPDelivery
SMTPDelivery is the delivery configuration for an SMTP (email) notification.
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 Google Cloud Storage.
StorageSourceManifest
Location of the source manifest in Google Cloud Storage. [...]
TimeSpan
Start and end times for a build execution phase.
UpdateGitHubEnterpriseConfigOperationMetadata
Metadata for UpdateGitHubEnterpriseConfig operation.
UpdateWorkerPoolOperationMetadata
Metadata for the UpdateWorkerPool operation.
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.
CreateGitHubEnterpriseConfigOperationMetadata = $OperationMetadata03
Metadata for CreateGithubEnterpriseConfig operation.
Empty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. [...]
GoogleDevtoolsCloudbuildV2OperationMetadata = $OperationMetadata00
Represents the metadata of the long-running operation.
HttpBody = $HttpBody
Message that represents an arbitrary HTTP body. [...]
OperationMetadata = $OperationMetadata02
Represents the metadata of the long-running operation.
ProcessAppManifestCallbackOperationMetadata = $OperationMetadata03
Metadata for ProcessAppManifestCallback operation.
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.