Class CloudBuildAsyncClient (3.8.2)

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>)

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.

Inheritance

builtins.object > CloudBuildAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
CloudBuildTransport	The transport used by the client instance.

Methods

CloudBuildAsyncClient

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>)

Instantiates the cloud build client.

Parameters

Name	Description
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) The `api_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, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_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.

Exceptions

Type	Description
google.auth.exceptions.MutualTlsChannelError	If mutual TLS transport creation failed for any reason.

approve_build

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

from google.cloud.devtools import cloudbuild_v1

async def sample_approve_build():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    request = cloudbuild_v1.ApproveBuildRequest(
        name="name_value",
    )

    # Make the request
    operation = client.approve_build(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
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 the `request` instance; if `request` is provided, this should not be set.
approval_result	`ApprovalResult` Approval decision and metadata. This corresponds to the `approval_result` field on the `request` instance; if `request` 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

Type

Description

google.api_core.operation_async.AsyncOperation

An object representing a long-running operation. The result type for the operation will be 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.

build_path

build_path(project: str, build: str)

Returns a fully-qualified build string.

build_trigger_path

build_trigger_path(project: str, trigger: str)

Returns a fully-qualified build_trigger string.

cancel_build

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Cancels a build in progress.

from google.cloud.devtools import cloudbuild_v1

async def sample_cancel_build():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    request = cloudbuild_v1.CancelBuildRequest(
        project_id="project_id_value",
        id="id_value",
    )

    # Make the request
    response = await client.cancel_build(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
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 the `request` instance; if `request` is provided, this should not be set.
id	`str` Required. ID of the build. This corresponds to the `id` field on the `request` instance; if `request` 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

Type

Description

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.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_build

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Starts a build with the specified configuration.

This method returns a long-running Operation, which includes the build ID. Pass the build ID to GetBuild to determine the build status (such as SUCCESS or FAILURE).

from google.cloud.devtools import cloudbuild_v1

async def sample_create_build():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    request = cloudbuild_v1.CreateBuildRequest(
        project_id="project_id_value",
    )

    # Make the request
    operation = client.create_build(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
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 the `request` instance; if `request` is provided, this should not be set.
build	`Build` Required. Build resource to create. This corresponds to the `build` field on the `request` instance; if `request` 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

Type

Description

google.api_core.operation_async.AsyncOperation

create_build_trigger

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new BuildTrigger.

This API is experimental.

from google.cloud.devtools import cloudbuild_v1

async def sample_create_build_trigger():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    trigger = cloudbuild_v1.BuildTrigger()
    trigger.autodetect = True

    request = cloudbuild_v1.CreateBuildTriggerRequest(
        project_id="project_id_value",
        trigger=trigger,
    )

    # Make the request
    response = await client.create_build_trigger(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
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 the `request` instance; if `request` is provided, this should not be set.
trigger	`BuildTrigger` Required. `BuildTrigger` to create. This corresponds to the `trigger` field on the `request` instance; if `request` 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

Type	Description
google.cloud.devtools.cloudbuild_v1.types.BuildTrigger	Configuration for an automated build in response to source repository changes.

create_worker_pool

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a WorkerPool.

from google.cloud.devtools import cloudbuild_v1

async def sample_create_worker_pool():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    request = cloudbuild_v1.CreateWorkerPoolRequest(
        parent="parent_value",
        worker_pool_id="worker_pool_id_value",
    )

    # Make the request
    operation = client.create_worker_pool(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
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 the `request` instance; if `request` is provided, this should not be set.
worker_pool	`WorkerPool` Required. `WorkerPool` resource to create. This corresponds to the `worker_pool` field on the `request` instance; if `request` 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 the `request` instance; if `request` 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

Type

Description

google.api_core.operation_async.AsyncOperation

An object representing a long-running operation. The result type for the operation will be 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).

crypto_key_path

crypto_key_path(project: str, location: str, keyring: str, key: str)

Returns a fully-qualified crypto_key string.

delete_build_trigger

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a BuildTrigger by its project ID and trigger ID.

This API is experimental.

from google.cloud.devtools import cloudbuild_v1

async def sample_delete_build_trigger():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    request = cloudbuild_v1.DeleteBuildTriggerRequest(
        project_id="project_id_value",
        trigger_id="trigger_id_value",
    )

    # Make the request
    await client.delete_build_trigger(request=request)

Parameters

Name	Description
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 the `request` instance; if `request` is provided, this should not be set.
trigger_id	`str` Required. ID of the `BuildTrigger` to delete. This corresponds to the `trigger_id` field on the `request` instance; if `request` 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

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a WorkerPool.

from google.cloud.devtools import cloudbuild_v1

async def sample_delete_worker_pool():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    request = cloudbuild_v1.DeleteWorkerPoolRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_worker_pool(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
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 the `request` instance; if `request` 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

Type

Description

google.api_core.operation_async.AsyncOperation

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 {}.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
CloudBuildAsyncClient	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter

Name	Description
info	`dict` The service account private key info.

Returns

Type	Description
CloudBuildAsyncClient	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
CloudBuildAsyncClient	The constructed client.

get_build

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns information about a previously requested build.

The Build that is returned includes its status (such as SUCCESS, FAILURE, or WORKING), and timing information.

from google.cloud.devtools import cloudbuild_v1

async def sample_get_build():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    request = cloudbuild_v1.GetBuildRequest(
        project_id="project_id_value",
        id="id_value",
    )

    # Make the request
    response = await client.get_build(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
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 the `request` instance; if `request` is provided, this should not be set.
id	`str` Required. ID of the build. This corresponds to the `id` field on the `request` instance; if `request` 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

Type

Description

google.cloud.devtools.cloudbuild_v1.types.Build

get_build_trigger

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns information about a BuildTrigger.

This API is experimental.

from google.cloud.devtools import cloudbuild_v1

async def sample_get_build_trigger():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    request = cloudbuild_v1.GetBuildTriggerRequest(
        project_id="project_id_value",
        trigger_id="trigger_id_value",
    )

    # Make the request
    response = await client.get_build_trigger(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
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 the `request` instance; if `request` is provided, this should not be set.
trigger_id	`str` Required. Identifier (`id` or `name`) of the `BuildTrigger` to get. This corresponds to the `trigger_id` field on the `request` instance; if `request` 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

Type	Description
google.cloud.devtools.cloudbuild_v1.types.BuildTrigger	Configuration for an automated build in response to source repository changes.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter

Name	Description
client_options	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions

Type	Description
google.auth.exceptions.MutualTLSChannelError	If any errors happen.

Returns

Type	Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]]	returns the API endpoint and the client cert source to use.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

get_worker_pool

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns details of a WorkerPool.

from google.cloud.devtools import cloudbuild_v1

async def sample_get_worker_pool():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    request = cloudbuild_v1.GetWorkerPoolRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_worker_pool(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
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 the `request` instance; if `request` 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

Type

Description

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).

list_build_triggers

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists existing BuildTrigger\ s.

This API is experimental.

from google.cloud.devtools import cloudbuild_v1

async def sample_list_build_triggers():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    request = cloudbuild_v1.ListBuildTriggersRequest(
        project_id="project_id_value",
    )

    # Make the request
    page_result = client.list_build_triggers(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

Name	Description
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 the `request` instance; if `request` 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

Type	Description
google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildTriggersAsyncPager	Response containing existing BuildTriggers. Iterating over this object will yield results and resolve additional pages automatically.

list_builds

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.

from google.cloud.devtools import cloudbuild_v1

async def sample_list_builds():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    request = cloudbuild_v1.ListBuildsRequest(
        project_id="project_id_value",
    )

    # Make the request
    page_result = client.list_builds(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

Name	Description
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 the `request` instance; if `request` is provided, this should not be set.
filter	`str` The raw filter text to constrain the results. This corresponds to the `filter` field on the `request` instance; if `request` 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

Type	Description
google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListBuildsAsyncPager	Response including listed builds. Iterating over this object will yield results and resolve additional pages automatically.

list_worker_pools

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists WorkerPool\ s.

from google.cloud.devtools import cloudbuild_v1

async def sample_list_worker_pools():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    request = cloudbuild_v1.ListWorkerPoolsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_worker_pools(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

Name	Description
request	`Union[google.cloud.devtools.cloudbuild_v1.types.ListWorkerPoolsRequest, dict]` The request object. Request to list `WorkerPool`\s.
parent	`str` Required. The parent of the collection of `WorkerPools`. Format: `projects/{project}/locations/{location}`. This corresponds to the `parent` field on the `request` instance; if `request` 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

Type	Description
google.cloud.devtools.cloudbuild_v1.services.cloud_build.pagers.ListWorkerPoolsAsyncPager	Response containing existing WorkerPools. Iterating over this object will yield results and resolve additional pages automatically.

network_path

network_path(project: str, network: str)

Returns a fully-qualified network string.

parse_build_path

parse_build_path(path: str)

Parses a build path into its component segments.

parse_build_trigger_path

parse_build_trigger_path(path: str)

Parses a build_trigger path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_crypto_key_path

parse_crypto_key_path(path: str)

Parses a crypto_key path into its component segments.

parse_network_path

parse_network_path(path: str)

Parses a network path into its component segments.

parse_secret_version_path

parse_secret_version_path(path: str)

Parses a secret_version path into its component segments.

parse_service_account_path

parse_service_account_path(path: str)

Parses a service_account path into its component segments.

parse_subscription_path

parse_subscription_path(path: str)

Parses a subscription path into its component segments.

parse_topic_path

parse_topic_path(path: str)

Parses a topic path into its component segments.

parse_worker_pool_path

parse_worker_pool_path(path: str)

Parses a worker_pool path into its component segments.

receive_trigger_webhook

receive_trigger_webhook(request: Optional[Union[google.cloud.devtools.cloudbuild_v1.types.cloudbuild.ReceiveTriggerWebhookRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger.

from google.cloud.devtools import cloudbuild_v1

async def sample_receive_trigger_webhook():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    request = cloudbuild_v1.ReceiveTriggerWebhookRequest(
    )

    # Make the request
    response = await client.receive_trigger_webhook(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
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

Type	Description
google.cloud.devtools.cloudbuild_v1.types.ReceiveTriggerWebhookResponse	ReceiveTriggerWebhookResponse [Experimental] is the response object for the ReceiveTriggerWebhook method.

retry_build

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

from google.cloud.devtools import cloudbuild_v1

async def sample_retry_build():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    request = cloudbuild_v1.RetryBuildRequest(
        project_id="project_id_value",
        id="id_value",
    )

    # Make the request
    operation = client.retry_build(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
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 the `request` instance; if `request` is provided, this should not be set.
id	`str` Required. Build ID of the original build. This corresponds to the `id` field on the `request` instance; if `request` 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

Type

Description

google.api_core.operation_async.AsyncOperation

run_build_trigger

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Runs a BuildTrigger at a particular source revision.

from google.cloud.devtools import cloudbuild_v1

async def sample_run_build_trigger():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    request = cloudbuild_v1.RunBuildTriggerRequest(
        project_id="project_id_value",
        trigger_id="trigger_id_value",
    )

    # Make the request
    operation = client.run_build_trigger(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
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 the `request` instance; if `request` is provided, this should not be set.
trigger_id	`str` Required. ID of the trigger. This corresponds to the `trigger_id` field on the `request` instance; if `request` is provided, this should not be set.
source	`RepoSource` Source to build against this trigger. This corresponds to the `source` field on the `request` instance; if `request` 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

Type

Description

google.api_core.operation_async.AsyncOperation

secret_version_path

secret_version_path(project: str, secret: str, version: str)

Returns a fully-qualified secret_version string.

service_account_path

service_account_path(project: str, service_account: str)

Returns a fully-qualified service_account string.

subscription_path

subscription_path(project: str, subscription: str)

Returns a fully-qualified subscription string.

topic_path

topic_path(project: str, topic: str)

Returns a fully-qualified topic string.

update_build_trigger

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a BuildTrigger by its project ID and trigger ID.

This API is experimental.

from google.cloud.devtools import cloudbuild_v1

async def sample_update_build_trigger():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    trigger = cloudbuild_v1.BuildTrigger()
    trigger.autodetect = True

    request = cloudbuild_v1.UpdateBuildTriggerRequest(
        project_id="project_id_value",
        trigger_id="trigger_id_value",
        trigger=trigger,
    )

    # Make the request
    response = await client.update_build_trigger(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
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 the `request` instance; if `request` is provided, this should not be set.
trigger_id	`str` Required. ID of the `BuildTrigger` to update. This corresponds to the `trigger_id` field on the `request` instance; if `request` is provided, this should not be set.
trigger	`BuildTrigger` Required. `BuildTrigger` to update. This corresponds to the `trigger` field on the `request` instance; if `request` 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

Type	Description
google.cloud.devtools.cloudbuild_v1.types.BuildTrigger	Configuration for an automated build in response to source repository changes.

update_worker_pool

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, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a WorkerPool.

from google.cloud.devtools import cloudbuild_v1

async def sample_update_worker_pool():
    # Create a client
    client = cloudbuild_v1.CloudBuildAsyncClient()

    # Initialize request argument(s)
    request = cloudbuild_v1.UpdateWorkerPoolRequest(
    )

    # Make the request
    operation = client.update_worker_pool(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.devtools.cloudbuild_v1.types.UpdateWorkerPoolRequest, dict]` The request object. Request to update a `WorkerPool`.
worker_pool	`WorkerPool` Required. The `WorkerPool` to update. The `name` field is used to identify the `WorkerPool` to update. Format: `projects/{project}/locations/{location}/workerPools/{workerPool}`. This corresponds to the `worker_pool` field on the `request` instance; if `request` 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 the `request` instance; if `request` 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

Type

Description

google.api_core.operation_async.AsyncOperation

worker_pool_path

worker_pool_path(project: str, location: str, worker_pool: str)

Returns a fully-qualified worker_pool string.