CloudBuild¶
- class google.cloud.devtools.cloudbuild_v1.services.cloud_build.CloudBuildAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.devtools.cloudbuild_v1.services.cloud_build.transports.base.CloudBuildTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶
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.
Instantiates the cloud build client.
- Parameters
credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Union[str, CloudBuildTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_endpoint
property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_cert_source
property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
- async approve_build(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ApproveBuildRequest, dict]] = None, *, name: Optional[str] = None, approval_result: Optional[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ApprovalResult] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Approves or rejects a pending build. If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call.
If rejected, the returned LRO will be immediately done.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.ApproveBuildRequest, dict]) – The request object. Request to approve or reject a pending build.
name (
str
) –Required. Name of the target build. For example: “projects/{$project_id}/builds/{$build_id}”
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.approval_result (
google.cloud.devtools.cloudbuild_v1.types.ApprovalResult
) – Approval decision and metadata. This corresponds to theapproval_result
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.devtools.cloudbuild_v1.types.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.
$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.
- Return type
google.api_core.operation_async.AsyncOperation
- static build_path(project: str, build: str) str ¶
Returns a fully-qualified build string.
- static build_trigger_path(project: str, trigger: str) str ¶
Returns a fully-qualified build_trigger string.
- async cancel_build(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.CancelBuildRequest, dict]] = None, *, project_id: Optional[str] = None, id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.types.cloudbuild.Build [source]¶
Cancels a build in progress.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.CancelBuildRequest, dict]) – The request object. Request to cancel an ongoing build.
project_id (
str
) – Required. ID of the project. This corresponds to theproject_id
field on therequest
instance; ifrequest
is provided, this should not be set.id (
str
) – Required. ID of the build. This corresponds to theid
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
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.
- Return type
- static common_billing_account_path(billing_account: str) str ¶
Returns a fully-qualified billing_account string.
- static common_folder_path(folder: str) str ¶
Returns a fully-qualified folder string.
- static common_location_path(project: str, location: str) str ¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str ¶
Returns a fully-qualified organization string.
- static common_project_path(project: str) str ¶
Returns a fully-qualified project string.
- async create_build(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.CreateBuildRequest, dict]] = None, *, project_id: Optional[str] = None, build: Optional[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.Build] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Starts a build with the specified configuration.
This method returns a long-running
Operation
, which includes the build ID. Pass the build ID toGetBuild
to determine the build status (such asSUCCESS
orFAILURE
).- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.CreateBuildRequest, dict]) – The request object. Request to create a new build.
project_id (
str
) – Required. ID of the project. This corresponds to theproject_id
field on therequest
instance; ifrequest
is provided, this should not be set.build (
google.cloud.devtools.cloudbuild_v1.types.Build
) – Required. Build resource to create. This corresponds to thebuild
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.devtools.cloudbuild_v1.types.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.
$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.
- Return type
google.api_core.operation_async.AsyncOperation
- async create_build_trigger(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.CreateBuildTriggerRequest, dict]] = None, *, project_id: Optional[str] = None, trigger: Optional[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.BuildTrigger] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.types.cloudbuild.BuildTrigger [source]¶
Creates a new
BuildTrigger
.This API is experimental.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.CreateBuildTriggerRequest, dict]) – The request object. Request to create a new BuildTrigger.
project_id (
str
) –Required. ID of the project for which to configure automatic builds.
This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.trigger (
google.cloud.devtools.cloudbuild_v1.types.BuildTrigger
) – Required.BuildTrigger
to create. This corresponds to thetrigger
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Configuration for an automated build in response to source repository changes.
- Return type
- async create_worker_pool(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.CreateWorkerPoolRequest, dict]] = None, *, parent: Optional[str] = None, worker_pool: Optional[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.WorkerPool] = None, worker_pool_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Creates a
WorkerPool
.- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.CreateWorkerPoolRequest, dict]) – The request object. Request to create a new WorkerPool.
parent (
str
) –Required. The parent resource where this worker pool will be created. Format:
projects/{project}/locations/{location}
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.worker_pool (
google.cloud.devtools.cloudbuild_v1.types.WorkerPool
) – Required.WorkerPool
resource to create. This corresponds to theworker_pool
field on therequest
instance; ifrequest
is provided, this should not be set.worker_pool_id (
str
) –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]-/.
This corresponds to the
worker_pool_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.devtools.cloudbuild_v1.types.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 WorkerPools 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).
- Return type
google.api_core.operation_async.AsyncOperation
- static crypto_key_path(project: str, location: str, keyring: str, key: str) str ¶
Returns a fully-qualified crypto_key string.
- async delete_build_trigger(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.DeleteBuildTriggerRequest, dict]] = None, *, project_id: Optional[str] = None, trigger_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes a
BuildTrigger
by its project ID and trigger ID.This API is experimental.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.DeleteBuildTriggerRequest, dict]) – The request object. Request to delete a BuildTrigger.
project_id (
str
) –Required. ID of the project that owns the trigger.
This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.trigger_id (
str
) – Required. ID of theBuildTrigger
to delete. This corresponds to thetrigger_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- async delete_worker_pool(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.DeleteWorkerPoolRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Deletes a
WorkerPool
.- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.DeleteWorkerPoolRequest, dict]) – The request object. Request to delete a WorkerPool.
name (
str
) –Required. The name of the
WorkerPool
to delete. Format:projects/{project}/locations/{workerPool}/workerPools/{workerPool}
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
- The result type for the operation will be
google.protobuf.empty_pb2.Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
- service Foo {
rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}
The JSON representation for Empty is empty JSON object {}.
- The result type for the operation will be
- Return type
google.api_core.operation_async.AsyncOperation
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- async get_build(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.GetBuildRequest, dict]] = None, *, project_id: Optional[str] = None, id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.types.cloudbuild.Build [source]¶
Returns information about a previously requested build.
The
Build
that is returned includes its status (such asSUCCESS
,FAILURE
, orWORKING
), and timing information.- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.GetBuildRequest, dict]) – The request object. Request to get a build.
project_id (
str
) – Required. ID of the project. This corresponds to theproject_id
field on therequest
instance; ifrequest
is provided, this should not be set.id (
str
) – Required. ID of the build. This corresponds to theid
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
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.
- Return type
- async get_build_trigger(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.GetBuildTriggerRequest, dict]] = None, *, project_id: Optional[str] = None, trigger_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.types.cloudbuild.BuildTrigger [source]¶
Returns information about a
BuildTrigger
.This API is experimental.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.GetBuildTriggerRequest, dict]) – The request object. Returns the BuildTrigger with the specified ID.
project_id (
str
) –Required. ID of the project that owns the trigger.
This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.trigger_id (
str
) –Required. Identifier (
id
orname
) of theBuildTrigger
to get.This corresponds to the
trigger_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Configuration for an automated build in response to source repository changes.
- Return type
- get_transport_class() Type[google.cloud.devtools.cloudbuild_v1.services.cloud_build.transports.base.CloudBuildTransport] ¶
Returns an appropriate transport class.
- Parameters
label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
- Returns
The transport class to use.
- async get_worker_pool(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.GetWorkerPoolRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.types.cloudbuild.WorkerPool [source]¶
Returns details of a
WorkerPool
.- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.GetWorkerPoolRequest, dict]) – The request object. Request to get a WorkerPool with the specified name.
name (
str
) –Required. The name of the
WorkerPool
to retrieve. Format:projects/{project}/locations/{location}/workerPools/{workerPool}
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
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 WorkerPools 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).
- Return type
- async list_build_triggers(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListBuildTriggersRequest, dict]] = None, *, project_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildTriggersAsyncPager [source]¶
Lists existing
BuildTrigger
s.This API is experimental.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.ListBuildTriggersRequest, dict]) – The request object. Request to list existing BuildTriggers.
project_id (
str
) –Required. ID of the project for which to list BuildTriggers.
This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response containing existing BuildTriggers.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildTriggersAsyncPager
- async list_builds(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListBuildsRequest, dict]] = None, *, project_id: Optional[str] = None, filter: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildsAsyncPager [source]¶
Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.ListBuildsRequest, dict]) – The request object. Request to list builds.
project_id (
str
) – Required. ID of the project. This corresponds to theproject_id
field on therequest
instance; ifrequest
is provided, this should not be set.filter (
str
) –The raw filter text to constrain the results.
This corresponds to the
filter
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response including listed builds. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildsAsyncPager
- async list_worker_pools(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListWorkerPoolsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListWorkerPoolsAsyncPager [source]¶
Lists
WorkerPool
s.- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.ListWorkerPoolsRequest, dict]) – The request object. Request to list WorkerPools.
parent (
str
) –Required. The parent of the collection of
WorkerPools
. Format:projects/{project}/locations/{location}
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response containing existing WorkerPools.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListWorkerPoolsAsyncPager
- static network_path(project: str, network: str) str ¶
Returns a fully-qualified network string.
- static parse_build_path(path: str) Dict[str, str] ¶
Parses a build path into its component segments.
- static parse_build_trigger_path(path: str) Dict[str, str] ¶
Parses a build_trigger path into its component segments.
- static parse_common_billing_account_path(path: str) Dict[str, str] ¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] ¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] ¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] ¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] ¶
Parse a project path into its component segments.
- static parse_crypto_key_path(path: str) Dict[str, str] ¶
Parses a crypto_key path into its component segments.
- static parse_network_path(path: str) Dict[str, str] ¶
Parses a network path into its component segments.
- static parse_secret_version_path(path: str) Dict[str, str] ¶
Parses a secret_version path into its component segments.
- static parse_service_account_path(path: str) Dict[str, str] ¶
Parses a service_account path into its component segments.
- static parse_subscription_path(path: str) Dict[str, str] ¶
Parses a subscription path into its component segments.
- static parse_topic_path(path: str) Dict[str, str] ¶
Parses a topic path into its component segments.
- static parse_worker_pool_path(path: str) Dict[str, str] ¶
Parses a worker_pool path into its component segments.
- async receive_trigger_webhook(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ReceiveTriggerWebhookRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ReceiveTriggerWebhookResponse [source]¶
ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.ReceiveTriggerWebhookRequest, dict]) – The request object. ReceiveTriggerWebhookRequest [Experimental] is the request object accepted by the ReceiveTriggerWebhook method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
- ReceiveTriggerWebhookResponse [Experimental] is the response object for the
ReceiveTriggerWebhook method.
- Return type
google.cloud.devtools.cloudbuild_v1.types.ReceiveTriggerWebhookResponse
- async retry_build(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.RetryBuildRequest, dict]] = None, *, project_id: Optional[str] = None, id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Creates a new build based on the specified build.
This method creates a new build using the original build request, which may or may not result in an identical build.
For triggered builds:
Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision.
For non-triggered builds that specify
RepoSource
:If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build.
If the original build specified a commit sha or revision ID, the retried build will use the identical source.
For builds that specify
StorageSource
:If the original build pulled source from Google Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source.
If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket’s lifecycle management settings.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.RetryBuildRequest, dict]) – The request object. Specifies a build to retry.
project_id (
str
) – Required. ID of the project. This corresponds to theproject_id
field on therequest
instance; ifrequest
is provided, this should not be set.id (
str
) –Required. Build ID of the original build.
This corresponds to the
id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.devtools.cloudbuild_v1.types.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.
$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.
- Return type
google.api_core.operation_async.AsyncOperation
- async run_build_trigger(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.RunBuildTriggerRequest, dict]] = None, *, project_id: Optional[str] = None, trigger_id: Optional[str] = None, source: Optional[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.RepoSource] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Runs a
BuildTrigger
at a particular source revision.- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.RunBuildTriggerRequest, dict]) – The request object. Specifies a build trigger to run and the source to use.
project_id (
str
) – Required. ID of the project. This corresponds to theproject_id
field on therequest
instance; ifrequest
is provided, this should not be set.trigger_id (
str
) – Required. ID of the trigger. This corresponds to thetrigger_id
field on therequest
instance; ifrequest
is provided, this should not be set.source (
google.cloud.devtools.cloudbuild_v1.types.RepoSource
) – Source to build against this trigger. This corresponds to thesource
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.devtools.cloudbuild_v1.types.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.
$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.
- Return type
google.api_core.operation_async.AsyncOperation
- static secret_version_path(project: str, secret: str, version: str) str ¶
Returns a fully-qualified secret_version string.
- static service_account_path(project: str, service_account: str) str ¶
Returns a fully-qualified service_account string.
- static subscription_path(project: str, subscription: str) str ¶
Returns a fully-qualified subscription string.
- static topic_path(project: str, topic: str) str ¶
Returns a fully-qualified topic string.
- property transport: google.cloud.devtools.cloudbuild_v1.services.cloud_build.transports.base.CloudBuildTransport¶
Returns the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
CloudBuildTransport
- async update_build_trigger(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.UpdateBuildTriggerRequest, dict]] = None, *, project_id: Optional[str] = None, trigger_id: Optional[str] = None, trigger: Optional[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.BuildTrigger] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.types.cloudbuild.BuildTrigger [source]¶
Updates a
BuildTrigger
by its project ID and trigger ID.This API is experimental.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.UpdateBuildTriggerRequest, dict]) – The request object. Request to update an existing BuildTrigger.
project_id (
str
) –Required. ID of the project that owns the trigger.
This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.trigger_id (
str
) – Required. ID of theBuildTrigger
to update. This corresponds to thetrigger_id
field on therequest
instance; ifrequest
is provided, this should not be set.trigger (
google.cloud.devtools.cloudbuild_v1.types.BuildTrigger
) – Required.BuildTrigger
to update. This corresponds to thetrigger
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Configuration for an automated build in response to source repository changes.
- Return type
- async update_worker_pool(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.UpdateWorkerPoolRequest, dict]] = None, *, worker_pool: Optional[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.WorkerPool] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Updates a
WorkerPool
.- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.UpdateWorkerPoolRequest, dict]) – The request object. Request to update a WorkerPool.
worker_pool (
google.cloud.devtools.cloudbuild_v1.types.WorkerPool
) –Required. The
WorkerPool
to update.The
name
field is used to identify theWorkerPool
to update. Format:projects/{project}/locations/{location}/workerPools/{workerPool}
.This corresponds to the
worker_pool
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
google.protobuf.field_mask_pb2.FieldMask
) –A mask specifying which fields in
worker_pool
to update.This corresponds to the
update_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.devtools.cloudbuild_v1.types.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 WorkerPools 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).
- Return type
google.api_core.operation_async.AsyncOperation
- static worker_pool_path(project: str, location: str, worker_pool: str) str ¶
Returns a fully-qualified worker_pool string.
- class google.cloud.devtools.cloudbuild_v1.services.cloud_build.CloudBuildClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.devtools.cloudbuild_v1.services.cloud_build.transports.base.CloudBuildTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶
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.
Instantiates the cloud build client.
- Parameters
credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Union[str, CloudBuildTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_endpoint
property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_cert_source
property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If
None
, then default info will be used. Generally, you only need to set this if you’re developing your own client library.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
- __exit__(type, value, traceback)[source]¶
Releases underlying transport’s resources.
Warning
ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!
- approve_build(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ApproveBuildRequest, dict]] = None, *, name: Optional[str] = None, approval_result: Optional[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ApprovalResult] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Approves or rejects a pending build. If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call.
If rejected, the returned LRO will be immediately done.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.ApproveBuildRequest, dict]) – The request object. Request to approve or reject a pending build.
name (str) –
Required. Name of the target build. For example: “projects/{$project_id}/builds/{$build_id}”
This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.approval_result (google.cloud.devtools.cloudbuild_v1.types.ApprovalResult) – Approval decision and metadata. This corresponds to the
approval_result
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.devtools.cloudbuild_v1.types.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.
$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.
- Return type
google.api_core.operation.Operation
- static build_trigger_path(project: str, trigger: str) str [source]¶
Returns a fully-qualified build_trigger string.
- cancel_build(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.CancelBuildRequest, dict]] = None, *, project_id: Optional[str] = None, id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.types.cloudbuild.Build [source]¶
Cancels a build in progress.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.CancelBuildRequest, dict]) – The request object. Request to cancel an ongoing build.
project_id (str) – Required. ID of the project. This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.id (str) – Required. ID of the build. This corresponds to the
id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
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.
- Return type
- static common_billing_account_path(billing_account: str) str [source]¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str [source]¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str [source]¶
Returns a fully-qualified organization string.
- create_build(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.CreateBuildRequest, dict]] = None, *, project_id: Optional[str] = None, build: Optional[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.Build] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Starts a build with the specified configuration.
This method returns a long-running
Operation
, which includes the build ID. Pass the build ID toGetBuild
to determine the build status (such asSUCCESS
orFAILURE
).- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.CreateBuildRequest, dict]) – The request object. Request to create a new build.
project_id (str) – Required. ID of the project. This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.build (google.cloud.devtools.cloudbuild_v1.types.Build) – Required. Build resource to create. This corresponds to the
build
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.devtools.cloudbuild_v1.types.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.
$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.
- Return type
google.api_core.operation.Operation
- create_build_trigger(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.CreateBuildTriggerRequest, dict]] = None, *, project_id: Optional[str] = None, trigger: Optional[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.BuildTrigger] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.types.cloudbuild.BuildTrigger [source]¶
Creates a new
BuildTrigger
.This API is experimental.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.CreateBuildTriggerRequest, dict]) – The request object. Request to create a new BuildTrigger.
project_id (str) –
Required. ID of the project for which to configure automatic builds.
This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.trigger (google.cloud.devtools.cloudbuild_v1.types.BuildTrigger) – Required.
BuildTrigger
to create. This corresponds to thetrigger
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Configuration for an automated build in response to source repository changes.
- Return type
- create_worker_pool(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.CreateWorkerPoolRequest, dict]] = None, *, parent: Optional[str] = None, worker_pool: Optional[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.WorkerPool] = None, worker_pool_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Creates a
WorkerPool
.- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.CreateWorkerPoolRequest, dict]) – The request object. Request to create a new WorkerPool.
parent (str) –
Required. The parent resource where this worker pool will be created. Format:
projects/{project}/locations/{location}
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.worker_pool (google.cloud.devtools.cloudbuild_v1.types.WorkerPool) – Required.
WorkerPool
resource to create. This corresponds to theworker_pool
field on therequest
instance; ifrequest
is provided, this should not be set.worker_pool_id (str) –
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]-/.
This corresponds to the
worker_pool_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.devtools.cloudbuild_v1.types.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 WorkerPools 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).
- Return type
google.api_core.operation.Operation
- static crypto_key_path(project: str, location: str, keyring: str, key: str) str [source]¶
Returns a fully-qualified crypto_key string.
- delete_build_trigger(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.DeleteBuildTriggerRequest, dict]] = None, *, project_id: Optional[str] = None, trigger_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes a
BuildTrigger
by its project ID and trigger ID.This API is experimental.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.DeleteBuildTriggerRequest, dict]) – The request object. Request to delete a BuildTrigger.
project_id (str) –
Required. ID of the project that owns the trigger.
This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.trigger_id (str) – Required. ID of the
BuildTrigger
to delete. This corresponds to thetrigger_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- delete_worker_pool(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.DeleteWorkerPoolRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Deletes a
WorkerPool
.- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.DeleteWorkerPoolRequest, dict]) – The request object. Request to delete a WorkerPool.
name (str) –
Required. The name of the
WorkerPool
to delete. Format:projects/{project}/locations/{workerPool}/workerPools/{workerPool}
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
- The result type for the operation will be
google.protobuf.empty_pb2.Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
- service Foo {
rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}
The JSON representation for Empty is empty JSON object {}.
- The result type for the operation will be
- Return type
google.api_core.operation.Operation
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- get_build(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.GetBuildRequest, dict]] = None, *, project_id: Optional[str] = None, id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.types.cloudbuild.Build [source]¶
Returns information about a previously requested build.
The
Build
that is returned includes its status (such asSUCCESS
,FAILURE
, orWORKING
), and timing information.- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.GetBuildRequest, dict]) – The request object. Request to get a build.
project_id (str) – Required. ID of the project. This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.id (str) – Required. ID of the build. This corresponds to the
id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
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.
- Return type
- get_build_trigger(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.GetBuildTriggerRequest, dict]] = None, *, project_id: Optional[str] = None, trigger_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.types.cloudbuild.BuildTrigger [source]¶
Returns information about a
BuildTrigger
.This API is experimental.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.GetBuildTriggerRequest, dict]) – The request object. Returns the BuildTrigger with the specified ID.
project_id (str) –
Required. ID of the project that owns the trigger.
This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.trigger_id (str) –
Required. Identifier (
id
orname
) of theBuildTrigger
to get.This corresponds to the
trigger_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Configuration for an automated build in response to source repository changes.
- Return type
- get_worker_pool(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.GetWorkerPoolRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.types.cloudbuild.WorkerPool [source]¶
Returns details of a
WorkerPool
.- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.GetWorkerPoolRequest, dict]) – The request object. Request to get a WorkerPool with the specified name.
name (str) –
Required. The name of the
WorkerPool
to retrieve. Format:projects/{project}/locations/{location}/workerPools/{workerPool}
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
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 WorkerPools 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).
- Return type
- list_build_triggers(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListBuildTriggersRequest, dict]] = None, *, project_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildTriggersPager [source]¶
Lists existing
BuildTrigger
s.This API is experimental.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.ListBuildTriggersRequest, dict]) – The request object. Request to list existing BuildTriggers.
project_id (str) –
Required. ID of the project for which to list BuildTriggers.
This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response containing existing BuildTriggers.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildTriggersPager
- list_builds(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListBuildsRequest, dict]] = None, *, project_id: Optional[str] = None, filter: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildsPager [source]¶
Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.ListBuildsRequest, dict]) – The request object. Request to list builds.
project_id (str) – Required. ID of the project. This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.filter (str) –
The raw filter text to constrain the results.
This corresponds to the
filter
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response including listed builds. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildsPager
- list_worker_pools(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListWorkerPoolsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListWorkerPoolsPager [source]¶
Lists
WorkerPool
s.- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.ListWorkerPoolsRequest, dict]) – The request object. Request to list WorkerPools.
parent (str) –
Required. The parent of the collection of
WorkerPools
. Format:projects/{project}/locations/{location}
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response containing existing WorkerPools.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListWorkerPoolsPager
- static network_path(project: str, network: str) str [source]¶
Returns a fully-qualified network string.
- static parse_build_path(path: str) Dict[str, str] [source]¶
Parses a build path into its component segments.
- static parse_build_trigger_path(path: str) Dict[str, str] [source]¶
Parses a build_trigger path into its component segments.
- static parse_common_billing_account_path(path: str) Dict[str, str] [source]¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] [source]¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] [source]¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] [source]¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] [source]¶
Parse a project path into its component segments.
- static parse_crypto_key_path(path: str) Dict[str, str] [source]¶
Parses a crypto_key path into its component segments.
- static parse_network_path(path: str) Dict[str, str] [source]¶
Parses a network path into its component segments.
- static parse_secret_version_path(path: str) Dict[str, str] [source]¶
Parses a secret_version path into its component segments.
- static parse_service_account_path(path: str) Dict[str, str] [source]¶
Parses a service_account path into its component segments.
- static parse_subscription_path(path: str) Dict[str, str] [source]¶
Parses a subscription path into its component segments.
- static parse_topic_path(path: str) Dict[str, str] [source]¶
Parses a topic path into its component segments.
- static parse_worker_pool_path(path: str) Dict[str, str] [source]¶
Parses a worker_pool path into its component segments.
- receive_trigger_webhook(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ReceiveTriggerWebhookRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ReceiveTriggerWebhookResponse [source]¶
ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.ReceiveTriggerWebhookRequest, dict]) – The request object. ReceiveTriggerWebhookRequest [Experimental] is the request object accepted by the ReceiveTriggerWebhook method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
- ReceiveTriggerWebhookResponse [Experimental] is the response object for the
ReceiveTriggerWebhook method.
- Return type
google.cloud.devtools.cloudbuild_v1.types.ReceiveTriggerWebhookResponse
- retry_build(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.RetryBuildRequest, dict]] = None, *, project_id: Optional[str] = None, id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Creates a new build based on the specified build.
This method creates a new build using the original build request, which may or may not result in an identical build.
For triggered builds:
Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision.
For non-triggered builds that specify
RepoSource
:If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build.
If the original build specified a commit sha or revision ID, the retried build will use the identical source.
For builds that specify
StorageSource
:If the original build pulled source from Google Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source.
If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket’s lifecycle management settings.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.RetryBuildRequest, dict]) – The request object. Specifies a build to retry.
project_id (str) – Required. ID of the project. This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.id (str) –
Required. Build ID of the original build.
This corresponds to the
id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.devtools.cloudbuild_v1.types.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.
$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.
- Return type
google.api_core.operation.Operation
- run_build_trigger(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.RunBuildTriggerRequest, dict]] = None, *, project_id: Optional[str] = None, trigger_id: Optional[str] = None, source: Optional[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.RepoSource] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Runs a
BuildTrigger
at a particular source revision.- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.RunBuildTriggerRequest, dict]) – The request object. Specifies a build trigger to run and the source to use.
project_id (str) – Required. ID of the project. This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.trigger_id (str) – Required. ID of the trigger. This corresponds to the
trigger_id
field on therequest
instance; ifrequest
is provided, this should not be set.source (google.cloud.devtools.cloudbuild_v1.types.RepoSource) – Source to build against this trigger. This corresponds to the
source
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.devtools.cloudbuild_v1.types.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.
$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.
- Return type
google.api_core.operation.Operation
- static secret_version_path(project: str, secret: str, version: str) str [source]¶
Returns a fully-qualified secret_version string.
- static service_account_path(project: str, service_account: str) str [source]¶
Returns a fully-qualified service_account string.
- static subscription_path(project: str, subscription: str) str [source]¶
Returns a fully-qualified subscription string.
- property transport: google.cloud.devtools.cloudbuild_v1.services.cloud_build.transports.base.CloudBuildTransport¶
Returns the transport used by the client instance.
- Returns
- The transport used by the client
instance.
- Return type
CloudBuildTransport
- update_build_trigger(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.UpdateBuildTriggerRequest, dict]] = None, *, project_id: Optional[str] = None, trigger_id: Optional[str] = None, trigger: Optional[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.BuildTrigger] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.devtools.cloudbuild_v1.types.cloudbuild.BuildTrigger [source]¶
Updates a
BuildTrigger
by its project ID and trigger ID.This API is experimental.
- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.UpdateBuildTriggerRequest, dict]) – The request object. Request to update an existing BuildTrigger.
project_id (str) –
Required. ID of the project that owns the trigger.
This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.trigger_id (str) – Required. ID of the
BuildTrigger
to update. This corresponds to thetrigger_id
field on therequest
instance; ifrequest
is provided, this should not be set.trigger (google.cloud.devtools.cloudbuild_v1.types.BuildTrigger) – Required.
BuildTrigger
to update. This corresponds to thetrigger
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Configuration for an automated build in response to source repository changes.
- Return type
- update_worker_pool(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.UpdateWorkerPoolRequest, dict]] = None, *, worker_pool: Optional[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.WorkerPool] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Updates a
WorkerPool
.- Parameters
request (Union[google.cloud.devtools.cloudbuild_v1.types.UpdateWorkerPoolRequest, dict]) – The request object. Request to update a WorkerPool.
worker_pool (google.cloud.devtools.cloudbuild_v1.types.WorkerPool) –
Required. The
WorkerPool
to update.The
name
field is used to identify theWorkerPool
to update. Format:projects/{project}/locations/{location}/workerPools/{workerPool}
.This corresponds to the
worker_pool
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.FieldMask) –
A mask specifying which fields in
worker_pool
to update.This corresponds to the
update_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.devtools.cloudbuild_v1.types.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 WorkerPools 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).
- Return type
google.api_core.operation.Operation
- class google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildTriggersAsyncPager(method: Callable[[...], Awaitable[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListBuildTriggersResponse]], request: google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListBuildTriggersRequest, response: google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListBuildTriggersResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_build_triggers
requests.This class thinly wraps an initial
google.cloud.devtools.cloudbuild_v1.types.ListBuildTriggersResponse
object, and provides an__aiter__
method to iterate through itstriggers
field.If there are more pages, the
__aiter__
method will make additionalListBuildTriggers
requests and continue to iterate through thetriggers
field on the corresponding responses.All the usual
google.cloud.devtools.cloudbuild_v1.types.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.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.devtools.cloudbuild_v1.types.ListBuildTriggersRequest) – The initial request object.
response (google.cloud.devtools.cloudbuild_v1.types.ListBuildTriggersResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildTriggersPager(method: Callable[[...], google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListBuildTriggersResponse], request: google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListBuildTriggersRequest, response: google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListBuildTriggersResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_build_triggers
requests.This class thinly wraps an initial
google.cloud.devtools.cloudbuild_v1.types.ListBuildTriggersResponse
object, and provides an__iter__
method to iterate through itstriggers
field.If there are more pages, the
__iter__
method will make additionalListBuildTriggers
requests and continue to iterate through thetriggers
field on the corresponding responses.All the usual
google.cloud.devtools.cloudbuild_v1.types.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.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.devtools.cloudbuild_v1.types.ListBuildTriggersRequest) – The initial request object.
response (google.cloud.devtools.cloudbuild_v1.types.ListBuildTriggersResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildsAsyncPager(method: Callable[[...], Awaitable[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListBuildsResponse]], request: google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListBuildsRequest, response: google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListBuildsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_builds
requests.This class thinly wraps an initial
google.cloud.devtools.cloudbuild_v1.types.ListBuildsResponse
object, and provides an__aiter__
method to iterate through itsbuilds
field.If there are more pages, the
__aiter__
method will make additionalListBuilds
requests and continue to iterate through thebuilds
field on the corresponding responses.All the usual
google.cloud.devtools.cloudbuild_v1.types.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.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.devtools.cloudbuild_v1.types.ListBuildsRequest) – The initial request object.
response (google.cloud.devtools.cloudbuild_v1.types.ListBuildsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildsPager(method: Callable[[...], google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListBuildsResponse], request: google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListBuildsRequest, response: google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListBuildsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_builds
requests.This class thinly wraps an initial
google.cloud.devtools.cloudbuild_v1.types.ListBuildsResponse
object, and provides an__iter__
method to iterate through itsbuilds
field.If there are more pages, the
__iter__
method will make additionalListBuilds
requests and continue to iterate through thebuilds
field on the corresponding responses.All the usual
google.cloud.devtools.cloudbuild_v1.types.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.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.devtools.cloudbuild_v1.types.ListBuildsRequest) – The initial request object.
response (google.cloud.devtools.cloudbuild_v1.types.ListBuildsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListWorkerPoolsAsyncPager(method: Callable[[...], Awaitable[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListWorkerPoolsResponse]], request: google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListWorkerPoolsRequest, response: google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListWorkerPoolsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_worker_pools
requests.This class thinly wraps an initial
google.cloud.devtools.cloudbuild_v1.types.ListWorkerPoolsResponse
object, and provides an__aiter__
method to iterate through itsworker_pools
field.If there are more pages, the
__aiter__
method will make additionalListWorkerPools
requests and continue to iterate through theworker_pools
field on the corresponding responses.All the usual
google.cloud.devtools.cloudbuild_v1.types.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.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.devtools.cloudbuild_v1.types.ListWorkerPoolsRequest) – The initial request object.
response (google.cloud.devtools.cloudbuild_v1.types.ListWorkerPoolsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListWorkerPoolsPager(method: Callable[[...], google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListWorkerPoolsResponse], request: google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListWorkerPoolsRequest, response: google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ListWorkerPoolsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_worker_pools
requests.This class thinly wraps an initial
google.cloud.devtools.cloudbuild_v1.types.ListWorkerPoolsResponse
object, and provides an__iter__
method to iterate through itsworker_pools
field.If there are more pages, the
__iter__
method will make additionalListWorkerPools
requests and continue to iterate through theworker_pools
field on the corresponding responses.All the usual
google.cloud.devtools.cloudbuild_v1.types.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.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.devtools.cloudbuild_v1.types.ListWorkerPoolsRequest) – The initial request object.
response (google.cloud.devtools.cloudbuild_v1.types.ListWorkerPoolsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.