Summary of entries of Classes for cloudbuild.
Classes
CloudBuildAsyncClient
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.
CloudBuildClient
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.
ListBuildTriggersAsyncPager
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.
ListBuildTriggersPager
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.
ListBuildsAsyncPager
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.
ListBuildsPager
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.
ListWorkerPoolsAsyncPager
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.
ListWorkerPoolsPager
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
ApprovalConfig describes configuration for manual approval of a build.
ApprovalResult
ApprovalResult describes the decision and associated metadata of a manual approval of a build.
Decision
Specifies whether or not this manual approval result is to approve or reject a build.
ApproveBuildRequest
Request to approve or reject a pending build.
ArtifactResult
An artifact that was uploaded during a build. This is a single record in the artifact manifest JSON file.
Artifacts
Artifacts produced by a build that should be uploaded upon successful completion of all build steps.
ArtifactObjects
Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.
MavenArtifact
A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.
NpmPackage
Npm package to upload to Artifact Registry upon successful completion of all build steps.
PythonPackage
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.
Build
A build resource in the Cloud Build API.
At a high level, a Build
describes where to find source code,
how to build it (for example, the builder image to run on the
source), and where to store the built artifacts.
Fields can include the following variables, which will be expanded when the build is created:
- $PROJECT_ID: the project ID of the build.
- $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.
FailureInfo
A fatal problem encountered during the execution of the build.
FailureType
The name of a fatal problem encountered during the execution of the build.
Status
Possible status of a build or build step.
SubstitutionsEntry
The abstract base class for a message.
TimingEntry
The abstract base class for a message.
Warning
A non-fatal problem encountered during the execution of the build.
Priority
The relative importance of this warning.
BuildApproval
BuildApproval describes a build's approval configuration, state, and result.
State
Specifies the current state of a build's approval.
BuildOperationMetadata
Metadata for build operations.
BuildOptions
Optional arguments to enable specific features of builds.
DefaultLogsBucketBehavior
Default Cloud Storage log bucket behavior options.
LogStreamingOption
Specifies the behavior when writing build logs to Cloud Storage.
LoggingMode
Specifies the logging mode.
MachineType
Supported Compute Engine machine types. For more information, see
Machine
types <https://cloud.google.com/compute/docs/machine-types>
__.
PoolOption
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.
SubstitutionOption
Specifies the behavior when there is an error in the substitution checks.
VerifyOption
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>
__.
BuildStep
A step in the build pipeline.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BuildTrigger
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
SubstitutionsEntry
The abstract base class for a message.
BuiltImage
An image built by the pipeline.
CancelBuildRequest
Request to cancel an ongoing build.
CreateBuildRequest
Request to create a new build.
CreateBuildTriggerRequest
Request to create a new BuildTrigger
.
CreateWorkerPoolOperationMetadata
Metadata for the CreateWorkerPool
operation.
CreateWorkerPoolRequest
Request to create a new WorkerPool
.
DeleteBuildTriggerRequest
Request to delete a BuildTrigger
.
DeleteWorkerPoolOperationMetadata
Metadata for the DeleteWorkerPool
operation.
DeleteWorkerPoolRequest
Request to delete a WorkerPool
.
FileHashes
Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.
GetBuildRequest
Request to get a build.
GetBuildTriggerRequest
Returns the BuildTrigger
with the specified ID.
GetWorkerPoolRequest
Request to get a WorkerPool
with the specified name.
GitFileSource
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
RepoType
The type of the repo, since it may not be explicit from the repo
field (e.g from a URL).
GitHubEnterpriseConfig
GitHubEnterpriseSecrets
GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects/
GitHubEventsConfig
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
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
GitSource
Location of the source in any accessible Git repository.
Hash
Container message for hash values.
HashType
Specifies the hash algorithm, if any.
InlineSecret
Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.
EnvMapEntry
The abstract base class for a message.
ListBuildTriggersRequest
Request to list existing BuildTriggers
.
ListBuildTriggersResponse
Response containing existing BuildTriggers
.
ListBuildsRequest
Request to list builds.
ListBuildsResponse
Response including listed builds.
ListWorkerPoolsRequest
Request to list WorkerPool
\ s.
ListWorkerPoolsResponse
Response containing existing WorkerPools
.
PrivatePoolV1Config
Configuration for a V1 PrivatePool
.
NetworkConfig
Defines the network configuration for the pool.
EgressOption
Defines the egress option for the pool.
WorkerConfig
Defines the configuration to be used for creating workers in the pool.
PubsubConfig
PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published.
State
Enumerates potential issues with the underlying Pub/Sub subscription configuration.
PullRequestFilter
PullRequestFilter contains filter properties for matching GitHub Pull Requests.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CommentControl
Controls behavior of Pull Request comments.
PushFilter
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
ReceiveTriggerWebhookRequest [Experimental] is the request object accepted by the ReceiveTriggerWebhook method.
ReceiveTriggerWebhookResponse
ReceiveTriggerWebhookResponse [Experimental] is the response object for the ReceiveTriggerWebhook method.
RepoSource
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
SubstitutionsEntry
The abstract base class for a message.
RepositoryEventConfig
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
RepositoryType
All possible SCM repo types from Repo API.
Results
Artifacts created by the build pipeline.
RetryBuildRequest
Specifies a build to retry.
RunBuildTriggerRequest
Specifies a build trigger to run and the source to use.
Secret
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.
SecretEnvEntry
The abstract base class for a message.
SecretManagerSecret
Pairs a secret environment variable with a SecretVersion in Secret Manager.
Secrets
Secrets and secret environment variables.
Source
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
SourceProvenance
Provenance of the source. Ways to find the original source, or verify that some source was used for this build.
FileHashesEntry
The abstract base class for a message.
StorageSource
Location of the source in an archive file in Cloud Storage.
SourceFetcher
Specifies the tool to fetch the source file for the build.
StorageSourceManifest
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>
__.
TimeSpan
Start and end times for a build execution phase.
UpdateBuildTriggerRequest
Request to update an existing BuildTrigger
.
UpdateWorkerPoolOperationMetadata
Metadata for the UpdateWorkerPool
operation.
UpdateWorkerPoolRequest
Request to update a WorkerPool
.
UploadedMavenArtifact
A Maven artifact uploaded using the MavenArtifact directive.
UploadedNpmPackage
An npm package uploaded to Artifact Registry using the NpmPackage directive.
UploadedPythonPackage
Artifact uploaded using the PythonPackage directive.
Volume
Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.
WebhookConfig
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
State
Enumerates potential issues with the Secret Manager secret provided by the user.
WorkerPool
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
AnnotationsEntry
The abstract base class for a message.
State
State of the WorkerPool
.
RepositoryManagerAsyncClient
Manages connections to source code repositories.
RepositoryManagerClient
Manages connections to source code repositories.
FetchLinkableRepositoriesAsyncPager
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.
FetchLinkableRepositoriesPager
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.
ListConnectionsAsyncPager
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.
ListConnectionsPager
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.
ListRepositoriesAsyncPager
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.
ListRepositoriesPager
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.
BatchCreateRepositoriesRequest
Message for creating repositoritories in batch.
BatchCreateRepositoriesResponse
Message for response of creating repositories in batch.
BitbucketCloudConfig
Configuration for connections to Bitbucket Cloud.
BitbucketDataCenterConfig
Configuration for connections to Bitbucket Data Center.
Connection
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
AnnotationsEntry
The abstract base class for a message.
CreateConnectionRequest
Message for creating a Connection
CreateRepositoryRequest
Message for creating a Repository.
DeleteConnectionRequest
Message for deleting a Connection.
DeleteRepositoryRequest
Message for deleting a Repository.
FetchGitRefsRequest
Request for fetching git refs
RefType
Type of refs
FetchGitRefsResponse
Response for fetching git refs
FetchLinkableRepositoriesRequest
Request message for FetchLinkableRepositories.
FetchLinkableRepositoriesResponse
Response message for FetchLinkableRepositories.
FetchReadTokenRequest
Message for fetching SCM read token.
FetchReadTokenResponse
Message for responding to get read token.
FetchReadWriteTokenRequest
Message for fetching SCM read/write token.
FetchReadWriteTokenResponse
Message for responding to get read/write token.
GetConnectionRequest
Message for getting the details of a Connection.
GetRepositoryRequest
Message for getting the details of a Repository.
GitHubConfig
Configuration for connections to github.com.
GitHubEnterpriseConfig
Configuration for connections to an instance of GitHub Enterprise.
GitLabConfig
Configuration for connections to gitlab.com or an instance of GitLab Enterprise.
InstallationState
Describes stage and necessary actions to be taken by the user to complete the installation. Used for GitHub and GitHub Enterprise based connections.
Stage
Stage of the installation process.
ListConnectionsRequest
Message for requesting list of Connections.
ListConnectionsResponse
Message for response to listing Connections.
ListRepositoriesRequest
Message for requesting list of Repositories.
ListRepositoriesResponse
Message for response to listing Repositories.
OAuthCredential
Represents an OAuth token of the account that authorized the Connection, and associated metadata.
OperationMetadata
Represents the metadata of the long-running operation.
ProcessWebhookRequest
RPC request object accepted by the ProcessWebhook RPC method.
Repository
A repository associated to a parent connection.
AnnotationsEntry
The abstract base class for a message.
RunWorkflowCustomOperationMetadata
Represents the custom metadata of the RunWorkflow long-running operation.
ServiceDirectoryConfig
ServiceDirectoryConfig represents Service Directory configuration for a connection.
UpdateConnectionRequest
Message for updating a Connection.
UserCredential
Represents a personal access token that authorized the Connection, and associated metadata.
Modules
pagers
API documentation for devtools.cloudbuild_v1.services.cloud_build.pagers
module.
pagers
API documentation for devtools.cloudbuild_v2.services.repository_manager.pagers
module.