package google.devtools.cloudbuild.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service CloudBuild
cloudbuild.proto:41Creates and manages builds on Google Cloud Platform. The main concept used by this API is a `Build`, which describes the location of the source to build, how to build the source, and where to store the built artifacts, if any. A user can list previously-requested builds or get builds by their ID to determine the status of the build.
rpc CreateBuild (, )
cloudbuild.proto:51Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`).
message
cloudbuild.proto:750Request to create a new build.
string project_id = 1
Required. ID of the project.
optional build = 2
Required. Build resource to create.
rpc GetBuild (, )
cloudbuild.proto:67Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information.
message
cloudbuild.proto:759Request to get a build.
string project_id = 1
Required. ID of the project.
string id = 2
Required. ID of the build.
rpc ListBuilds (, )
cloudbuild.proto:78Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.
message
cloudbuild.proto:768Request to list builds.
string project_id = 1
Required. ID of the project.
int32 page_size = 2
Number of results to return in the list.
string page_token = 3
Token to provide to skip to a particular spot in the list.
string filter = 8
The raw filter text to constrain the results.
message
cloudbuild.proto:783Response including listed builds.
repeated builds = 1
Builds will be sorted by `create_time`, descending.
string next_page_token = 2
Token to receive the next page of results.
rpc CancelBuild (, )
cloudbuild.proto:86Cancels a build in progress.
message
cloudbuild.proto:792Request to cancel an ongoing build.
string project_id = 1
Required. ID of the project.
string id = 2
Required. ID of the build.
rpc RetryBuild (, )
cloudbuild.proto:121Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Google Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.
message
cloudbuild.proto:230Specifies a build to retry.
string project_id = 1
Required. ID of the project.
string id = 2
Required. Build ID of the original build.
Creates a new `BuildTrigger`. This API is experimental.
message
cloudbuild.proto:947Request to create a new `BuildTrigger`.
string project_id = 1
Required. ID of the project for which to configure automatic builds.
optional trigger = 2
Required. `BuildTrigger` to create.
rpc GetBuildTrigger (, )
cloudbuild.proto:147Returns information about a `BuildTrigger`. This API is experimental.
message
cloudbuild.proto:956Returns the `BuildTrigger` with the specified ID.
string project_id = 1
Required. ID of the project that owns the trigger.
string trigger_id = 2
Required. ID of the `BuildTrigger` to get.
Lists existing `BuildTrigger`s. This API is experimental.
message
cloudbuild.proto:965Request to list existing `BuildTriggers`.
string project_id = 1
Required. ID of the project for which to list BuildTriggers.
int32 page_size = 2
Number of results to return in the list.
string page_token = 3
Token to provide to skip to a particular spot in the list.
message
cloudbuild.proto:977Response containing existing `BuildTriggers`.
repeated triggers = 1
`BuildTriggers` for the project, sorted by `create_time` descending.
string next_page_token = 2
Token to receive the next page of results.
Deletes a `BuildTrigger` by its project ID and trigger ID. This API is experimental.
message
cloudbuild.proto:986Request to delete a `BuildTrigger`.
string project_id = 1
Required. ID of the project that owns the trigger.
string trigger_id = 2
Required. ID of the `BuildTrigger` to delete.
Updates a `BuildTrigger` by its project ID and trigger ID. This API is experimental.
message
cloudbuild.proto:995Request to update an existing `BuildTrigger`.
string project_id = 1
Required. ID of the project that owns the trigger.
string trigger_id = 2
Required. ID of the `BuildTrigger` to update.
optional trigger = 3
Required. `BuildTrigger` to update.
rpc RunBuildTrigger (, )
cloudbuild.proto:188Runs a `BuildTrigger` at a particular source revision.
message
cloudbuild.proto:239Specifies a build trigger to run and the source to use.
string project_id = 1
Required. ID of the project.
string trigger_id = 2
Required. ID of the trigger.
optional source = 3
Required. Source to build against this trigger.
rpc CreateWorkerPool (, )
cloudbuild.proto:204Creates a `WorkerPool` to run the builds, and returns the new worker pool. This API is experimental.
message
cloudbuild.proto:1262Request to create a new `WorkerPool`.
string parent = 1
ID of the parent project.
optional worker_pool = 2
`WorkerPool` resource to create.
rpc GetWorkerPool (, )
cloudbuild.proto:209Returns information about a `WorkerPool`. This API is experimental.
message
cloudbuild.proto:1271Request to get a `WorkerPool` with the specified name.
string name = 1
The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name"
rpc DeleteWorkerPool (, )
cloudbuild.proto:214Deletes a `WorkerPool` by its project ID and WorkerPool name. This API is experimental.
message
cloudbuild.proto:1278Request to delete a `WorkerPool`.
string name = 1
The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name"
rpc UpdateWorkerPool (, )
cloudbuild.proto:220Update a `WorkerPool`. This API is experimental.
message
cloudbuild.proto:1285Request to update a `WorkerPool`.
string name = 2
The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name"
optional worker_pool = 3
`WorkerPool` resource to update.
rpc ListWorkerPools (, )
cloudbuild.proto:225List project's `WorkerPool`s. This API is experimental.
message
cloudbuild.proto:1295Request to list `WorkerPool`s.
string parent = 1
ID of the parent project.
message
cloudbuild.proto:1301Response containing existing `WorkerPools`.
repeated worker_pools = 1
`WorkerPools` for the project.
message
cloudbuild.proto:470An artifact that was uploaded during a build. This is a single record in the artifact manifest JSON file.
string location = 1
The path of an artifact in a Google Cloud Storage bucket, with the generation number. For example, `gs://mybucket/path/to/output.jar#generation`.
repeated file_hash = 2
The file hash of the artifact.
message
cloudbuild.proto:623Artifacts produced by a build that should be uploaded upon successful completion of all build steps.
Used in:
repeated string images = 1
A list of images to be pushed upon the successful completion of all build steps. The images will be 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 is marked FAILURE.
optional objects = 2
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.
message
cloudbuild.proto:626Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.
Used in:
string location = 1
Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.
repeated string paths = 2
Path globs used to match files in the build's workspace.
optional timing = 3
Output only. Stores timing information for pushing all artifact objects.
message
cloudbuild.proto:497A 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.
Used as response type in: CloudBuild.CancelBuild, CloudBuild.GetBuild
Used as field type in: , , ,
string id = 1
Output only. Unique identifier of the build.
string project_id = 16
Output only. ID of the project.
Build.Status status = 2
Output only. Status of the build.
string status_detail = 24
Output only. Customer-readable message about the current status.
optional source = 3
The location of the source files to build.
repeated steps = 11
Required. The operations to be performed on the workspace.
optional results = 10
Output only. Results of the build.
optional create_time = 6
Output only. Time at which the request to create the build was received.
optional start_time = 7
Output only. Time at which execution of the build was started.
optional finish_time = 8
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.
optional timeout = 12
Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. Default time is ten minutes.
repeated string images = 13
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`.
optional artifacts = 37
Artifacts produced by the build that should be uploaded upon successful completion of all build steps.
string logs_bucket = 19
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`.
optional source_provenance = 21
Output only. A permanent fixed identifier for source.
string build_trigger_id = 22
Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically.
optional options = 23
Special options for this build.
string log_url = 25
Output only. URL to logs for this build in Google Cloud Console.
map<string, string> substitutions = 29
Substitutions data for `Build` resource.
repeated string tags = 31
Tags for annotation of a `Build`. These are not docker tags.
repeated secrets = 32
Secrets to decrypt using Cloud Key Management Service.
map<string, > timing = 33
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.
Possible status of a build or build step.
Used in: ,
STATUS_UNKNOWN = 0
Status of the build is unknown.
QUEUED = 1
Build or step is queued; work has not yet begun.
WORKING = 2
Build or step is being executed.
SUCCESS = 3
Build or step finished successfully.
FAILURE = 4
Build or step failed to complete successfully.
INTERNAL_ERROR = 5
Build or step failed due to an internal cause.
TIMEOUT = 6
Build or step took longer than was allowed.
CANCELLED = 7
Build or step was canceled by a user.
message
cloudbuild.proto:677Metadata for build operations.
optional build = 1
The build that the operation is tracking.
message
cloudbuild.proto:1007Optional arguments to enable specific features of builds.
Used in:
repeated Hash.HashType source_provenance_hash = 1
Requested hash for SourceProvenance.
BuildOptions.VerifyOption requested_verify_option = 2
Requested verifiability options.
BuildOptions.MachineType machine_type = 3
Compute Engine machine type on which to run the build.
int64 disk_size_gb = 6
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.
BuildOptions.SubstitutionOption substitution_option = 4
Option to specify behavior when there is an error in the substitution checks.
BuildOptions.LogStreamingOption log_streaming_option = 5
Option to define build log streaming behavior to Google Cloud Storage.
string worker_pool = 7
Option to specify a `WorkerPool` for the build. User specifies the pool with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]". This is an experimental field.
BuildOptions.LoggingMode logging = 11
Option to specify the logging mode, which determines where the logs are stored.
repeated string env = 12
A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".
repeated string secret_env = 13
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.
repeated volumes = 14
Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration.
Specifies the behavior when writing build logs to Google Cloud Storage.
Used in:
STREAM_DEFAULT = 0
Service may automatically determine build log streaming behavior.
STREAM_ON = 1
Build logs should be streamed to Google Cloud Storage.
STREAM_OFF = 2
Build logs should not be streamed to Google Cloud Storage; they will be written when the build is completed.
Specifies the logging mode.
Used in:
LOGGING_UNSPECIFIED = 0
The service determines the logging mode. The default is `LEGACY`. Do not rely on the default logging behavior as it may change in the future.
LEGACY = 1
Stackdriver logging and Cloud Storage logging are enabled.
GCS_ONLY = 2
Only Cloud Storage logging is enabled.
Supported VM sizes.
Used in:
UNSPECIFIED = 0
Standard machine type.
N1_HIGHCPU_8 = 1
Highcpu machine with 8 CPUs.
N1_HIGHCPU_32 = 2
Highcpu machine with 32 CPUs.
Specifies the behavior when there is an error in the substitution checks.
Used in:
MUST_MATCH = 0
Fails the build if error in substitutions checks, like missing a substitution in the template or in the map.
ALLOW_LOOSE = 1
Do not fail the build if error in substitutions checks.
Specifies the manner in which the build should be verified, if at all.
Used in:
NOT_VERIFIED = 0
Not a verifiable build. (default)
VERIFIED = 1
Verified build.
message
cloudbuild.proto:331A step in the build pipeline.
Used in:
string name = 1
Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.
repeated string env = 2
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".
repeated string args = 3
A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.
string dir = 4
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.
string id = 5
Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.
repeated string wait_for = 6
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.
string entrypoint = 7
Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.
repeated string secret_env = 8
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`.
repeated volumes = 9
List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.
optional timing = 10
Output only. Stores timing information for executing this build step.
optional pull_timing = 13
Output only. Stores timing information for pulling this build step's builder image only.
optional timeout = 11
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.
Build.Status status = 12
Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.
message
cloudbuild.proto:802Configuration for an automated build in response to source repository changes.
Used as response type in: CloudBuild.CreateBuildTrigger, CloudBuild.GetBuildTrigger, CloudBuild.UpdateBuildTrigger
Used as field type in: , ,
string id = 1
Output only. Unique identifier of the trigger.
string description = 10
Human-readable description of this trigger.
string name = 21
User assigned name of the trigger. Must be unique within the project.
repeated string tags = 19
Tags for annotation of a `BuildTrigger`
optional trigger_template = 7
Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. Mutually exclusive with `github`.
optional github = 13
GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. Mutually exclusive with `trigger_template`.
oneof build_template
Template describing the Build request to make when the trigger is matched.
build = 4
Contents of the build template.
string filename = 8
Path, from the source root, to a file whose contents is used for the template.
optional create_time = 5
Output only. Time when the trigger was created.
bool disabled = 9
If true, the trigger will never result in a build.
map<string, string> substitutions = 11
Substitutions data for Build resource.
repeated string ignored_files = 15
ignored_files and included_files are file glob matches using http://godoc/pkg/path/filepath#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build.
repeated string included_files = 16
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.
message
cloudbuild.proto:318An image built by the pipeline.
Used in:
string name = 1
Name used to push the container image to Google Container Registry, as presented to `docker push`.
string digest = 3
Docker Registry 2.0 digest.
optional push_timing = 4
Output only. Stores timing information for pushing the specified image.
message
cloudbuild.proto:708Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.
Used in: ,
repeated file_hash = 1
Collection of file hashes.
message
cloudbuild.proto:875GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental.
Used in:
int64 installation_id = 1
The installationID that emits the GitHub event.
string owner = 6
Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is "googlecloudplatform".
string name = 7
Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders".
oneof event
Filter describing the types of events to trigger a build. Currently supported event types: push, pull_request.
pull_request = 4
filter to match changes in pull requests.
push = 5
filter to match changes in refs like branches, tags.
message
cloudbuild.proto:714Container message for hash values.
Used in:
Hash.HashType type = 1
The type of hash that was performed.
bytes value = 2
The hash value.
Specifies the hash algorithm, if any.
Used in: ,
NONE = 0
No hash requested.
SHA256 = 1
Use a sha256 hash.
MD5 = 2
Use a md5 hash.
message
cloudbuild.proto:1244Network describes the GCP network used to create workers in.
Used in:
string project_id = 1
Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id.
string network = 2
Network on which the workers are created. "default" network is used if empty.
string subnetwork = 3
Subnetwork on which the workers are created. "default" subnetwork is used if empty.
message
cloudbuild.proto:901PullRequestFilter contains filter properties for matching GitHub Pull Requests.
Used in:
oneof git_ref
Target refs to match. A target ref is the git reference where the pull request will be applied.
string branch = 2
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
PullRequestFilter.CommentControl comment_control = 5
Whether to block builds on a "/gcbrun" comment from a repository owner or collaborator.
Controls behavior of Pull Request comments.
Used in:
COMMENTS_DISABLED = 0
Do not require comments on Pull Requests before builds are triggered.
COMMENTS_ENABLED = 1
Enforce that repository owners or collaborators must comment on Pull Requests before builds are triggered.
message
cloudbuild.proto:928Push contains filter properties for matching GitHub git pushes.
Used in:
oneof git_ref
Modified refs to match. A modified refs are the refs modified by a git push operation.
string branch = 2
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
string tag = 3
Regexes matching tags 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
message
cloudbuild.proto:269Location of the source in a Google Cloud Source Repository.
Used in: , , ,
string project_id = 1
ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
string repo_name = 2
Name of the Cloud Source Repository. If omitted, the name "default" is assumed.
oneof revision
A revision within the Cloud Source Repository must be specified in one of these ways.
string branch_name = 3
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
string tag_name = 4
Regex matching tags 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
string commit_sha = 5
Explicit commit SHA to build.
string dir = 7
Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution.
message
cloudbuild.proto:442Artifacts created by the build pipeline.
Used in:
repeated images = 2
Container images that were built as a part of the build.
repeated string build_step_images = 3
List of build step digests, in the order corresponding to build step indices.
string artifact_manifest = 4
Path to the artifact manifest. Only populated when artifacts are uploaded.
int64 num_artifacts = 5
Number of artifacts uploaded. Only populated when artifacts are uploaded.
repeated bytes build_step_outputs = 6
List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored.
optional artifact_timing = 7
Time to push all non-container artifacts.
message
cloudbuild.proto:736Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value.
Used in:
string kms_key_name = 1
Cloud KMS key name to use to decrypt these envs.
map<string, bytes> secret_env = 3
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.
message
cloudbuild.proto:305Location of the source in a supported storage service.
Used in:
oneof source
Location of source.
storage_source = 2
If provided, get the source from this location in Google Cloud Storage.
repo_source = 3
If provided, get the source from this location in a Cloud Source Repository.
message
cloudbuild.proto:684Provenance of the source. Ways to find the original source, or verify that some source was used for this build.
Used in:
optional resolved_storage_source = 3
A copy of the build's `source.storage_source`, if exists, with any generations resolved.
optional resolved_repo_source = 6
A copy of the build's `source.repo_source`, if exists, with any revisions resolved.
map<string, > file_hashes = 4
Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file.
message
cloudbuild.proto:251Location of the source in an archive file in Google Cloud Storage.
Used in: ,
string bucket = 1
Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
string object = 2
Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.
int64 generation = 3
Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
message
cloudbuild.proto:668Start and end times for a build execution phase.
Used in: , , , ,
optional start_time = 1
Start of time span.
optional end_time = 2
End of time span.
message
cloudbuild.proto:427Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.
Used in: ,
string name = 1
Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
string path = 2
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.
message
cloudbuild.proto:1211WorkerConfig defines the configuration to be used for a creating workers in the pool.
Used in:
string machine_type = 1
Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. `machine_type` is overridden if you specify a different machine type in `build_options`. In this case, the VM specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes
int64 disk_size_gb = 2
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
optional network = 3
The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network.
string tag = 4
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`.
message
cloudbuild.proto:1132Configuration 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.
Used as response type in: CloudBuild.CreateWorkerPool, CloudBuild.GetWorkerPool, CloudBuild.UpdateWorkerPool
Used as field type in: , ,
string name = 14
User-defined name of the `WorkerPool`.
string project_id = 2
The project ID of the GCP project for which the `WorkerPool` is created.
string service_account_email = 3
Output only. The service account used to manage the `WorkerPool`. The service account must have the Compute Instance Admin (Beta) permission at the project level.
int64 worker_count = 4
Total number of workers to be created across all requested regions.
optional worker_config = 16
Configuration to be used for a creating workers in the `WorkerPool`.
repeated WorkerPool.Region regions = 9
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.
optional create_time = 11
Output only. Time at which the request to create the `WorkerPool` was received.
optional update_time = 17
Output only. Time at which the request to update the `WorkerPool` was received.
optional delete_time = 12
Output only. Time at which the request to delete the `WorkerPool` was received.
WorkerPool.Status status = 13
Output only. WorkerPool Status.
Supported GCP regions to create the `WorkerPool`.
Used in:
REGION_UNSPECIFIED = 0
no region
US_CENTRAL1 = 1
us-central1 region
US_WEST1 = 2
us-west1 region
US_EAST1 = 3
us-east1 region
US_EAST4 = 4
us-east4 region
`WorkerPool` status
Used in:
STATUS_UNSPECIFIED = 0
Status of the `WorkerPool` is unknown.
CREATING = 1
`WorkerPool` is being created.
RUNNING = 2
`WorkerPool` is running.
DELETING = 3
`WorkerPool` is being deleting: cancelling builds and draining workers.
DELETED = 4
`WorkerPool` is deleted.