Show / Hide Table of Contents

Namespace Google.Apis.CloudBuild.v1.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.

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

BatchCreateBitbucketServerConnectedRepositoriesRequest

RPC request object accepted by BatchCreateBitbucketServerConnectedRepositories RPC method.

BatchCreateBitbucketServerConnectedRepositoriesResponse

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

BatchCreateBitbucketServerConnectedRepositoriesResponseMetadata

Metadata for BatchCreateBitbucketServerConnectedRepositories operation.

BatchCreateGitLabConnectedRepositoriesRequest

RPC request object accepted by BatchCreateGitLabConnectedRepositories RPC method.

BatchCreateGitLabConnectedRepositoriesResponse

Response of BatchCreateGitLabConnectedRepositories RPC method.

BatchCreateGitLabConnectedRepositoriesResponseMetadata

Metadata for BatchCreateGitLabConnectedRepositories operation.

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

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.

CancelOperationRequest

The request message for Operations.CancelOperation.

ConnectedRepository

Location of the source in a 2nd-gen Google Cloud Build repository resource.

CreateBitbucketServerConfigOperationMetadata

Metadata for CreateBitbucketServerConfig operation.

CreateBitbucketServerConnectedRepositoryRequest

Request to connect a repository from a connected Bitbucket Server host.

CreateGitHubEnterpriseConfigOperationMetadata

Metadata for CreateGithubEnterpriseConfig operation.

CreateGitLabConfigOperationMetadata

Metadata for CreateGitLabConfig operation.

CreateGitLabConnectedRepositoryRequest

Request to connect a repository from a connected GitLab host.

CreateWorkerPoolOperationMetadata

Metadata for the CreateWorkerPool operation.

DefaultServiceAccount

The default service account used for Builds.

DeleteBitbucketServerConfigOperationMetadata

Metadata for DeleteBitbucketServerConfig operation.

DeleteGitHubEnterpriseConfigOperationMetadata

Metadata for DeleteGitHubEnterpriseConfig operation.

DeleteGitLabConfigOperationMetadata

Metadata for DeleteGitLabConfig operation.

DeleteWorkerPoolOperationMetadata

Metadata for the DeleteWorkerPool operation.

Dependency

A dependency that the Cloud Build worker will fetch before executing user steps.

DeveloperConnectConfig

This config defines the location of a source through Developer Connect.

DeveloperConnectEventConfig

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

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.

GitConfig

GitConfig is a configuration for git operations.

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. Format is: projects//secrets/.

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.

GitSourceDependency

Represents a git repository as a build dependency.

GitSourceRepository

A repository for a git source.

GoModule

Go module to upload to Artifact Registry upon successful completion of all build steps. A module refers to all dependencies in a go.mod file.

Hash

Container message for hash values.

HttpBody

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.

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.

ListBuildTriggersResponse

Response containing existing BuildTriggers.

ListBuildsResponse

Response including listed builds.

ListGitLabConfigsResponse

RPC response object returned by ListGitLabConfigs RPC method.

ListGitLabRepositoriesResponse

RPC response object returned by the ListGitLabRepositories RPC method.

ListGithubEnterpriseConfigsResponse

RPC response object returned by ListGithubEnterpriseConfigs RPC method.

ListWorkerPoolsResponse

Response containing existing WorkerPools.

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.

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.

PrivatePoolV1Config

Configuration for a V1 PrivatePool.

PrivateServiceConnect

Defines the Private Service Connect network configuration for the pool.

ProcessAppManifestCallbackOperationMetadata

Metadata for ProcessAppManifestCallback operation.

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. A package can encapsulate multiple objects to be uploaded to a single repository.

ReceiveTriggerWebhookResponse

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

RemoveBitbucketServerConnectedRepositoryRequest

RPC request object accepted by RemoveBitbucketServerConnectedRepository RPC method.

RemoveGitLabConnectedRepositoryRequest

RPC request object accepted by RemoveGitLabConnectedRepository RPC method.

RepoSource

Location of the source in a Google Cloud Source Repository.

RepositoryEventConfig

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

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

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

StorageSourceManifest

Location of the source manifest in 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.

UploadedGoModule

A Go module artifact uploaded to Artifact Registry using the GoModule directive.

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.

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

In this article
Back to top Generated by DocFX