Module types (1.0.0)

API documentation for devtools.cloudbuild_v1.types module.

Classes

Any

API documentation for devtools.cloudbuild_v1.types.Any class.

ArtifactResult

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

The file hash of the artifact.

Artifacts

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

A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE.

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

    Output only. ID of the project.

    Output only. Customer-readable message about the current status.

    Required. The operations to be performed on the workspace.

    Output only. Time at which the request to create the build was received.

    Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution.

    A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build status is marked FAILURE.

    Google Cloud Storage bucket where logs should be written (see Bucket Name Requirements <https://cloud.google.com/storage/docs/bucket- naming#requirements>__). Logs file names will be of the format ${logs_bucket}/log-${build_id}.txt.

    Output only. The ID of the BuildTrigger that triggered this build, if it was triggered automatically.

    Output only. URL to logs for this build in Google Cloud Console.

    Tags for annotation of a Build. These are not docker tags.

    Output only. Stores timing information for phases of the build. Valid keys are: - BUILD: time to execute all build steps - PUSH: time to push all specified images. - FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included.

BuildOperationMetadata

Metadata for build operations.

BuildOptions

Optional arguments to enable specific features of builds.

Requested verifiability options.

Requested disk size for the VM that runs the build. Note that this is NOT "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error.

Option to define build log streaming behavior to Google Cloud Storage.

Option to specify the logging mode, which determines where the logs are stored.

A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret. These variables will be available to all build steps in this build.

BuildStep

A step in the build pipeline.

A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".

Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step's execution.

The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in wait_for have completed successfully. If wait_for is empty, this build step will start when all previous build steps in the Build.Steps list have completed successfully.

A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's Secret.

Output only. Stores timing information for executing this build step.

Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

BuildTrigger

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

Human-readable description of this trigger.

Tags for annotation of a BuildTrigger

GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with trigger_template.

Contents of the build template.

Output only. Time when the trigger was created.

Substitutions data for Build resource.

If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build.

BuiltImage

An image built by the pipeline.

Docker Registry 2.0 digest.

CancelBuildRequest

Request to cancel an ongoing build.

Required. ID of the build.

CancelOperationRequest

API documentation for devtools.cloudbuild_v1.types.CancelOperationRequest class.

CreateBuildRequest

Request to create a new build.

Required. Build resource to create.

CreateBuildTriggerRequest

Request to create a new BuildTrigger.

Required. BuildTrigger to create.

CreateWorkerPoolRequest

Request to create a new WorkerPool.

\ WorkerPool resource to create.

DeleteBuildTriggerRequest

Request to delete a BuildTrigger.

Required. ID of the BuildTrigger to delete.

DeleteOperationRequest

API documentation for devtools.cloudbuild_v1.types.DeleteOperationRequest class.

DeleteWorkerPoolRequest

Request to delete a WorkerPool.

Duration

API documentation for devtools.cloudbuild_v1.types.Duration class.

Empty

API documentation for devtools.cloudbuild_v1.types.Empty class.

FileHashes

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

GetBuildRequest

Request to get a build.

Required. ID of the build.

GetBuildTriggerRequest

Returns the BuildTrigger with the specified ID.

Required. ID of the BuildTrigger to get.

GetOperationRequest

API documentation for devtools.cloudbuild_v1.types.GetOperationRequest class.

GetWorkerPoolRequest

Request to get a WorkerPool with the specified name.

GitHubEventsConfig

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

This message is experimental.

Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is "googlecloudplatform".

Filter describing the types of events to trigger a build. Currently supported event types: push, pull_request.

filter to match changes in refs like branches, tags.

Hash

Container message for hash values.

The hash value.

ListBuildTriggersRequest

Request to list existing BuildTriggers.

Number of results to return in the list.

ListBuildTriggersResponse

Response containing existing BuildTriggers.

Token to receive the next page of results.

ListBuildsRequest

Request to list builds.

Number of results to return in the list.

The raw filter text to constrain the results.

ListBuildsResponse

Response including listed builds.

Token to receive the next page of results.

ListOperationsRequest

API documentation for devtools.cloudbuild_v1.types.ListOperationsRequest class.

ListOperationsResponse

API documentation for devtools.cloudbuild_v1.types.ListOperationsResponse class.

ListWorkerPoolsRequest

Request to list WorkerPool\ s.

ListWorkerPoolsResponse

Response containing existing WorkerPools.

Network

Network describes the GCP network used to create workers in.

Network on which the workers are created. "default" network is used if empty.

Operation

API documentation for devtools.cloudbuild_v1.types.Operation class.

OperationInfo

API documentation for devtools.cloudbuild_v1.types.OperationInfo class.

PullRequestFilter

PullRequestFilter contains filter properties for matching GitHub Pull Requests.

Regex of branches to match. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax

PushFilter

Push contains filter properties for matching GitHub git pushes.

Regexes matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax

RepoSource

Location of the source in a Google Cloud Source Repository.

Name of the Cloud Source Repository. If omitted, the name "default" is assumed.

Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax

Explicit commit SHA to build.

Results

Artifacts created by the build pipeline.

List of build step digests, in the order corresponding to build step indices.

Number of artifacts uploaded. Only populated when artifacts are uploaded.

Time to push all non-container artifacts.

RetryBuildRequest

Specifies a build to retry.

Required. Build ID of the original build.

RunBuildTriggerRequest

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

Required. ID of the trigger.

Secret

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

Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.

Source

Location of the source in a supported storage service.

If provided, get the source from this location in Google Cloud Storage.

SourceProvenance

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

A copy of the build's source.repo_source, if exists, with any revisions resolved.

Status

API documentation for devtools.cloudbuild_v1.types.Status class.

StorageSource

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

Google Cloud Storage object containing the source. This object must be a gzipped archive file (.tar.gz) containing source to build.

TimeSpan

Start and end times for a build execution phase.

End of time span.

Timestamp

API documentation for devtools.cloudbuild_v1.types.Timestamp class.

UpdateBuildTriggerRequest

Request to update an existing BuildTrigger.

Required. ID of the BuildTrigger to update.

UpdateWorkerPoolRequest

Request to update a WorkerPool.

\ WorkerPool resource to update.

Volume

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

Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.

WaitOperationRequest

API documentation for devtools.cloudbuild_v1.types.WaitOperationRequest class.

WorkerConfig

WorkerConfig defines the configuration to be used for a creating workers in the pool.

Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If 0 is specified, Cloud Build will use a standard disk size. disk_size is overridden if you specify a different disk size in build_options. In this case, a VM with a disk size specified in the build_options will be created on demand at build time. For more information see https://cloud.google.com/cloud- build/docs/api/reference/rest/v1/projects.builds#buildoptions

The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is worker.

WorkerPool

Configuration for a WorkerPool to run the builds.

Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool.

The project ID of the GCP project for which the WorkerPool is created.

Total number of workers to be created across all requested regions.

List of regions to create the WorkerPool. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing WorkerPool will not be enabled in the new region automatically; you must add the new region to the regions field to enable the WorkerPool in that region.

Output only. Time at which the request to update the WorkerPool was received.

Output only. WorkerPool Status.