Types for Google Cloud Devtools Cloudbuild v1 API¶
- class google.cloud.devtools.cloudbuild_v1.types.ApprovalConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
ApprovalConfig describes configuration for manual approval of a build.
- approval_required¶
Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start.
- Type
bool
- class google.cloud.devtools.cloudbuild_v1.types.ApprovalResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
ApprovalResult describes the decision and associated metadata of a manual approval of a build.
- approver_account¶
Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called.
- Type
str
- approval_time¶
Output only. The time when the approval decision was made.
- Type
google.protobuf.timestamp_pb2.Timestamp
- decision¶
Required. The decision of this manual approval.
- comment¶
Optional. An optional comment for this manual approval result.
- Type
str
- url¶
Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build.
- Type
str
- class google.cloud.devtools.cloudbuild_v1.types.ApproveBuildRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Request to approve or reject a pending build.
- name¶
Required. Name of the target build. For example: “projects/{$project_id}/builds/{$build_id}”.
- Type
str
- approval_result¶
Approval decision and metadata.
- class google.cloud.devtools.cloudbuild_v1.types.ArtifactResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
An artifact that was uploaded during a build. This is a single record in the artifact manifest JSON file.
- location¶
The path of an artifact in a Google Cloud Storage bucket, with the generation number. For example,
gs://mybucket/path/to/output.jar#generation
.- Type
str
- file_hash¶
The file hash of the artifact.
- Type
Sequence[google.cloud.devtools.cloudbuild_v1.types.FileHashes]
- class google.cloud.devtools.cloudbuild_v1.types.Artifacts(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Artifacts produced by a build that should be uploaded upon successful completion of all build steps.
- images¶
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.
- Type
Sequence[str]
- objects¶
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 ArtifactObjects(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.
- location¶
Cloud Storage bucket and optional object path, in the form “gs://bucket/path/to/somewhere/”. (see Bucket Name Requirements).
Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix.
- Type
str
- paths¶
Path globs used to match files in the build’s workspace.
- Type
Sequence[str]
- timing¶
Output only. Stores timing information for pushing all artifact objects.
- class google.cloud.devtools.cloudbuild_v1.types.Build(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
A build resource in the Cloud Build API.
At a high level, a
Build
describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts.Fields can include the following variables, which will be expanded when the build is created:
$PROJECT_ID: the project ID of the build.
$PROJECT_NUMBER: the project number of the build.
$BUILD_ID: the autogenerated ID of the build.
$REPO_NAME: the source repository name specified by RepoSource.
$BRANCH_NAME: the branch name specified by RepoSource.
$TAG_NAME: the tag name specified by RepoSource.
$REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag.
$SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.
- name¶
Output only. The ‘Build’ name with format:
projects/{project}/locations/{location}/builds/{build}
, where {build} is a unique identifier generated by the service.- Type
str
- id¶
Output only. Unique identifier of the build.
- Type
str
- project_id¶
Output only. ID of the project.
- Type
str
- status¶
Output only. Status of the build.
- status_detail¶
Output only. Customer-readable message about the current status.
- Type
str
- source¶
The location of the source files to build.
- steps¶
Required. The operations to be performed on the workspace.
- Type
Sequence[google.cloud.devtools.cloudbuild_v1.types.BuildStep]
- results¶
Output only. Results of the build.
- create_time¶
Output only. Time at which the request to create the build was received.
- Type
google.protobuf.timestamp_pb2.Timestamp
- start_time¶
Output only. Time at which execution of the build was started.
- Type
google.protobuf.timestamp_pb2.Timestamp
- finish_time¶
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.
- Type
google.protobuf.timestamp_pb2.Timestamp
- timeout¶
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 fromstartTime
.Default time is ten minutes.
- Type
google.protobuf.duration_pb2.Duration
- images¶
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
.- Type
Sequence[str]
- queue_ttl¶
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.
- Type
google.protobuf.duration_pb2.Duration
- artifacts¶
Artifacts produced by the build that should be uploaded upon successful completion of all build steps.
- logs_bucket¶
Google Cloud Storage bucket where logs should be written (see Bucket Name Requirements). Logs file names will be of the format
${logs_bucket}/log-${build_id}.txt
.- Type
str
- source_provenance¶
Output only. A permanent fixed identifier for source.
- build_trigger_id¶
Output only. The ID of the
BuildTrigger
that triggered this build, if it was triggered automatically.- Type
str
- options¶
Special options for this build.
- log_url¶
Output only. URL to logs for this build in Google Cloud Console.
- Type
str
- substitutions¶
Substitutions data for
Build
resource.
- tags¶
Tags for annotation of a
Build
. These are not docker tags.- Type
Sequence[str]
- secrets¶
Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use
available_secrets
to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets- Type
- timing¶
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.
SETUPBUILD: time to set up build.
If the build does not specify source or images, these keys will not be included.
- Type
Sequence[google.cloud.devtools.cloudbuild_v1.types.Build.TimingEntry]
- approval¶
Output only. Describes this build’s approval configuration, status, and result.
- service_account¶
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.- Type
str
- available_secrets¶
Secrets and secret environment variables.
- warnings¶
Output only. Non-fatal problems encountered during the execution of the build.
- Type
Sequence[google.cloud.devtools.cloudbuild_v1.types.Build.Warning]
- failure_info¶
Output only. Contains information about the build when status=FAILURE.
- class FailureInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
A fatal problem encountered during the execution of the build.
- type_¶
The name of the failure.
- detail¶
Explains the failure issue in more detail using hard-coded text.
- Type
str
- class Status(value)[source]¶
Bases:
proto.enums.Enum
Possible status of a build or build step.
- CANCELLED = 7¶
- EXPIRED = 9¶
- FAILURE = 4¶
- INTERNAL_ERROR = 5¶
- PENDING = 10¶
- QUEUED = 1¶
- STATUS_UNKNOWN = 0¶
- SUCCESS = 3¶
- TIMEOUT = 6¶
- WORKING = 2¶
- class SubstitutionsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class TimingEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.devtools.cloudbuild_v1.types.BuildApproval(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
BuildApproval describes a build’s approval configuration, state, and result.
- state¶
Output only. The state of this build’s approval.
- config¶
Output only. Configuration for manual approval of this build.
- result¶
Output only. Result of manual approval for this Build.
- class google.cloud.devtools.cloudbuild_v1.types.BuildOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Metadata for build operations.
- build¶
The build that the operation is tracking.
- class google.cloud.devtools.cloudbuild_v1.types.BuildOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Optional arguments to enable specific features of builds.
- source_provenance_hash¶
Requested hash for SourceProvenance.
- Type
Sequence[google.cloud.devtools.cloudbuild_v1.types.Hash.HashType]
- requested_verify_option¶
Requested verifiability options.
- machine_type¶
Compute Engine machine type on which to run the build.
- disk_size_gb¶
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.
- Type
int
- substitution_option¶
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.
- dynamic_substitutions¶
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.
- Type
bool
- log_streaming_option¶
Option to define build log streaming behavior to Google Cloud Storage.
- worker_pool¶
This field deprecated; please use
pool.name
instead.- Type
str
- pool¶
Optional. Specification for execution on a
WorkerPool
.See running builds in a private pool for more information.
- logging¶
Option to specify the logging mode, which determines if and where build logs are stored.
- env¶
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”.
- Type
Sequence[str]
- secret_env¶
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.- Type
Sequence[str]
- volumes¶
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.
- Type
- class LogStreamingOption(value)[source]¶
Bases:
proto.enums.Enum
Specifies the behavior when writing build logs to Google Cloud Storage.
- STREAM_DEFAULT = 0¶
- STREAM_OFF = 2¶
- STREAM_ON = 1¶
- class LoggingMode(value)[source]¶
Bases:
proto.enums.Enum
Specifies the logging mode.
- CLOUD_LOGGING_ONLY = 5¶
- GCS_ONLY = 2¶
- LEGACY = 1¶
- LOGGING_UNSPECIFIED = 0¶
- NONE = 4¶
- STACKDRIVER_ONLY = 3¶
- class MachineType(value)[source]¶
Bases:
proto.enums.Enum
Supported Compute Engine machine types. For more information, see Machine types.
- E2_HIGHCPU_32 = 6¶
- E2_HIGHCPU_8 = 5¶
- N1_HIGHCPU_32 = 2¶
- N1_HIGHCPU_8 = 1¶
- UNSPECIFIED = 0¶
- class PoolOption(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Details about how a build should be executed on a
WorkerPool
.See running builds in a private pool for more information.
- name¶
The
WorkerPool
resource to execute the build on. You must havecloudbuild.workerpools.use
on the project hosting the WorkerPool.Format projects/{project}/locations/{location}/workerPools/{workerPoolId}
- Type
str
- class google.cloud.devtools.cloudbuild_v1.types.BuildStep(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
A step in the build pipeline.
- name¶
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). 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.
- Type
str
- env¶
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”.
- Type
Sequence[str]
- args¶
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.- Type
Sequence[str]
- dir_¶
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
withdir
and a step with adir
, which specifies an absolute path, theRepoSource
dir
is ignored for the step’s execution.- Type
str
- id¶
Unique identifier for this build step, used in
wait_for
to reference this build step as a dependency.- Type
str
- wait_for¶
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. Ifwait_for
is empty, this build step will start when all previous build steps in theBuild.Steps
list have completed successfully.- Type
Sequence[str]
- entrypoint¶
Entrypoint to be used instead of the build step image’s default entrypoint. If unset, the image’s default entrypoint is used.
- Type
str
- secret_env¶
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
.- Type
Sequence[str]
- volumes¶
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.
- Type
- timing¶
Output only. Stores timing information for executing this build step.
- pull_timing¶
Output only. Stores timing information for pulling this build step’s builder image only.
- timeout¶
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.
- Type
google.protobuf.duration_pb2.Duration
- 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.
- script¶
A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.
- Type
str
- class google.cloud.devtools.cloudbuild_v1.types.BuildTrigger(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Configuration for an automated build in response to source repository changes.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- resource_name¶
The
Trigger
name with format:projects/{project}/locations/{location}/triggers/{trigger}
, where {trigger} is a unique identifier generated by the service.- Type
str
- id¶
Output only. Unique identifier of the trigger.
- Type
str
- description¶
Human-readable description of this trigger.
- Type
str
- name¶
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.
- Type
str
- tags¶
Tags for annotation of a
BuildTrigger
- Type
Sequence[str]
- trigger_template¶
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
.
- github¶
GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received.
Mutually exclusive with
trigger_template
.
- pubsub_config¶
PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.
- webhook_config¶
WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger’s webhook URL.
- autodetect¶
Autodetect build configuration. The following precedence is used (case insensitive): 1. cloudbuild.yaml 2. cloudbuild.yml 3. cloudbuild.json 4. Dockerfile
Currently only available for GitHub App Triggers. This field is a member of oneof
build_template
.- Type
bool
- filename¶
Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). This field is a member of oneof
build_template
.- Type
str
- create_time¶
Output only. Time when the trigger was created.
- Type
google.protobuf.timestamp_pb2.Timestamp
- disabled¶
If true, the trigger will never automatically execute a build.
- Type
bool
- substitutions¶
Substitutions for Build resource. The keys must match the following regular expression:
^_[A-Z0-9_]+$
.
- ignored_files¶
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.
- Type
Sequence[str]
- included_files¶
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.
- Type
Sequence[str]
- filter¶
Optional. A Common Expression Language string.
- Type
str
- service_account¶
The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format:
projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}
- Type
str
- class SubstitutionsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.devtools.cloudbuild_v1.types.BuiltImage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
An image built by the pipeline.
- name¶
Name used to push the container image to Google Container Registry, as presented to
docker push
.- Type
str
- digest¶
Docker Registry 2.0 digest.
- Type
str
- push_timing¶
Output only. Stores timing information for pushing the specified image.
- class google.cloud.devtools.cloudbuild_v1.types.CancelBuildRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Request to cancel an ongoing build.
- name¶
The name of the
Build
to cancel. Format:projects/{project}/locations/{location}/builds/{build}
- Type
str
- project_id¶
Required. ID of the project.
- Type
str
- id¶
Required. ID of the build.
- Type
str
- class google.cloud.devtools.cloudbuild_v1.types.CreateBuildRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Request to create a new build.
- parent¶
The parent resource where this build will be created. Format:
projects/{project}/locations/{location}
- Type
str
- project_id¶
Required. ID of the project.
- Type
str
- build¶
Required. Build resource to create.
- class google.cloud.devtools.cloudbuild_v1.types.CreateBuildTriggerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Request to create a new
BuildTrigger
.- parent¶
The parent resource where this trigger will be created. Format:
projects/{project}/locations/{location}
- Type
str
- project_id¶
Required. ID of the project for which to configure automatic builds.
- Type
str
- trigger¶
Required.
BuildTrigger
to create.
- class google.cloud.devtools.cloudbuild_v1.types.CreateWorkerPoolOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Metadata for the
CreateWorkerPool
operation.- worker_pool¶
The resource name of the
WorkerPool
to create. Format:projects/{project}/locations/{location}/workerPools/{worker_pool}
.- Type
str
- create_time¶
Time the operation was created.
- Type
google.protobuf.timestamp_pb2.Timestamp
- complete_time¶
Time the operation was completed.
- Type
google.protobuf.timestamp_pb2.Timestamp
- class google.cloud.devtools.cloudbuild_v1.types.CreateWorkerPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Request to create a new
WorkerPool
.- parent¶
Required. The parent resource where this worker pool will be created. Format:
projects/{project}/locations/{location}
.- Type
str
- worker_pool¶
Required.
WorkerPool
resource to create.
- worker_pool_id¶
Required. Immutable. The ID to use for the
WorkerPool
, which will become the final component of the resource name.This value should be 1-63 characters, and valid characters are /[a-z][0-9]-/.
- Type
str
- validate_only¶
If set, validate the request and preview the response, but do not actually post it.
- Type
bool
- class google.cloud.devtools.cloudbuild_v1.types.DeleteBuildTriggerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Request to delete a
BuildTrigger
.- name¶
The name of the
Trigger
to delete. Format:projects/{project}/locations/{location}/triggers/{trigger}
- Type
str
- project_id¶
Required. ID of the project that owns the trigger.
- Type
str
- trigger_id¶
Required. ID of the
BuildTrigger
to delete.- Type
str
- class google.cloud.devtools.cloudbuild_v1.types.DeleteWorkerPoolOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Metadata for the
DeleteWorkerPool
operation.- worker_pool¶
The resource name of the
WorkerPool
being deleted. Format:projects/{project}/locations/{location}/workerPools/{worker_pool}
.- Type
str
- create_time¶
Time the operation was created.
- Type
google.protobuf.timestamp_pb2.Timestamp
- complete_time¶
Time the operation was completed.
- Type
google.protobuf.timestamp_pb2.Timestamp
- class google.cloud.devtools.cloudbuild_v1.types.DeleteWorkerPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Request to delete a
WorkerPool
.- name¶
Required. The name of the
WorkerPool
to delete. Format:projects/{project}/locations/{workerPool}/workerPools/{workerPool}
.- Type
str
- etag¶
Optional. If this is provided, it must match the server’s etag on the workerpool for the request to be processed.
- Type
str
- allow_missing¶
If set to true, and the
WorkerPool
is not found, the request will succeed but no action will be taken on the server.- Type
bool
- validate_only¶
If set, validate the request and preview the response, but do not actually post it.
- Type
bool
- class google.cloud.devtools.cloudbuild_v1.types.FileHashes(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.
- file_hash¶
Collection of file hashes.
- Type
- class google.cloud.devtools.cloudbuild_v1.types.GetBuildRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Request to get a build.
- name¶
The name of the
Build
to retrieve. Format:projects/{project}/locations/{location}/builds/{build}
- Type
str
- project_id¶
Required. ID of the project.
- Type
str
- id¶
Required. ID of the build.
- Type
str
- class google.cloud.devtools.cloudbuild_v1.types.GetBuildTriggerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Returns the
BuildTrigger
with the specified ID.- name¶
The name of the
Trigger
to retrieve. Format:projects/{project}/locations/{location}/triggers/{trigger}
- Type
str
- project_id¶
Required. ID of the project that owns the trigger.
- Type
str
- trigger_id¶
Required. Identifier (
id
orname
) of theBuildTrigger
to get.- Type
str
- class google.cloud.devtools.cloudbuild_v1.types.GetWorkerPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Request to get a
WorkerPool
with the specified name.- name¶
Required. The name of the
WorkerPool
to retrieve. Format:projects/{project}/locations/{location}/workerPools/{workerPool}
.- Type
str
- class google.cloud.devtools.cloudbuild_v1.types.GitHubEventsConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. This message is experimental.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- installation_id¶
The installationID that emits the GitHub event.
- Type
int
- owner¶
Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud- builders is “googlecloudplatform”.
- Type
str
- name¶
Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud- builders is “cloud-builders”.
- Type
str
- class google.cloud.devtools.cloudbuild_v1.types.Hash(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Container message for hash values.
- type_¶
The type of hash that was performed.
- value¶
The hash value.
- Type
bytes
- class google.cloud.devtools.cloudbuild_v1.types.InlineSecret(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.
- kms_key_name¶
Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects//locations//keyRings//cryptoKeys/
- Type
str
- env_map¶
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 EnvMapEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.devtools.cloudbuild_v1.types.ListBuildTriggersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Request to list existing
BuildTriggers
.- parent¶
The parent of the collection of
Triggers
. Format:projects/{project}/locations/{location}
- Type
str
- project_id¶
Required. ID of the project for which to list BuildTriggers.
- Type
str
- page_size¶
Number of results to return in the list.
- Type
int
- page_token¶
Token to provide to skip to a particular spot in the list.
- Type
str
- class google.cloud.devtools.cloudbuild_v1.types.ListBuildTriggersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Response containing existing
BuildTriggers
.- triggers¶
BuildTriggers
for the project, sorted bycreate_time
descending.- Type
Sequence[google.cloud.devtools.cloudbuild_v1.types.BuildTrigger]
- next_page_token¶
Token to receive the next page of results.
- Type
str
- property raw_page¶
- class google.cloud.devtools.cloudbuild_v1.types.ListBuildsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Request to list builds.
- parent¶
The parent of the collection of
Builds
. Format:projects/{project}/locations/location
- Type
str
- project_id¶
Required. ID of the project.
- Type
str
- page_size¶
Number of results to return in the list.
- Type
int
- page_token¶
The page token for the next page of Builds.
If unspecified, the first page of results is returned.
If the token is rejected for any reason, INVALID_ARGUMENT will be thrown. In this case, the token should be discarded, and pagination should be restarted from the first page of results.
See https://google.aip.dev/158 for more.
- Type
str
- filter¶
The raw filter text to constrain the results.
- Type
str
- class google.cloud.devtools.cloudbuild_v1.types.ListBuildsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Response including listed builds.
- builds¶
Builds will be sorted by
create_time
, descending.- Type
- next_page_token¶
Token to receive the next page of results. This will be absent if the end of the response list has been reached.
- Type
str
- property raw_page¶
- class google.cloud.devtools.cloudbuild_v1.types.ListWorkerPoolsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Request to list
WorkerPool
s.- parent¶
Required. The parent of the collection of
WorkerPools
. Format:projects/{project}/locations/{location}
.- Type
str
- page_size¶
The maximum number of
WorkerPool
s to return. The service may return fewer than this value. If omitted, the server will use a sensible default.- Type
int
- page_token¶
A page token, received from a previous
ListWorkerPools
call. Provide this to retrieve the subsequent page.- Type
str
- class google.cloud.devtools.cloudbuild_v1.types.ListWorkerPoolsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Response containing existing
WorkerPools
.- worker_pools¶
WorkerPools
for the specified project.- Type
Sequence[google.cloud.devtools.cloudbuild_v1.types.WorkerPool]
- next_page_token¶
Continuation token used to page through large result sets. Provide this value in a subsequent ListWorkerPoolsRequest to return the next page of results.
- Type
str
- property raw_page¶
- class google.cloud.devtools.cloudbuild_v1.types.PrivatePoolV1Config(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Configuration for a V1
PrivatePool
.- worker_config¶
Machine configuration for the workers in the pool.
- network_config¶
Network configuration for the pool.
- class NetworkConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Defines the network configuration for the pool.
- peered_network¶
Required. Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to
WorkerPool.project_id
on the service producer network. Must be in the formatprojects/{project}/global/networks/{network}
, where{project}
is a project number, such as12345
, and{network}
is the name of a VPC network in the project. See Understanding network configuration options- Type
str
- egress_option¶
Option to configure network egress for the workers.
- class WorkerConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Defines the configuration to be used for creating workers in the pool.
- machine_type¶
Machine type of a worker, such as
e2-medium
. See Worker pool config file. If left blank, Cloud Build will use a sensible default.- Type
str
- disk_size_gb¶
Size of the disk attached to the worker, in GB. See Worker pool config file. Specify a value of up to 1000. If
0
is specified, Cloud Build will use a standard disk size.- Type
int
- class google.cloud.devtools.cloudbuild_v1.types.PubsubConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.
- subscription¶
Output only. Name of the subscription. Format is
projects/{project}/subscriptions/{subscription}
.- Type
str
- topic¶
The name of the topic from which this subscription is receiving messages. Format is
projects/{project}/topics/{topic}
.- Type
str
- service_account_email¶
Service account that will make the push request.
- Type
str
- state¶
Potential issues with the underlying Pub/Sub subscription configuration. Only populated on get requests.
- class google.cloud.devtools.cloudbuild_v1.types.PullRequestFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
PullRequestFilter contains filter properties for matching GitHub Pull Requests.
- branch¶
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 This field is a member of oneof
git_ref
.- Type
str
- comment_control¶
Configure builds to run whether a repository owner or collaborator need to comment
/gcbrun
.
- invert_regex¶
If true, branches that do NOT match the git_ref will trigger a build.
- Type
bool
- class google.cloud.devtools.cloudbuild_v1.types.PushFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Push contains filter properties for matching GitHub git pushes.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- branch¶
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 This field is a member of oneof
git_ref
.- Type
str
- tag¶
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 This field is a member of oneof
git_ref
.- Type
str
- invert_regex¶
When true, only trigger a build if the revision regex does NOT match the git_ref regex.
- Type
bool
- class google.cloud.devtools.cloudbuild_v1.types.ReceiveTriggerWebhookRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
ReceiveTriggerWebhookRequest [Experimental] is the request object accepted by the ReceiveTriggerWebhook method.
- name¶
The name of the
ReceiveTriggerWebhook
to retrieve. Format:projects/{project}/locations/{location}/triggers/{trigger}
- Type
str
- body¶
HTTP request body.
- Type
google.api.httpbody_pb2.HttpBody
- project_id¶
Project in which the specified trigger lives
- Type
str
- trigger¶
Name of the trigger to run the payload against
- Type
str
- secret¶
Secret token used for authorization if an OAuth token isn’t provided.
- Type
str
- class google.cloud.devtools.cloudbuild_v1.types.ReceiveTriggerWebhookResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
ReceiveTriggerWebhookResponse [Experimental] is the response object for the ReceiveTriggerWebhook method.
- class google.cloud.devtools.cloudbuild_v1.types.RepoSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Location of the source in a Google Cloud Source Repository.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- project_id¶
ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
- Type
str
- repo_name¶
Name of the Cloud Source Repository.
- Type
str
- branch_name¶
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 This field is a member of oneof
revision
.- Type
str
- tag_name¶
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 This field is a member of oneof
revision
.- Type
str
- dir_¶
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.- Type
str
- invert_regex¶
Only trigger a build if the revision regex does NOT match the revision regex.
- Type
bool
- substitutions¶
Substitutions to use in a triggered build. Should only be used with RunBuildTrigger
- class SubstitutionsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.devtools.cloudbuild_v1.types.Results(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Artifacts created by the build pipeline.
- images¶
Container images that were built as a part of the build.
- Type
Sequence[google.cloud.devtools.cloudbuild_v1.types.BuiltImage]
- build_step_images¶
List of build step digests, in the order corresponding to build step indices.
- Type
Sequence[str]
- artifact_manifest¶
Path to the artifact manifest. Only populated when artifacts are uploaded.
- Type
str
- num_artifacts¶
Number of artifacts uploaded. Only populated when artifacts are uploaded.
- Type
int
- build_step_outputs¶
List of build step outputs, produced by builder images, in the order corresponding to build step indices.
Cloud Builders can produce this output by writing to
$BUILDER_OUTPUT/output
. Only the first 4KB of data is stored.- Type
Sequence[bytes]
- artifact_timing¶
Time to push all non-container artifacts.
- class google.cloud.devtools.cloudbuild_v1.types.RetryBuildRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Specifies a build to retry.
- name¶
The name of the
Build
to retry. Format:projects/{project}/locations/{location}/builds/{build}
- Type
str
- project_id¶
Required. ID of the project.
- Type
str
- id¶
Required. Build ID of the original build.
- Type
str
- class google.cloud.devtools.cloudbuild_v1.types.RunBuildTriggerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Specifies a build trigger to run and the source to use.
- name¶
The name of the
Trigger
to run. Format:projects/{project}/locations/{location}/triggers/{trigger}
- Type
str
- project_id¶
Required. ID of the project.
- Type
str
- trigger_id¶
Required. ID of the trigger.
- Type
str
- source¶
Source to build against this trigger.
- class google.cloud.devtools.cloudbuild_v1.types.Secret(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. Note: Use
kmsKeyName
withavailable_secrets
instead of usingkmsKeyName
withsecret
. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.- kms_key_name¶
Cloud KMS key name to use to decrypt these envs.
- Type
str
- secret_env¶
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 SecretEnvEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.devtools.cloudbuild_v1.types.SecretManagerSecret(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Pairs a secret environment variable with a SecretVersion in Secret Manager.
- version_name¶
Resource name of the SecretVersion. In format: projects//secrets//versions/*
- Type
str
- env¶
Environment variable name to associate with the secret. Secret environment variables must be unique across all of a build’s secrets, and must be used by at least one build step.
- Type
str
- class google.cloud.devtools.cloudbuild_v1.types.Secrets(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Secrets and secret environment variables.
- secret_manager¶
Secrets in Secret Manager and associated secret environment variable.
- inline¶
Secrets encrypted with KMS key and the associated secret environment variable.
- Type
Sequence[google.cloud.devtools.cloudbuild_v1.types.InlineSecret]
- class google.cloud.devtools.cloudbuild_v1.types.Source(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Location of the source in a supported storage service.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- storage_source¶
If provided, get the source from this location in Google Cloud Storage. This field is a member of oneof
source
.
- repo_source¶
If provided, get the source from this location in a Cloud Source Repository. This field is a member of oneof
source
.
- class google.cloud.devtools.cloudbuild_v1.types.SourceProvenance(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Provenance of the source. Ways to find the original source, or verify that some source was used for this build.
- resolved_storage_source¶
A copy of the build’s
source.storage_source
, if exists, with any generations resolved.
- resolved_repo_source¶
A copy of the build’s
source.repo_source
, if exists, with any revisions resolved.
- resolved_storage_source_manifest¶
A copy of the build’s
source.storage_source_manifest
, if exists, with any revisions resolved. This feature is in Preview.
- file_hashes¶
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 ifBuildOptions
has requested aSourceProvenanceHash
.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
), theFileHash
will be for the single path to that file.
- class FileHashesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.devtools.cloudbuild_v1.types.StorageSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Location of the source in an archive file in Google Cloud Storage.
- bucket¶
Google Cloud Storage bucket containing the source (see Bucket Name Requirements).
- Type
str
- object_¶
Google Cloud Storage object containing the source.
This object must be a gzipped archive file (
.tar.gz
) containing source to build.- Type
str
- generation¶
Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
- Type
int
- class google.cloud.devtools.cloudbuild_v1.types.StorageSourceManifest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Location of the source manifest in Google Cloud Storage. This feature is in Preview; see description here.
- bucket¶
Google Cloud Storage bucket containing the source manifest (see Bucket Name Requirements).
- Type
str
- object_¶
Google Cloud Storage object containing the source manifest. This object must be a JSON file.
- Type
str
- generation¶
Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
- Type
int
- class google.cloud.devtools.cloudbuild_v1.types.TimeSpan(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Start and end times for a build execution phase.
- start_time¶
Start of time span.
- Type
google.protobuf.timestamp_pb2.Timestamp
- end_time¶
End of time span.
- Type
google.protobuf.timestamp_pb2.Timestamp
- class google.cloud.devtools.cloudbuild_v1.types.UpdateBuildTriggerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Request to update an existing
BuildTrigger
.- project_id¶
Required. ID of the project that owns the trigger.
- Type
str
- trigger_id¶
Required. ID of the
BuildTrigger
to update.- Type
str
- trigger¶
Required.
BuildTrigger
to update.
- class google.cloud.devtools.cloudbuild_v1.types.UpdateWorkerPoolOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Metadata for the
UpdateWorkerPool
operation.- worker_pool¶
The resource name of the
WorkerPool
being updated. Format:projects/{project}/locations/{location}/workerPools/{worker_pool}
.- Type
str
- create_time¶
Time the operation was created.
- Type
google.protobuf.timestamp_pb2.Timestamp
- complete_time¶
Time the operation was completed.
- Type
google.protobuf.timestamp_pb2.Timestamp
- class google.cloud.devtools.cloudbuild_v1.types.UpdateWorkerPoolRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Request to update a
WorkerPool
.- worker_pool¶
Required. The
WorkerPool
to update.The
name
field is used to identify theWorkerPool
to update. Format:projects/{project}/locations/{location}/workerPools/{workerPool}
.
- update_mask¶
A mask specifying which fields in
worker_pool
to update.- Type
google.protobuf.field_mask_pb2.FieldMask
- validate_only¶
If set, validate the request and preview the response, but do not actually post it.
- Type
bool
- class google.cloud.devtools.cloudbuild_v1.types.Volume(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.
- name¶
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.
- Type
str
- path¶
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.
- Type
str
- class google.cloud.devtools.cloudbuild_v1.types.WebhookConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger’s webhook URL.
- secret¶
Required. Resource name for the secret required as a URL parameter. This field is a member of oneof
auth_method
.- Type
str
- state¶
Potential issues with the underlying Pub/Sub subscription configuration. Only populated on get requests.
- class google.cloud.devtools.cloudbuild_v1.types.WorkerPool(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Configuration for a
WorkerPool
.Cloud Build owns and maintains a pool of workers for general use and have no access to a project’s private network. By default, builds submitted to Cloud Build will use a worker from this pool.
If your build needs access to resources on a private network, create and use a
WorkerPool
to run your builds. PrivateWorkerPool
s give your builds access to any single VPC network that you administer, including any on-prem resources connected to that VPC network. For an overview of private pools, see Private pools overview.- name¶
Output only. The resource name of the
WorkerPool
, with formatprojects/{project}/locations/{location}/workerPools/{worker_pool}
. The value of{worker_pool}
is provided byworker_pool_id
inCreateWorkerPool
request and the value of{location}
is determined by the endpoint accessed.- Type
str
- display_name¶
A user-specified, human-readable name for the
WorkerPool
. If provided, this value must be 1-63 characters.- Type
str
- uid¶
Output only. A unique identifier for the
WorkerPool
.- Type
str
- annotations¶
User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
- create_time¶
Output only. Time at which the request to create the
WorkerPool
was received.- Type
google.protobuf.timestamp_pb2.Timestamp
- update_time¶
Output only. Time at which the request to update the
WorkerPool
was received.- Type
google.protobuf.timestamp_pb2.Timestamp
- delete_time¶
Output only. Time at which the request to delete the
WorkerPool
was received.- Type
google.protobuf.timestamp_pb2.Timestamp
- state¶
Output only.
WorkerPool
state.
- private_pool_v1_config¶
Private Pool using a v1 configuration. This field is a member of oneof
config
.
- etag¶
Output only. Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding.
- Type
str
- class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message