Show / Hide Table of Contents

Namespace Google.Apis.CloudBuild.v1.Data

Classes

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.

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

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.

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); } The JSON representation for Empty is empty JSON object {}.

FileHashes

Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.

GitHubEventsConfig

GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental.

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.

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.

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.

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.

ReceiveTriggerWebhookResponse

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

RepoSource

Location of the source in a Google Cloud Source Repository.

Results

Artifacts created by the build pipeline.

RetryBuildRequest

Specifies a build to retry.

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.

TimeSpan

Start and end times for a build execution phase.

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.

In This Article
Back to top