API Reference google_api_cloud_build v0.38.0

Modules

API client metadata for GoogleApi.CloudBuild.V1.

API calls for all endpoints tagged Operations.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.CloudBuild.V1.

Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.

An artifact that was uploaded during a build. This is a single record in the artifact manifest JSON file.

Artifacts produced by a build that should be uploaded upon successful completion of all build steps.

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.

Optional arguments to enable specific features of builds.

A step in the build pipeline.

Configuration for an automated build in response to source repository changes.

An image built by the pipeline.

Request to cancel an ongoing build.

The request message for Operations.CancelOperation.

Metadata for the CreateWorkerPool operation.

Metadata for the DeleteWorkerPool operation.

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

A fatal problem encountered during the execution of the build.

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

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

GitRepoSource describes a repo and ref of a code repository.

Represents the metadata of the long-running operation.

HTTPDelivery is the delivery configuration for an HTTP notification.

Container message for hash values.

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.

Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.

Response containing existing BuildTriggers.

Response including listed builds.

Response containing existing WorkerPools.

Defines the network configuration for the pool.

Notification is the container which holds the data that is relevant to this particular notification.

NotifierConfig is the top-level configuration message.

NotifierMetadata contains the data which can be used to reference or describe this notifier.

NotifierSecret is the container that maps a secret name (reference) to its Google Cloud Secret Manager resource path.

NotifierSecretRef contains the reference to a secret stored in the corresponding NotifierSpec.

NotifierSpec is the configuration container for notifications.

This resource represents a long-running operation that is the result of a network API call.

Represents the metadata of the long-running operation.

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

Configuration for a V1 PrivatePool.

PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.

PullRequestFilter contains filter properties for matching GitHub Pull Requests.

Push contains filter properties for matching GitHub git pushes.

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

Location of the source in a Google Cloud Source Repository.

Artifacts created by the build pipeline.

Specifies a build trigger to run and the source to use.

SMTPDelivery is the delivery configuration for an SMTP (email) notification.

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.

Pairs a secret environment variable with a SecretVersion in Secret Manager.

Secrets and secret environment variables.

SlackDelivery is the delivery configuration for delivering Slack messages via webhooks. See Slack webhook documentation at: https://api.slack.com/messaging/webhooks.

Location of the source in a supported storage service.

Provenance of the source. Ways to find the original source, or verify that some source was used for this build.

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.

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

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

Start and end times for a build execution phase.

Metadata for the UpdateWorkerPool operation.

Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.

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

WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL.

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

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.