# frozen_string_literal: true
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
module Google
module Cloud
module Build
module V1
# Specifies a build to retry.
# @!attribute [rw] name
# @return [::String]
# The name of the `Build` to retry.
# Format: `projects/{project}/locations/{location}/builds/{build}`
# @!attribute [rw] project_id
# @return [::String]
# Required. ID of the project.
# @!attribute [rw] id
# @return [::String]
# Required. Build ID of the original build.
class RetryBuildRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Specifies a build trigger to run and the source to use.
# @!attribute [rw] project_id
# @return [::String]
# Required. ID of the project.
# @!attribute [rw] trigger_id
# @return [::String]
# Required. ID of the trigger.
# @!attribute [rw] source
# @return [::Google::Cloud::Build::V1::RepoSource]
# Required. Source to build against this trigger.
class RunBuildTriggerRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Location of the source in an archive file in Google Cloud Storage.
# @!attribute [rw] bucket
# @return [::String]
# Google Cloud Storage bucket containing the source (see
# [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
# @!attribute [rw] object
# @return [::String]
# Google Cloud Storage object containing the source.
#
# This object must be a gzipped archive file (`.tar.gz`) containing source to
# build.
# @!attribute [rw] generation
# @return [::Integer]
# Google Cloud Storage generation for the object. If the generation is
# omitted, the latest generation will be used.
class StorageSource
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Location of the source in a Google Cloud Source Repository.
# @!attribute [rw] project_id
# @return [::String]
# ID of the project that owns the Cloud Source Repository. If omitted, the
# project ID requesting the build is assumed.
# @!attribute [rw] repo_name
# @return [::String]
# Required. Name of the Cloud Source Repository.
# @!attribute [rw] branch_name
# @return [::String]
# 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
# @!attribute [rw] tag_name
# @return [::String]
# 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
# @!attribute [rw] commit_sha
# @return [::String]
# Explicit commit SHA to build.
# @!attribute [rw] dir
# @return [::String]
# 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.
# @!attribute [rw] invert_regex
# @return [::Boolean]
# Only trigger a build if the revision regex does NOT match the revision
# regex.
# @!attribute [rw] substitutions
# @return [::Google::Protobuf::Map{::String => ::String}]
# Substitutions to use in a triggered build.
# Should only be used with RunBuildTrigger
class RepoSource
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# @!attribute [rw] key
# @return [::String]
# @!attribute [rw] value
# @return [::String]
class SubstitutionsEntry
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
end
# Location of the source in a supported storage service.
# @!attribute [rw] storage_source
# @return [::Google::Cloud::Build::V1::StorageSource]
# If provided, get the source from this location in Google Cloud Storage.
# @!attribute [rw] repo_source
# @return [::Google::Cloud::Build::V1::RepoSource]
# If provided, get the source from this location in a Cloud Source
# Repository.
class Source
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# An image built by the pipeline.
# @!attribute [rw] name
# @return [::String]
# Name used to push the container image to Google Container Registry, as
# presented to `docker push`.
# @!attribute [rw] digest
# @return [::String]
# Docker Registry 2.0 digest.
# @!attribute [r] push_timing
# @return [::Google::Cloud::Build::V1::TimeSpan]
# Output only. Stores timing information for pushing the specified image.
class BuiltImage
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# A step in the build pipeline.
# @!attribute [rw] name
# @return [::String]
# 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.
# @!attribute [rw] env
# @return [::Array<::String>]
# 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".
# @!attribute [rw] args
# @return [::Array<::String>]
# 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.
# @!attribute [rw] dir
# @return [::String]
# 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.
# @!attribute [rw] id
# @return [::String]
# Unique identifier for this build step, used in `wait_for` to
# reference this build step as a dependency.
# @!attribute [rw] wait_for
# @return [::Array<::String>]
# 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.
# @!attribute [rw] entrypoint
# @return [::String]
# Entrypoint to be used instead of the build step image's default entrypoint.
# If unset, the image's default entrypoint is used.
# @!attribute [rw] secret_env
# @return [::Array<::String>]
# 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`.
# @!attribute [rw] volumes
# @return [::Array<::Google::Cloud::Build::V1::Volume>]
# 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.
# @!attribute [r] timing
# @return [::Google::Cloud::Build::V1::TimeSpan]
# Output only. Stores timing information for executing this build step.
# @!attribute [r] pull_timing
# @return [::Google::Cloud::Build::V1::TimeSpan]
# Output only. Stores timing information for pulling this build step's
# builder image only.
# @!attribute [rw] timeout
# @return [::Google::Protobuf::Duration]
# 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.
# @!attribute [r] status
# @return [::Google::Cloud::Build::V1::Build::Status]
# 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.
class BuildStep
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Volume describes a Docker container volume which is mounted into build steps
# in order to persist files across build step execution.
# @!attribute [rw] name
# @return [::String]
# 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.
# @!attribute [rw] path
# @return [::String]
# 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.
class Volume
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Artifacts created by the build pipeline.
# @!attribute [rw] images
# @return [::Array<::Google::Cloud::Build::V1::BuiltImage>]
# Container images that were built as a part of the build.
# @!attribute [rw] build_step_images
# @return [::Array<::String>]
# List of build step digests, in the order corresponding to build step
# indices.
# @!attribute [rw] artifact_manifest
# @return [::String]
# Path to the artifact manifest. Only populated when artifacts are uploaded.
# @!attribute [rw] num_artifacts
# @return [::Integer]
# Number of artifacts uploaded. Only populated when artifacts are uploaded.
# @!attribute [rw] build_step_outputs
# @return [::Array<::String>]
# 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.
# @!attribute [rw] artifact_timing
# @return [::Google::Cloud::Build::V1::TimeSpan]
# Time to push all non-container artifacts.
class Results
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# An artifact that was uploaded during a build. This
# is a single record in the artifact manifest JSON file.
# @!attribute [rw] location
# @return [::String]
# The path of an artifact in a Google Cloud Storage bucket, with the
# generation number. For example,
# `gs://mybucket/path/to/output.jar#generation`.
# @!attribute [rw] file_hash
# @return [::Array<::Google::Cloud::Build::V1::FileHashes>]
# The file hash of the artifact.
class ArtifactResult
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# 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.
# @!attribute [r] name
# @return [::String]
# Output only. The 'Build' name with format:
# `projects/{project}/locations/{location}/builds/{build}`, where \\{build}
# is a unique identifier generated by the service.
# @!attribute [r] id
# @return [::String]
# Output only. Unique identifier of the build.
# @!attribute [r] project_id
# @return [::String]
# Output only. ID of the project.
# @!attribute [r] status
# @return [::Google::Cloud::Build::V1::Build::Status]
# Output only. Status of the build.
# @!attribute [r] status_detail
# @return [::String]
# Output only. Customer-readable message about the current status.
# @!attribute [rw] source
# @return [::Google::Cloud::Build::V1::Source]
# The location of the source files to build.
# @!attribute [rw] steps
# @return [::Array<::Google::Cloud::Build::V1::BuildStep>]
# Required. The operations to be performed on the workspace.
# @!attribute [r] results
# @return [::Google::Cloud::Build::V1::Results]
# Output only. Results of the build.
# @!attribute [r] create_time
# @return [::Google::Protobuf::Timestamp]
# Output only. Time at which the request to create the build was received.
# @!attribute [r] start_time
# @return [::Google::Protobuf::Timestamp]
# Output only. Time at which execution of the build was started.
# @!attribute [r] finish_time
# @return [::Google::Protobuf::Timestamp]
# 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.
# @!attribute [rw] timeout
# @return [::Google::Protobuf::Duration]
# 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`.
#
# `timeout` starts ticking from `startTime`.
#
# Default time is ten minutes.
# @!attribute [rw] images
# @return [::Array<::String>]
# 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`.
# @!attribute [rw] queue_ttl
# @return [::Google::Protobuf::Duration]
# TTL in queue for this build. If provided and the build is enqueued longer
# than this value, the build will expire and the build status will be
# `EXPIRED`.
#
# The TTL starts ticking from create_time.
# @!attribute [rw] artifacts
# @return [::Google::Cloud::Build::V1::Artifacts]
# Artifacts produced by the build that should be uploaded upon
# successful completion of all build steps.
# @!attribute [rw] logs_bucket
# @return [::String]
# 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`.
# @!attribute [r] source_provenance
# @return [::Google::Cloud::Build::V1::SourceProvenance]
# Output only. A permanent fixed identifier for source.
# @!attribute [r] build_trigger_id
# @return [::String]
# Output only. The ID of the `BuildTrigger` that triggered this build, if it
# was triggered automatically.
# @!attribute [rw] options
# @return [::Google::Cloud::Build::V1::BuildOptions]
# Special options for this build.
# @!attribute [r] log_url
# @return [::String]
# Output only. URL to logs for this build in Google Cloud Console.
# @!attribute [rw] substitutions
# @return [::Google::Protobuf::Map{::String => ::String}]
# Substitutions data for `Build` resource.
# @!attribute [rw] tags
# @return [::Array<::String>]
# Tags for annotation of a `Build`. These are not docker tags.
# @!attribute [rw] secrets
# @return [::Array<::Google::Cloud::Build::V1::Secret>]
# Secrets to decrypt using Cloud Key Management Service.
# @!attribute [r] timing
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Build::V1::TimeSpan}]
# 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.
# @!attribute [rw] service_account
# @return [::String]
# IAM service account whose credentials will be used at build runtime.
# Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
# ACCOUNT can be email address or uniqueId of the service account.
#
# This field is in alpha and is not publicly available.
class Build
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# @!attribute [rw] key
# @return [::String]
# @!attribute [rw] value
# @return [::String]
class SubstitutionsEntry
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# @!attribute [rw] key
# @return [::String]
# @!attribute [rw] value
# @return [::Google::Cloud::Build::V1::TimeSpan]
class TimingEntry
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Possible status of a build or build step.
module Status
# Status of the build is unknown.
STATUS_UNKNOWN = 0
# Build or step is queued; work has not yet begun.
QUEUED = 1
# Build or step is being executed.
WORKING = 2
# Build or step finished successfully.
SUCCESS = 3
# Build or step failed to complete successfully.
FAILURE = 4
# Build or step failed due to an internal cause.
INTERNAL_ERROR = 5
# Build or step took longer than was allowed.
TIMEOUT = 6
# Build or step was canceled by a user.
CANCELLED = 7
# Build was enqueued for longer than the value of `queue_ttl`.
EXPIRED = 9
end
end
# Artifacts produced by a build that should be uploaded upon
# successful completion of all build steps.
# @!attribute [rw] images
# @return [::Array<::String>]
# 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.
# @!attribute [rw] objects
# @return [::Google::Cloud::Build::V1::Artifacts::ArtifactObjects]
# 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.
class Artifacts
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# Files in the workspace to upload to Cloud Storage upon successful
# completion of all build steps.
# @!attribute [rw] location
# @return [::String]
# 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.
# @!attribute [rw] paths
# @return [::Array<::String>]
# Path globs used to match files in the build's workspace.
# @!attribute [r] timing
# @return [::Google::Cloud::Build::V1::TimeSpan]
# Output only. Stores timing information for pushing all artifact objects.
class ArtifactObjects
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
end
# Start and end times for a build execution phase.
# @!attribute [rw] start_time
# @return [::Google::Protobuf::Timestamp]
# Start of time span.
# @!attribute [rw] end_time
# @return [::Google::Protobuf::Timestamp]
# End of time span.
class TimeSpan
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Metadata for build operations.
# @!attribute [rw] build
# @return [::Google::Cloud::Build::V1::Build]
# The build that the operation is tracking.
class BuildOperationMetadata
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Provenance of the source. Ways to find the original source, or verify that
# some source was used for this build.
# @!attribute [rw] resolved_storage_source
# @return [::Google::Cloud::Build::V1::StorageSource]
# A copy of the build's `source.storage_source`, if exists, with any
# generations resolved.
# @!attribute [rw] resolved_repo_source
# @return [::Google::Cloud::Build::V1::RepoSource]
# A copy of the build's `source.repo_source`, if exists, with any
# revisions resolved.
# @!attribute [r] file_hashes
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Build::V1::FileHashes}]
# 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.
class SourceProvenance
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# @!attribute [rw] key
# @return [::String]
# @!attribute [rw] value
# @return [::Google::Cloud::Build::V1::FileHashes]
class FileHashesEntry
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
end
# Container message for hashes of byte content of files, used in
# SourceProvenance messages to verify integrity of source input to the build.
# @!attribute [rw] file_hash
# @return [::Array<::Google::Cloud::Build::V1::Hash>]
# Collection of file hashes.
class FileHashes
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Container message for hash values.
# @!attribute [rw] type
# @return [::Google::Cloud::Build::V1::Hash::HashType]
# The type of hash that was performed.
# @!attribute [rw] value
# @return [::String]
# The hash value.
class Hash
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# Specifies the hash algorithm, if any.
module HashType
# No hash requested.
NONE = 0
# Use a sha256 hash.
SHA256 = 1
# Use a md5 hash.
MD5 = 2
end
end
# Pairs a set of secret environment variables containing encrypted
# values with the Cloud KMS key to use to decrypt the value.
# @!attribute [rw] kms_key_name
# @return [::String]
# Cloud KMS key name to use to decrypt these envs.
# @!attribute [rw] secret_env
# @return [::Google::Protobuf::Map{::String => ::String}]
# 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.
class Secret
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# @!attribute [rw] key
# @return [::String]
# @!attribute [rw] value
# @return [::String]
class SecretEnvEntry
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
end
# Request to create a new build.
# @!attribute [rw] parent
# @return [::String]
# The parent resource where this build will be created.
# Format: `projects/{project}/locations/{location}`
# @!attribute [rw] project_id
# @return [::String]
# Required. ID of the project.
# @!attribute [rw] build
# @return [::Google::Cloud::Build::V1::Build]
# Required. Build resource to create.
class CreateBuildRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Request to get a build.
# @!attribute [rw] name
# @return [::String]
# The name of the `Build` to retrieve.
# Format: `projects/{project}/locations/{location}/builds/{build}`
# @!attribute [rw] project_id
# @return [::String]
# Required. ID of the project.
# @!attribute [rw] id
# @return [::String]
# Required. ID of the build.
class GetBuildRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Request to list builds.
# @!attribute [rw] parent
# @return [::String]
# The parent of the collection of `Builds`.
# Format: `projects/{project}/locations/location`
# @!attribute [rw] project_id
# @return [::String]
# Required. ID of the project.
# @!attribute [rw] page_size
# @return [::Integer]
# Number of results to return in the list.
# @!attribute [rw] page_token
# @return [::String]
# Token to provide to skip to a particular spot in the list.
# @!attribute [rw] filter
# @return [::String]
# The raw filter text to constrain the results.
class ListBuildsRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Response including listed builds.
# @!attribute [rw] builds
# @return [::Array<::Google::Cloud::Build::V1::Build>]
# Builds will be sorted by `create_time`, descending.
# @!attribute [rw] next_page_token
# @return [::String]
# Token to receive the next page of results.
class ListBuildsResponse
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Request to cancel an ongoing build.
# @!attribute [rw] name
# @return [::String]
# The name of the `Build` to retrieve.
# Format: `projects/{project}/locations/{location}/builds/{build}`
# @!attribute [rw] project_id
# @return [::String]
# Required. ID of the project.
# @!attribute [rw] id
# @return [::String]
# Required. ID of the build.
class CancelBuildRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Configuration for an automated build in response to source repository
# changes.
# @!attribute [r] id
# @return [::String]
# Output only. Unique identifier of the trigger.
# @!attribute [rw] description
# @return [::String]
# Human-readable description of this trigger.
# @!attribute [rw] name
# @return [::String]
# User-assigned name of the trigger. Must be unique within the project.
# Trigger names must meet the following requirements:
#
# + They must contain only alphanumeric characters and dashes.
# + They can be 1-64 characters long.
# + They must begin and end with an alphanumeric character.
# @!attribute [rw] tags
# @return [::Array<::String>]
# Tags for annotation of a `BuildTrigger`
# @!attribute [rw] trigger_template
# @return [::Google::Cloud::Build::V1::RepoSource]
# 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`.
# @!attribute [rw] github
# @return [::Google::Cloud::Build::V1::GitHubEventsConfig]
# GitHubEventsConfig describes the configuration of a trigger that creates
# a build whenever a GitHub event is received.
#
# Mutually exclusive with `trigger_template`.
# @!attribute [rw] build
# @return [::Google::Cloud::Build::V1::Build]
# Contents of the build template.
# @!attribute [rw] filename
# @return [::String]
# Path, from the source root, to a file whose contents is used for the
# template.
# @!attribute [r] create_time
# @return [::Google::Protobuf::Timestamp]
# Output only. Time when the trigger was created.
# @!attribute [rw] disabled
# @return [::Boolean]
# If true, the trigger will never automatically execute a build.
# @!attribute [rw] substitutions
# @return [::Google::Protobuf::Map{::String => ::String}]
# Substitutions for Build resource. The keys must match the following
# regular expression: `^_[A-Z0-9_]+$`.
# @!attribute [rw] ignored_files
# @return [::Array<::String>]
# ignored_files and included_files are file glob matches using
# https://golang.org/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.
# @!attribute [rw] included_files
# @return [::Array<::String>]
# 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.
class BuildTrigger
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# @!attribute [rw] key
# @return [::String]
# @!attribute [rw] value
# @return [::String]
class SubstitutionsEntry
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
end
# GitHubEventsConfig describes the configuration of a trigger that creates a
# build whenever a GitHub event is received.
#
# This message is experimental.
# @!attribute [rw] installation_id
# @return [::Integer]
# The installationID that emits the GitHub event.
# @!attribute [rw] owner
# @return [::String]
# Owner of the repository. For example: The owner for
# https://github.com/googlecloudplatform/cloud-builders is
# "googlecloudplatform".
# @!attribute [rw] name
# @return [::String]
# Name of the repository. For example: The name for
# https://github.com/googlecloudplatform/cloud-builders is "cloud-builders".
# @!attribute [rw] pull_request
# @return [::Google::Cloud::Build::V1::PullRequestFilter]
# filter to match changes in pull requests.
# @!attribute [rw] push
# @return [::Google::Cloud::Build::V1::PushFilter]
# filter to match changes in refs like branches, tags.
class GitHubEventsConfig
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# PullRequestFilter contains filter properties for matching GitHub Pull
# Requests.
# @!attribute [rw] branch
# @return [::String]
# 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
# @!attribute [rw] comment_control
# @return [::Google::Cloud::Build::V1::PullRequestFilter::CommentControl]
# Configure builds to run whether a repository owner or collaborator need to
# comment `/gcbrun`.
# @!attribute [rw] invert_regex
# @return [::Boolean]
# If true, branches that do NOT match the git_ref will trigger a build.
class PullRequestFilter
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# Controls behavior of Pull Request comments.
module CommentControl
# Do not require comments on Pull Requests before builds are triggered.
COMMENTS_DISABLED = 0
# Enforce that repository owners or collaborators must comment on Pull
# Requests before builds are triggered.
COMMENTS_ENABLED = 1
end
end
# Push contains filter properties for matching GitHub git pushes.
# @!attribute [rw] branch
# @return [::String]
# 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
# @!attribute [rw] tag
# @return [::String]
# 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
# @!attribute [rw] invert_regex
# @return [::Boolean]
# When true, only trigger a build if the revision regex does NOT match the
# git_ref regex.
class PushFilter
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Request to create a new `BuildTrigger`.
# @!attribute [rw] project_id
# @return [::String]
# Required. ID of the project for which to configure automatic builds.
# @!attribute [rw] trigger
# @return [::Google::Cloud::Build::V1::BuildTrigger]
# Required. `BuildTrigger` to create.
class CreateBuildTriggerRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Returns the `BuildTrigger` with the specified ID.
# @!attribute [rw] project_id
# @return [::String]
# Required. ID of the project that owns the trigger.
# @!attribute [rw] trigger_id
# @return [::String]
# Required. Identifier (`id` or `name`) of the `BuildTrigger` to get.
class GetBuildTriggerRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Request to list existing `BuildTriggers`.
# @!attribute [rw] project_id
# @return [::String]
# Required. ID of the project for which to list BuildTriggers.
# @!attribute [rw] page_size
# @return [::Integer]
# Number of results to return in the list.
# @!attribute [rw] page_token
# @return [::String]
# Token to provide to skip to a particular spot in the list.
class ListBuildTriggersRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Response containing existing `BuildTriggers`.
# @!attribute [rw] triggers
# @return [::Array<::Google::Cloud::Build::V1::BuildTrigger>]
# `BuildTriggers` for the project, sorted by `create_time` descending.
# @!attribute [rw] next_page_token
# @return [::String]
# Token to receive the next page of results.
class ListBuildTriggersResponse
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Request to delete a `BuildTrigger`.
# @!attribute [rw] project_id
# @return [::String]
# Required. ID of the project that owns the trigger.
# @!attribute [rw] trigger_id
# @return [::String]
# Required. ID of the `BuildTrigger` to delete.
class DeleteBuildTriggerRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Request to update an existing `BuildTrigger`.
# @!attribute [rw] project_id
# @return [::String]
# Required. ID of the project that owns the trigger.
# @!attribute [rw] trigger_id
# @return [::String]
# Required. ID of the `BuildTrigger` to update.
# @!attribute [rw] trigger
# @return [::Google::Cloud::Build::V1::BuildTrigger]
# Required. `BuildTrigger` to update.
class UpdateBuildTriggerRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Optional arguments to enable specific features of builds.
# @!attribute [rw] source_provenance_hash
# @return [::Array<::Google::Cloud::Build::V1::Hash::HashType>]
# Requested hash for SourceProvenance.
# @!attribute [rw] requested_verify_option
# @return [::Google::Cloud::Build::V1::BuildOptions::VerifyOption]
# Requested verifiability options.
# @!attribute [rw] machine_type
# @return [::Google::Cloud::Build::V1::BuildOptions::MachineType]
# Compute Engine machine type on which to run the build.
# @!attribute [rw] disk_size_gb
# @return [::Integer]
# 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.
# @!attribute [rw] substitution_option
# @return [::Google::Cloud::Build::V1::BuildOptions::SubstitutionOption]
# Option to specify behavior when there is an error in the substitution
# checks.
#
# NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot
# be overridden in the build configuration file.
# @!attribute [rw] dynamic_substitutions
# @return [::Boolean]
# Option to specify whether or not to apply bash style string
# operations to the substitutions.
#
# NOTE: this is always enabled for triggered builds and cannot be
# overridden in the build configuration file.
# @!attribute [rw] log_streaming_option
# @return [::Google::Cloud::Build::V1::BuildOptions::LogStreamingOption]
# Option to define build log streaming behavior to Google Cloud
# Storage.
# @!attribute [rw] worker_pool
# @return [::String]
# Option to specify a `WorkerPool` for the build.
# Format: projects/\\{project}/locations/\\{location}/workerPools/\\{workerPool}
#
# This field is experimental.
# @!attribute [rw] logging
# @return [::Google::Cloud::Build::V1::BuildOptions::LoggingMode]
# Option to specify the logging mode, which determines if and where build
# logs are stored.
# @!attribute [rw] env
# @return [::Array<::String>]
# 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".
# @!attribute [rw] secret_env
# @return [::Array<::String>]
# 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.
# @!attribute [rw] volumes
# @return [::Array<::Google::Cloud::Build::V1::Volume>]
# 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.
class BuildOptions
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# Specifies the manner in which the build should be verified, if at all.
module VerifyOption
# Not a verifiable build. (default)
NOT_VERIFIED = 0
# Verified build.
VERIFIED = 1
end
# Supported Compute Engine machine types.
# For more information, see [Machine
# types](https://cloud.google.com/compute/docs/machine-types).
module MachineType
# Standard machine type.
UNSPECIFIED = 0
# Highcpu machine with 8 CPUs.
N1_HIGHCPU_8 = 1
# Highcpu machine with 32 CPUs.
N1_HIGHCPU_32 = 2
end
# Specifies the behavior when there is an error in the substitution checks.
module SubstitutionOption
# Fails the build if error in substitutions checks, like missing
# a substitution in the template or in the map.
MUST_MATCH = 0
# Do not fail the build if error in substitutions checks.
ALLOW_LOOSE = 1
end
# Specifies the behavior when writing build logs to Google Cloud Storage.
module LogStreamingOption
# Service may automatically determine build log streaming behavior.
STREAM_DEFAULT = 0
# Build logs should be streamed to Google Cloud Storage.
STREAM_ON = 1
# Build logs should not be streamed to Google Cloud Storage; they will be
# written when the build is completed.
STREAM_OFF = 2
end
# Specifies the logging mode.
module LoggingMode
# 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.
LOGGING_UNSPECIFIED = 0
# Cloud Logging and Cloud Storage logging are enabled.
LEGACY = 1
# Only Cloud Storage logging is enabled.
GCS_ONLY = 2
# This option is the same as CLOUD_LOGGING_ONLY.
STACKDRIVER_ONLY = 3
# Only Cloud Logging is enabled. Note that logs for both the Cloud Console
# UI and Cloud SDK are based on Cloud Storage logs, so neither will provide
# logs if this option is chosen.
CLOUD_LOGGING_ONLY = 5
# Turn off all logging. No build logs will be captured.
# Next ID: 6
NONE = 4
end
end
# 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.
# @!attribute [rw] name
# @return [::String]
# User-defined name of the `WorkerPool`.
# @!attribute [rw] project_id
# @return [::String]
# The project ID of the GCP project for which the `WorkerPool` is created.
# @!attribute [rw] service_account_email
# @return [::String]
# 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.
# @!attribute [rw] worker_count
# @return [::Integer]
# Total number of workers to be created across all requested regions.
# @!attribute [rw] worker_config
# @return [::Google::Cloud::Build::V1::WorkerConfig]
# Configuration to be used for a creating workers in the `WorkerPool`.
# @!attribute [rw] regions
# @return [::Array<::Google::Cloud::Build::V1::WorkerPool::Region>]
# 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.
# @!attribute [rw] create_time
# @return [::Google::Protobuf::Timestamp]
# Output only. Time at which the request to create the `WorkerPool` was
# received.
# @!attribute [rw] update_time
# @return [::Google::Protobuf::Timestamp]
# Output only. Time at which the request to update the `WorkerPool` was
# received.
# @!attribute [rw] delete_time
# @return [::Google::Protobuf::Timestamp]
# Output only. Time at which the request to delete the `WorkerPool` was
# received.
# @!attribute [rw] status
# @return [::Google::Cloud::Build::V1::WorkerPool::Status]
# Output only. WorkerPool Status.
class WorkerPool
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# Supported GCP regions to create the `WorkerPool`.
module Region
# no region
REGION_UNSPECIFIED = 0
# us-central1 region
US_CENTRAL1 = 1
# us-west1 region
US_WEST1 = 2
# us-east1 region
US_EAST1 = 3
# us-east4 region
US_EAST4 = 4
end
# `WorkerPool` status
module Status
# Status of the `WorkerPool` is unknown.
STATUS_UNSPECIFIED = 0
# `WorkerPool` is being created.
CREATING = 1
# `WorkerPool` is running.
RUNNING = 2
# `WorkerPool` is being deleted: cancelling builds and draining workers.
DELETING = 3
# `WorkerPool` is deleted.
DELETED = 4
end
end
# WorkerConfig defines the configuration to be used for a creating workers in
# the pool.
# @!attribute [rw] machine_type
# @return [::String]
# 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
# @!attribute [rw] disk_size_gb
# @return [::Integer]
# 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
# @!attribute [rw] network
# @return [::Google::Cloud::Build::V1::Network]
# 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.
# @!attribute [rw] tag
# @return [::String]
# 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`.
class WorkerConfig
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Network describes the GCP network used to create workers in.
# @!attribute [rw] project_id
# @return [::String]
# 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.
# @!attribute [rw] network
# @return [::String]
# Network on which the workers are created.
# "default" network is used if empty.
# @!attribute [rw] subnetwork
# @return [::String]
# Subnetwork on which the workers are created.
# "default" subnetwork is used if empty.
class Network
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Request to create a new `WorkerPool`.
# @!attribute [rw] parent
# @return [::String]
# ID of the parent project.
# @!attribute [rw] worker_pool
# @return [::Google::Cloud::Build::V1::WorkerPool]
# `WorkerPool` resource to create.
class CreateWorkerPoolRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Request to get a `WorkerPool` with the specified name.
# @!attribute [rw] name
# @return [::String]
# The field will contain name of the resource requested, for example:
# "projects/project-1/workerPools/workerpool-name"
class GetWorkerPoolRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Request to delete a `WorkerPool`.
# @!attribute [rw] name
# @return [::String]
# The field will contain name of the resource requested, for example:
# "projects/project-1/workerPools/workerpool-name"
class DeleteWorkerPoolRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Request to update a `WorkerPool`.
# @!attribute [rw] name
# @return [::String]
# The field will contain name of the resource requested, for example:
# "projects/project-1/workerPools/workerpool-name"
# @!attribute [rw] worker_pool
# @return [::Google::Cloud::Build::V1::WorkerPool]
# `WorkerPool` resource to update.
class UpdateWorkerPoolRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Request to list `WorkerPools`.
# @!attribute [rw] parent
# @return [::String]
# ID of the parent project.
class ListWorkerPoolsRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Response containing existing `WorkerPools`.
# @!attribute [rw] worker_pools
# @return [::Array<::Google::Cloud::Build::V1::WorkerPool>]
# `WorkerPools` for the project.
class ListWorkerPoolsResponse
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
end
end
end
end