Package Classes (3.25.0)

Creates and manages builds on Google Cloud Platform.

The main concept used by this API is a Build, which describes the location of the source to build, how to build the source, and where to store the built artifacts, if any.

A user can list previously-requested builds or get builds by their ID to determine the status of the build.

Creates and manages builds on Google Cloud Platform.

The main concept used by this API is a Build, which describes the location of the source to build, how to build the source, and where to store the built artifacts, if any.

A user can list previously-requested builds or get builds by their ID to determine the status of the build.

A pager for iterating through list_build_triggers requests.

This class thinly wraps an initial ListBuildTriggersResponse object, and provides an __aiter__ method to iterate through its triggers field.

If there are more pages, the __aiter__ method will make additional ListBuildTriggers requests and continue to iterate through the triggers field on the corresponding responses.

All the usual ListBuildTriggersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_build_triggers requests.

This class thinly wraps an initial ListBuildTriggersResponse object, and provides an __iter__ method to iterate through its triggers field.

If there are more pages, the __iter__ method will make additional ListBuildTriggers requests and continue to iterate through the triggers field on the corresponding responses.

All the usual ListBuildTriggersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_builds requests.

This class thinly wraps an initial ListBuildsResponse object, and provides an __aiter__ method to iterate through its builds field.

If there are more pages, the __aiter__ method will make additional ListBuilds requests and continue to iterate through the builds field on the corresponding responses.

All the usual ListBuildsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_builds requests.

This class thinly wraps an initial ListBuildsResponse object, and provides an __iter__ method to iterate through its builds field.

If there are more pages, the __iter__ method will make additional ListBuilds requests and continue to iterate through the builds field on the corresponding responses.

All the usual ListBuildsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_worker_pools requests.

This class thinly wraps an initial ListWorkerPoolsResponse object, and provides an __aiter__ method to iterate through its worker_pools field.

If there are more pages, the __aiter__ method will make additional ListWorkerPools requests and continue to iterate through the worker_pools field on the corresponding responses.

All the usual ListWorkerPoolsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_worker_pools requests.

This class thinly wraps an initial ListWorkerPoolsResponse object, and provides an __iter__ method to iterate through its worker_pools field.

If there are more pages, the __iter__ method will make additional ListWorkerPools requests and continue to iterate through the worker_pools field on the corresponding responses.

All the usual ListWorkerPoolsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ApprovalConfig describes configuration for manual approval of a build.

ApprovalResult describes the decision and associated metadata of a manual approval of a build.

Specifies whether or not this manual approval result is to approve or reject a build.

Request to approve or reject a pending build.

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

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

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

A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.

Npm package to upload to Artifact Registry upon successful completion of all build steps.

Python package to upload to Artifact Registry upon successful completion of all build steps. A package can encapsulate multiple objects to be uploaded to a single repository.

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.
• $LOCATION: the location/region 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.

A fatal problem encountered during the execution of the build.

The name of a fatal problem encountered during the execution of the build.

Possible status of a build or build step.

The abstract base class for a message.

The abstract base class for a message.

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

The relative importance of this warning.

BuildApproval describes a build's approval configuration, state, and result.

Specifies the current state of a build's approval.

Metadata for build operations.

Optional arguments to enable specific features of builds.

Default Cloud Storage log bucket behavior options.

Specifies the behavior when writing build logs to Cloud Storage.

Specifies the logging mode.

Supported Compute Engine machine types. For more information, see Machine types <https://cloud.google.com/compute/docs/machine-types>__.

Details about how a build should be executed on a WorkerPool.

See running builds in a private pool <https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool>__ for more information.

Specifies the behavior when there is an error in the substitution checks.

Specifies the manner in which the build should be verified, if at all.

If a verified build is requested, and any part of the process to generate and upload provenance fails, the build will also fail.

If the build does not request verification then that process may occur, but is not guaranteed to. If it does occur and fails, the build will not fail.

For more information, see Viewing Build Provenance <https://cloud.google.com/build/docs/securing-builds/view-build-provenance>__.

A step in the build pipeline.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The abstract base class for a message.

An image built by the pipeline.

Request to cancel an ongoing build.

Request to create a new build.

Request to create a new BuildTrigger.

Metadata for the CreateWorkerPool operation.

Request to create a new WorkerPool.

Request to delete a BuildTrigger.

Metadata for the DeleteWorkerPool operation.

Request to delete a WorkerPool.

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

Request to get a build.

Returns the BuildTrigger with the specified ID.

Request to get a WorkerPool with the specified name.

GitFileSource describes a file within a (possibly remote) code repository.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The type of the repo, since it may not be explicit from the repo field (e.g from a URL).

GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects/

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

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GitRepoSource describes a repo and ref of a code repository.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Location of the source in any accessible Git repository.

Container message for hash values.

Specifies the hash algorithm, if any.

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

The abstract base class for a message.

Request to list existing BuildTriggers.

Response containing existing BuildTriggers.

Request to list builds.

Response including listed builds.

Request to list WorkerPool\ s.

Response containing existing WorkerPools.

Configuration for a V1 PrivatePool.

Defines the network configuration for the pool.

Defines the egress option for the pool.

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

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

Enumerates potential issues with the underlying Pub/Sub subscription configuration.

PullRequestFilter contains filter properties for matching GitHub Pull Requests.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Controls behavior of Pull Request comments.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ReceiveTriggerWebhookRequest [Experimental] is the request object accepted by the ReceiveTriggerWebhook method.

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

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The abstract base class for a message.

The configuration of a trigger that creates a build whenever an event from Repo API is received.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

All possible SCM repo types from Repo API.

Artifacts created by the build pipeline.

Specifies a build to retry.

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

Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. Note: Use kmsKeyName with available_secrets instead of using kmsKeyName with secret. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.

The abstract base class for a message.

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

Secrets and secret environment variables.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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

The abstract base class for a message.

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

Specifies the tool to fetch the source file for the build.

Location of the source manifest in Cloud Storage. This feature is in Preview; see description here <https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher>__.

Start and end times for a build execution phase.

Request to update an existing BuildTrigger.

Metadata for the UpdateWorkerPool operation.

Request to update a WorkerPool.

A Maven artifact uploaded using the MavenArtifact directive.

An npm package uploaded to Artifact Registry using the NpmPackage directive.

Artifact uploaded using the PythonPackage directive.

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

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Enumerates potential issues with the Secret Manager secret provided by the user.

Configuration for a WorkerPool.

Cloud Build owns and maintains a pool of workers for general use and have no access to a project's private network. By default, builds submitted to Cloud Build will use a worker from this pool.

If your build needs access to resources on a private network, create and use a WorkerPool to run your builds. Private WorkerPool\ 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 <https://cloud.google.com/build/docs/private-pools/private-pools-overview>__.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The abstract base class for a message.

State of the WorkerPool.

Manages connections to source code repositories.

Manages connections to source code repositories.

A pager for iterating through fetch_linkable_repositories requests.

This class thinly wraps an initial FetchLinkableRepositoriesResponse object, and provides an __aiter__ method to iterate through its repositories field.

If there are more pages, the __aiter__ method will make additional FetchLinkableRepositories requests and continue to iterate through the repositories field on the corresponding responses.

All the usual FetchLinkableRepositoriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through fetch_linkable_repositories requests.

This class thinly wraps an initial FetchLinkableRepositoriesResponse object, and provides an __iter__ method to iterate through its repositories field.

If there are more pages, the __iter__ method will make additional FetchLinkableRepositories requests and continue to iterate through the repositories field on the corresponding responses.

All the usual FetchLinkableRepositoriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_connections requests.

This class thinly wraps an initial ListConnectionsResponse object, and provides an __aiter__ method to iterate through its connections field.

If there are more pages, the __aiter__ method will make additional ListConnections requests and continue to iterate through the connections field on the corresponding responses.

All the usual ListConnectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_connections requests.

This class thinly wraps an initial ListConnectionsResponse object, and provides an __iter__ method to iterate through its connections field.

If there are more pages, the __iter__ method will make additional ListConnections requests and continue to iterate through the connections field on the corresponding responses.

All the usual ListConnectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_repositories requests.

This class thinly wraps an initial ListRepositoriesResponse object, and provides an __aiter__ method to iterate through its repositories field.

If there are more pages, the __aiter__ method will make additional ListRepositories requests and continue to iterate through the repositories field on the corresponding responses.

All the usual ListRepositoriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_repositories requests.

This class thinly wraps an initial ListRepositoriesResponse object, and provides an __iter__ method to iterate through its repositories field.

If there are more pages, the __iter__ method will make additional ListRepositories requests and continue to iterate through the repositories field on the corresponding responses.

All the usual ListRepositoriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Message for creating repositoritories in batch.

Message for response of creating repositories in batch.

Configuration for connections to Bitbucket Cloud.

Configuration for connections to Bitbucket Data Center.

A connection to a SCM like GitHub, GitHub Enterprise, Bitbucket Data Center, Bitbucket Cloud or GitLab.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The abstract base class for a message.

Message for creating a Connection

Message for creating a Repository.

Message for deleting a Connection.

Message for deleting a Repository.

Request for fetching git refs

Type of refs

Response for fetching git refs

Request message for FetchLinkableRepositories.

Response message for FetchLinkableRepositories.

Message for fetching SCM read token.

Message for responding to get read token.

Message for fetching SCM read/write token.

Message for responding to get read/write token.

Message for getting the details of a Connection.

Message for getting the details of a Repository.

Configuration for connections to github.com.

Configuration for connections to an instance of GitHub Enterprise.

Configuration for connections to gitlab.com or an instance of GitLab Enterprise.

Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections.

Stage of the installation process.

Message for requesting list of Connections.

Message for response to listing Connections.

Message for requesting list of Repositories.

Message for response to listing Repositories.

Represents an OAuth token of the account that authorized the Connection, and associated metadata.

Represents the metadata of the long-running operation.

RPC request object accepted by the ProcessWebhook RPC method.

A repository associated to a parent connection.

The abstract base class for a message.

Represents the custom metadata of the RunWorkflow long-running operation.

ServiceDirectoryConfig represents Service Directory configuration for a connection.

Message for updating a Connection.

Represents a personal access token that authorized the Connection, and associated metadata.

API documentation for devtools.cloudbuild_v1.services.cloud_build.pagers module.

API documentation for devtools.cloudbuild_v2.services.repository_manager.pagers module.