Show / Hide Table of Contents

Namespace Google.Apis.CloudBuild.v1beta1.Data

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.

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

BatchCreateBitbucketServerConnectedRepositoriesResponse

Response of BatchCreateBitbucketServerConnectedRepositories RPC method including all successfully connected Bitbucket Server repositories.

BatchCreateBitbucketServerConnectedRepositoriesResponseMetadata

Metadata for BatchCreateBitbucketServerConnectedRepositories operation.

BatchCreateGitLabConnectedRepositoriesResponse

Response of BatchCreateGitLabConnectedRepositories RPC method.

BatchCreateGitLabConnectedRepositoriesResponseMetadata

Metadata for BatchCreateGitLabConnectedRepositories operation.

BatchCreateRepositoriesResponse

Message for response of creating repositories in batch.

BitbucketServerConnectedRepository

/ BitbucketServerConnectedRepository represents a connected Bitbucket Server / repository.

BitbucketServerRepositoryId

BitbucketServerRepositoryId identifies a specific repository hosted on a Bitbucket Server.

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.

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.

BuiltImage

An image built by the pipeline.

CancelOperationRequest

The request message for Operations.CancelOperation.

CreateBitbucketServerConfigOperationMetadata

Metadata for CreateBitbucketServerConfig operation.

CreateGitHubEnterpriseConfigOperationMetadata

Metadata for CreateGithubEnterpriseConfig operation.

CreateGitLabConfigOperationMetadata

Metadata for CreateGitLabConfig operation.

CreateWorkerPoolOperationMetadata

Metadata for the CreateWorkerPool operation.

DeleteBitbucketServerConfigOperationMetadata

Metadata for DeleteBitbucketServerConfig operation.

DeleteGitHubEnterpriseConfigOperationMetadata

Metadata for DeleteGitHubEnterpriseConfig operation.

DeleteGitLabConfigOperationMetadata

Metadata for DeleteGitLabConfig operation.

DeleteWorkerPoolOperationMetadata

Metadata for the DeleteWorkerPool operation.

Empty

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); }

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.

GitLabConnectedRepository

GitLabConnectedRepository represents a GitLab connected repository request response.

GitLabRepositoryId

GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise

GoogleDevtoolsCloudbuildV2OperationMetadata

Represents the metadata of the long-running operation.

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.

ListWorkerPoolsResponse

Response containing existing WorkerPools.

MavenArtifact

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

NetworkConfig

Network describes the network configuration for a WorkerPool.

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.

OperationMetadata

Represents the metadata of the long-running operation.

PoolOption

Details about how a build should be executed on a WorkerPool. See running builds in a private pool for more information.

ProcessAppManifestCallbackOperationMetadata

Metadata for ProcessAppManifestCallback operation.

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.

Repository

A repository associated to a parent connection.

RepoSource

Location of the source in a Google Cloud Source Repository.

Results

Artifacts created by the build pipeline.

RunWorkflowCustomOperationMetadata

Represents the custom metadata of the RunWorkflow long-running operation.

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.

Secrets

Secrets and secret environment variables.

SlackDelivery

SlackDelivery is the delivery configuration for delivering Slack messages via webhooks. See Slack webhook documentation at: https://api.slack.com/messaging/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. Ways to find the original source, or verify that some source was used for this build.

Status

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.

StorageSource

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

StorageSourceManifest

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

TimeSpan

Start and end times for a build execution phase.

UpdateBitbucketServerConfigOperationMetadata

Metadata for UpdateBitbucketServerConfig operation.

UpdateGitHubEnterpriseConfigOperationMetadata

Metadata for UpdateGitHubEnterpriseConfig operation.

UpdateGitLabConfigOperationMetadata

Metadata for UpdateGitLabConfig operation.

UpdateWorkerPoolOperationMetadata

Metadata for the UpdateWorkerPool operation.

UploadedMavenArtifact

A Maven artifact uploaded using the MavenArtifact 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.

Warning

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

WorkerConfig

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

WorkerPool

Configuration for a WorkerPool to run the builds. Workers provide a build environment where Cloud Build runs your builds. Cloud Build owns and maintains a pool of workers for general use. By default, when you submit a build, Cloud Build uses one of the workers from this pool. Builds that run in the default worker pool have access to the public internet. If your build needs access to resources on a private network, create and use a WorkerPool to run your builds. Custom 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 custom worker pools, see Custom workers overview.

In This Article
Back to top Generated by DocFX