As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

CloudDeploy¶

class google.cloud.deploy_v1.services.cloud_deploy.CloudDeployAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.deploy_v1.services.cloud_deploy.transports.base.CloudDeployTransport, typing.Callable[[...], google.cloud.deploy_v1.services.cloud_deploy.transports.base.CloudDeployTransport]]] = 'grpc_asyncio', client_options: typing.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]¶

CloudDeploy service creates and manages Continuous Delivery operations on Google Cloud Platform via Skaffold (https://skaffold.dev).

Instantiates the cloud deploy async 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 (Optional[Union[str,CloudDeployTransport,Callable[..., CloudDeployTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the CloudDeployTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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.

async abandon_release(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.AbandonReleaseRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.AbandonReleaseResponse[source]¶

Abandons a Release in the Delivery Pipeline.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_abandon_release():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.AbandonReleaseRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.AbandonReleaseRequest, dict]]) – The request object. The request object used by AbandonRelease.
name (str) –
Required. Name of the Release. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response object for AbandonRelease.

Return type

google.cloud.deploy_v1.types.AbandonReleaseResponse

async advance_rollout(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.AdvanceRolloutRequest, dict]] = None, *, name: Optional[str] = None, phase_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.AdvanceRolloutResponse[source]¶

Advances a Rollout in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_advance_rollout():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.AdvanceRolloutRequest(
        name="name_value",
        phase_id="phase_id_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.AdvanceRolloutRequest, dict]]) – The request object. The request object used by AdvanceRollout.
name (str) –
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
phase_id (str) – Required. The phase ID to advance the Rollout to. This corresponds to the phase_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response object from AdvanceRollout.

Return type

google.cloud.deploy_v1.types.AdvanceRolloutResponse

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

async approve_rollout(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ApproveRolloutRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.ApproveRolloutResponse[source]¶

Approves a Rollout.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_approve_rollout():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.ApproveRolloutRequest(
        name="name_value",
        approved=True,
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.ApproveRolloutRequest, dict]]) – The request object. The request object used by ApproveRollout.
name (str) –
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response object from ApproveRollout.

Return type

google.cloud.deploy_v1.types.ApproveRolloutResponse

static automation_path(project: str, location: str, delivery_pipeline: str, automation: str) → str¶: Returns a fully-qualified automation string.

static automation_run_path(project: str, location: str, delivery_pipeline: str, automation_run: str) → str¶: Returns a fully-qualified automation_run string.

static build_path(project: str, location: str, build: str) → str¶: Returns a fully-qualified build string.

async cancel_automation_run(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CancelAutomationRunRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.CancelAutomationRunResponse[source]¶

Cancels an AutomationRun. The state of the AutomationRun after cancelling is CANCELLED. CancelAutomationRun can be called on AutomationRun in the state IN_PROGRESS and PENDING; AutomationRun in a different state returns an FAILED_PRECONDITION error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_cancel_automation_run():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.CancelAutomationRunRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.CancelAutomationRunRequest, dict]]) – The request object. The request object used by CancelAutomationRun.
name (str) –
Required. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response object from CancelAutomationRun.

Return type

google.cloud.deploy_v1.types.CancelAutomationRunResponse

async cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

request (CancelOperationRequest) – The request object. Request message for CancelOperation method.
retry (google.api_core.retry_async.AsyncRetry) – 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

None

async cancel_rollout(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CancelRolloutRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.CancelRolloutResponse[source]¶

Cancels a Rollout in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_cancel_rollout():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.CancelRolloutRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.CancelRolloutRequest, dict]]) – The request object. The request object used by CancelRollout.
name (str) –
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response object from CancelRollout.

Return type

google.cloud.deploy_v1.types.CancelRolloutResponse

static cluster_path(project: str, location: str, cluster: str) → str¶: Returns a fully-qualified cluster string.

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.

static config_path(project: str, location: str) → str¶: Returns a fully-qualified config string.

async create_automation(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateAutomationRequest, dict]] = None, *, parent: Optional[str] = None, automation: Optional[google.cloud.deploy_v1.types.cloud_deploy.Automation] = None, automation_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a new Automation in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_create_automation():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    automation = deploy_v1.Automation()
    automation.service_account = "service_account_value"
    automation.rules.promote_release_rule.id = "id_value"

    request = deploy_v1.CreateAutomationRequest(
        parent="parent_value",
        automation_id="automation_id_value",
        automation=automation,
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.CreateAutomationRequest, dict]]) – The request object. The request object for CreateAutomation.
parent (str) –
Required. The parent collection in which the Automation must be created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
automation (google.cloud.deploy_v1.types.Automation) – Required. The Automation to create. This corresponds to the automation field on the request instance; if request is provided, this should not be set.
automation_id (str) – Required. ID of the Automation. This corresponds to the automation_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.deploy_v1.types.Automation An Automation resource in the Cloud Deploy API.

An Automation enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.

Return type

google.api_core.operation_async.AsyncOperation

async create_custom_target_type(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateCustomTargetTypeRequest, dict]] = None, *, parent: Optional[str] = None, custom_target_type: Optional[google.cloud.deploy_v1.types.cloud_deploy.CustomTargetType] = None, custom_target_type_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a new CustomTargetType in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_create_custom_target_type():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    custom_target_type = deploy_v1.CustomTargetType()
    custom_target_type.custom_actions.deploy_action = "deploy_action_value"

    request = deploy_v1.CreateCustomTargetTypeRequest(
        parent="parent_value",
        custom_target_type_id="custom_target_type_id_value",
        custom_target_type=custom_target_type,
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.CreateCustomTargetTypeRequest, dict]]) – The request object. The request object for CreateCustomTargetType.
parent (str) –
Required. The parent collection in which the CustomTargetType must be created. The format is projects/{project_id}/locations/{location_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
custom_target_type (google.cloud.deploy_v1.types.CustomTargetType) – Required. The CustomTargetType to create. This corresponds to the custom_target_type field on the request instance; if request is provided, this should not be set.
custom_target_type_id (str) – Required. ID of the CustomTargetType. This corresponds to the custom_target_type_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.deploy_v1.types.CustomTargetType A CustomTargetType resource in the Cloud Deploy API.

A CustomTargetType defines a type of custom target that can be referenced in a Target in order to facilitate deploying to other systems besides the supported runtimes.

Return type

google.api_core.operation_async.AsyncOperation

async create_delivery_pipeline(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateDeliveryPipelineRequest, dict]] = None, *, parent: Optional[str] = None, delivery_pipeline: Optional[google.cloud.deploy_v1.types.cloud_deploy.DeliveryPipeline] = None, delivery_pipeline_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a new DeliveryPipeline in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_create_delivery_pipeline():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.CreateDeliveryPipelineRequest(
        parent="parent_value",
        delivery_pipeline_id="delivery_pipeline_id_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.CreateDeliveryPipelineRequest, dict]]) – The request object. The request object for CreateDeliveryPipeline.
parent (str) –
Required. The parent collection in which the DeliveryPipeline must be created. The format is projects/{project_id}/locations/{location_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
delivery_pipeline (google.cloud.deploy_v1.types.DeliveryPipeline) – Required. The DeliveryPipeline to create. This corresponds to the delivery_pipeline field on the request instance; if request is provided, this should not be set.
delivery_pipeline_id (str) – Required. ID of the DeliveryPipeline. This corresponds to the delivery_pipeline_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.deploy_v1.types.DeliveryPipeline A DeliveryPipeline resource in the Cloud Deploy API.

A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.

Return type

google.api_core.operation_async.AsyncOperation

async create_deploy_policy(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateDeployPolicyRequest, dict]] = None, *, parent: Optional[str] = None, deploy_policy: Optional[google.cloud.deploy_v1.types.cloud_deploy.DeployPolicy] = None, deploy_policy_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a new DeployPolicy in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_create_deploy_policy():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    deploy_policy = deploy_v1.DeployPolicy()
    deploy_policy.rules.rollout_restriction.id = "id_value"
    deploy_policy.rules.rollout_restriction.time_windows.time_zone = "time_zone_value"

    request = deploy_v1.CreateDeployPolicyRequest(
        parent="parent_value",
        deploy_policy_id="deploy_policy_id_value",
        deploy_policy=deploy_policy,
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.CreateDeployPolicyRequest, dict]]) – The request object. The request object for CreateDeployPolicy.
parent (str) –
Required. The parent collection in which the DeployPolicy must be created. The format is projects/{project_id}/locations/{location_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
deploy_policy (google.cloud.deploy_v1.types.DeployPolicy) – Required. The DeployPolicy to create. This corresponds to the deploy_policy field on the request instance; if request is provided, this should not be set.
deploy_policy_id (str) – Required. ID of the DeployPolicy. This corresponds to the deploy_policy_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.deploy_v1.types.DeployPolicy A DeployPolicy resource in the Cloud Deploy API.

A DeployPolicy inhibits manual or automation-driven actions within a Delivery Pipeline or Target.

Return type

google.api_core.operation_async.AsyncOperation

async create_release(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateReleaseRequest, dict]] = None, *, parent: Optional[str] = None, release: Optional[google.cloud.deploy_v1.types.cloud_deploy.Release] = None, release_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a new Release in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_create_release():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.CreateReleaseRequest(
        parent="parent_value",
        release_id="release_id_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.CreateReleaseRequest, dict]]) – The request object. The request object for CreateRelease,
parent (str) –
Required. The parent collection in which the Release is created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
release (google.cloud.deploy_v1.types.Release) – Required. The Release to create. This corresponds to the release field on the request instance; if request is provided, this should not be set.
release_id (str) – Required. ID of the Release. This corresponds to the release_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.deploy_v1.types.Release A Release resource in the Cloud Deploy API.

A Release defines a specific Skaffold configuration instance that can be deployed.

Return type

google.api_core.operation_async.AsyncOperation

async create_rollout(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateRolloutRequest, dict]] = None, *, parent: Optional[str] = None, rollout: Optional[google.cloud.deploy_v1.types.cloud_deploy.Rollout] = None, rollout_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a new Rollout in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_create_rollout():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    rollout = deploy_v1.Rollout()
    rollout.target_id = "target_id_value"

    request = deploy_v1.CreateRolloutRequest(
        parent="parent_value",
        rollout_id="rollout_id_value",
        rollout=rollout,
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.CreateRolloutRequest, dict]]) – The request object. CreateRolloutRequest is the request object used by CreateRollout.
parent (str) –
Required. The parent collection in which the Rollout must be created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
rollout (google.cloud.deploy_v1.types.Rollout) – Required. The Rollout to create. This corresponds to the rollout field on the request instance; if request is provided, this should not be set.
rollout_id (str) – Required. ID of the Rollout. This corresponds to the rollout_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.deploy_v1.types.Rollout A Rollout resource in the Cloud Deploy API.

A Rollout contains information around a specific deployment to a Target.

Return type

google.api_core.operation_async.AsyncOperation

async create_target(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateTargetRequest, dict]] = None, *, parent: Optional[str] = None, target: Optional[google.cloud.deploy_v1.types.cloud_deploy.Target] = None, target_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Creates a new Target in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_create_target():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.CreateTargetRequest(
        parent="parent_value",
        target_id="target_id_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.CreateTargetRequest, dict]]) – The request object. The request object for CreateTarget.
parent (str) –
Required. The parent collection in which the Target must be created. The format is projects/{project_id}/locations/{location_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
target (google.cloud.deploy_v1.types.Target) – Required. The Target to create. This corresponds to the target field on the request instance; if request is provided, this should not be set.
target_id (str) – Required. ID of the Target. This corresponds to the target_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.deploy_v1.types.Target A Target resource in the Cloud Deploy API.

A Target defines a location to which a Skaffold configuration can be deployed.

Return type

google.api_core.operation_async.AsyncOperation

static custom_target_type_path(project: str, location: str, custom_target_type: str) → str¶: Returns a fully-qualified custom_target_type string.

async delete_automation(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.DeleteAutomationRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes a single Automation resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_delete_automation():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.DeleteAutomationRequest(
        name="name_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.DeleteAutomationRequest, dict]]) – The request object. The request object for DeleteAutomation.
name (str) –
Required. The name of the Automation to delete. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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);

}

Return type

google.api_core.operation_async.AsyncOperation

async delete_custom_target_type(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.DeleteCustomTargetTypeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes a single CustomTargetType.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_delete_custom_target_type():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.DeleteCustomTargetTypeRequest(
        name="name_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.DeleteCustomTargetTypeRequest, dict]]) – The request object. The request object for DeleteCustomTargetType.
name (str) –
Required. The name of the CustomTargetType to delete. Format must be projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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);

}

Return type

google.api_core.operation_async.AsyncOperation

async delete_delivery_pipeline(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.DeleteDeliveryPipelineRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes a single DeliveryPipeline.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_delete_delivery_pipeline():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.DeleteDeliveryPipelineRequest(
        name="name_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.DeleteDeliveryPipelineRequest, dict]]) – The request object. The request object for DeleteDeliveryPipeline.
name (str) –
Required. The name of the DeliveryPipeline to delete. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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);

}

Return type

google.api_core.operation_async.AsyncOperation

async delete_deploy_policy(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.DeleteDeployPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes a single DeployPolicy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_delete_deploy_policy():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.DeleteDeployPolicyRequest(
        name="name_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.DeleteDeployPolicyRequest, dict]]) – The request object. The request object for DeleteDeployPolicy.
name (str) –
Required. The name of the DeployPolicy to delete. The format is projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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);

}

Return type

google.api_core.operation_async.AsyncOperation

async delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

request (DeleteOperationRequest) – The request object. Request message for DeleteOperation method.
retry (google.api_core.retry_async.AsyncRetry) – 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

None

async delete_target(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.DeleteTargetRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Deletes a single Target.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_delete_target():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.DeleteTargetRequest(
        name="name_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.DeleteTargetRequest, dict]]) – The request object. The request object for DeleteTarget.
name (str) –
Required. The name of the Target to delete. The format is projects/{project_id}/locations/{location_name}/targets/{target_name}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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);

}

Return type

google.api_core.operation_async.AsyncOperation

static delivery_pipeline_path(project: str, location: str, delivery_pipeline: str) → str¶: Returns a fully-qualified delivery_pipeline string.

static deploy_policy_path(project: str, location: str, deploy_policy: str) → str¶: Returns a fully-qualified deploy_policy string.

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

CloudDeployAsyncClient

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

CloudDeployAsyncClient

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

CloudDeployAsyncClient

async get_automation(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetAutomationRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.Automation[source]¶

Gets details of a single Automation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_get_automation():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.GetAutomationRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.GetAutomationRequest, dict]]) – The request object. The request object for GetAutomation
name (str) –
Required. Name of the Automation. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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 Automation resource in the Cloud Deploy API.

An Automation enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.

Return type

google.cloud.deploy_v1.types.Automation

async get_automation_run(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetAutomationRunRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.AutomationRun[source]¶

Gets details of a single AutomationRun.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_get_automation_run():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.GetAutomationRunRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.GetAutomationRunRequest, dict]]) – The request object. The request object for GetAutomationRun
name (str) –
Required. Name of the AutomationRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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 AutomationRun resource in the Cloud Deploy API.

An AutomationRun represents an execution instance of an automation rule.

Return type

google.cloud.deploy_v1.types.AutomationRun

async get_config(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.Config[source]¶

Gets the configuration for a location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_get_config():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.GetConfigRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.GetConfigRequest, dict]]) – The request object. Request to get a configuration.
name (str) –
Required. Name of requested configuration.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

Service-wide configuration.

Return type

google.cloud.deploy_v1.types.Config

async get_custom_target_type(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetCustomTargetTypeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.CustomTargetType[source]¶

Gets details of a single CustomTargetType.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_get_custom_target_type():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.GetCustomTargetTypeRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.GetCustomTargetTypeRequest, dict]]) – The request object. The request object for GetCustomTargetType.
name (str) –
Required. Name of the CustomTargetType. Format must be projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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 CustomTargetType resource in the Cloud Deploy API.

A CustomTargetType defines a type of custom target that can be referenced in a Target in order to facilitate deploying to other systems besides the supported runtimes.

Return type

google.cloud.deploy_v1.types.CustomTargetType

async get_delivery_pipeline(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetDeliveryPipelineRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.DeliveryPipeline[source]¶

Gets details of a single DeliveryPipeline.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_get_delivery_pipeline():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.GetDeliveryPipelineRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.GetDeliveryPipelineRequest, dict]]) – The request object. The request object for GetDeliveryPipeline
name (str) –
Required. Name of the DeliveryPipeline. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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 DeliveryPipeline resource in the Cloud Deploy API.

A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.

Return type

google.cloud.deploy_v1.types.DeliveryPipeline

async get_deploy_policy(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetDeployPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.DeployPolicy[source]¶

Gets details of a single DeployPolicy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_get_deploy_policy():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.GetDeployPolicyRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.GetDeployPolicyRequest, dict]]) – The request object. The request object for GetDeployPolicy
name (str) –
Required. Name of the DeployPolicy. Format must be projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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 DeployPolicy resource in the Cloud Deploy API.

A DeployPolicy inhibits manual or automation-driven actions within a Delivery Pipeline or Target.

Return type

google.cloud.deploy_v1.types.DeployPolicy

async get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.policy_pb2.Policy[source]¶

Gets the IAM access control policy for a function.

Returns an empty policy if the function exists and does not have a policy set.

Parameters

request (GetIamPolicyRequest) – The request object. Request message for GetIamPolicy method.
retry (google.api_core.retry_async.AsyncRetry) – 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

Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.

JSON Example

{
  "bindings": [
    {
      "role": "roles/resourcemanager.organizationAdmin",
      "members": [
        "user:mike@example.com",
        "group:admins@example.com",
        "domain:google.com",
        "serviceAccount:my-project-id@appspot.gserviceaccount.com"
      ]
    },
    {
      "role": "roles/resourcemanager.organizationViewer",
      "members": ["user:eve@example.com"],
      "condition": {
        "title": "expirable access",
        "description": "Does not grant access after Sep 2020",
        "expression": "request.time <
        timestamp('2020-10-01T00:00:00.000Z')",
      }
    }
  ]
}

YAML Example

bindings:
- members:
  - user:mike@example.com
  - group:admins@example.com
  - domain:google.com
  - serviceAccount:my-project-id@appspot.gserviceaccount.com
  role: roles/resourcemanager.organizationAdmin
- members:
  - user:eve@example.com
  role: roles/resourcemanager.organizationViewer
  condition:
    title: expirable access
    description: Does not grant access after Sep 2020
    expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

For a description of IAM and its features, see the IAM developer’s guide.

Return type

Policy

async get_job_run(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetJobRunRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.JobRun[source]¶

Gets details of a single JobRun.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_get_job_run():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.GetJobRunRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.GetJobRunRequest, dict]]) – The request object. GetJobRunRequest is the request object used by GetJobRun.
name (str) –
Required. Name of the JobRun. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}/jobRuns/{job_run_name}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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 JobRun resource in the Cloud Deploy API.

A JobRun contains information of a single Rollout job evaluation.

Return type

google.cloud.deploy_v1.types.JobRun

async get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (GetLocationRequest) – The request object. Request message for GetLocation method.
retry (google.api_core.retry_async.AsyncRetry) – 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

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
retry (google.api_core.retry_async.AsyncRetry) – 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 Operation object.

Return type

Operation

async get_release(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetReleaseRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.Release[source]¶

Gets details of a single Release.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_get_release():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.GetReleaseRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.GetReleaseRequest, dict]]) – The request object. The request object for GetRelease.
name (str) –
Required. Name of the Release. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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 Release resource in the Cloud Deploy API.

A Release defines a specific Skaffold configuration instance that can be deployed.

Return type

google.cloud.deploy_v1.types.Release

async get_rollout(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetRolloutRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.Rollout[source]¶

Gets details of a single Rollout.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_get_rollout():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.GetRolloutRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.GetRolloutRequest, dict]]) – The request object. GetRolloutRequest is the request object used by GetRollout.
name (str) –
Required. Name of the Rollout. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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 Rollout resource in the Cloud Deploy API.

A Rollout contains information around a specific deployment to a Target.

Return type

google.cloud.deploy_v1.types.Rollout

async get_target(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetTargetRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.Target[source]¶

Gets details of a single Target.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_get_target():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.GetTargetRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.GetTargetRequest, dict]]) – The request object. The request object for GetTarget.
name (str) –
Required. Name of the Target. Format must be projects/{project_id}/locations/{location_name}/targets/{target_name}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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 Target resource in the Cloud Deploy API.

A Target defines a location to which a Skaffold configuration can be deployed.

Return type

google.cloud.deploy_v1.types.Target

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.deploy_v1.services.cloud_deploy.transports.base.CloudDeployTransport]¶

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 ignore_job(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.IgnoreJobRequest, dict]] = None, *, rollout: Optional[str] = None, phase_id: Optional[str] = None, job_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.IgnoreJobResponse[source]¶

Ignores the specified Job in a Rollout.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_ignore_job():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.IgnoreJobRequest(
        rollout="rollout_value",
        phase_id="phase_id_value",
        job_id="job_id_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.IgnoreJobRequest, dict]]) – The request object. The request object used by IgnoreJob.
rollout (str) –
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

This corresponds to the rollout field on the request instance; if request is provided, this should not be set.
phase_id (str) –
Required. The phase ID the Job to ignore belongs to.

This corresponds to the phase_id field on the request instance; if request is provided, this should not be set.
job_id (str) –
Required. The job ID for the Job to ignore.

This corresponds to the job_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response object from IgnoreJob.

Return type

google.cloud.deploy_v1.types.IgnoreJobResponse

static job_path(project: str, location: str, job: str) → str¶: Returns a fully-qualified job string.

static job_run_path(project: str, location: str, delivery_pipeline: str, release: str, rollout: str, job_run: str) → str¶: Returns a fully-qualified job_run string.

async list_automation_runs(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListAutomationRunsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListAutomationRunsAsyncPager[source]¶

Lists AutomationRuns in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_list_automation_runs():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.ListAutomationRunsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.ListAutomationRunsRequest, dict]]) – The request object. The request object for ListAutomationRuns.
parent (str) –
Required. The parent Delivery Pipeline, which owns this collection of automationRuns. Format must be projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response object from ListAutomationRuns.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListAutomationRunsAsyncPager

async list_automations(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListAutomationsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListAutomationsAsyncPager[source]¶

Lists Automations in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_list_automations():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.ListAutomationsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.ListAutomationsRequest, dict]]) – The request object. The request object for ListAutomations.
parent (str) –
Required. The parent Delivery Pipeline, which owns this collection of automations. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response object from ListAutomations.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListAutomationsAsyncPager

async list_custom_target_types(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListCustomTargetTypesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListCustomTargetTypesAsyncPager[source]¶

Lists CustomTargetTypes in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_list_custom_target_types():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.ListCustomTargetTypesRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.ListCustomTargetTypesRequest, dict]]) – The request object. The request object for ListCustomTargetTypes.
parent (str) –
Required. The parent that owns this collection of custom target types. Format must be projects/{project_id}/locations/{location_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response object from ListCustomTargetTypes.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListCustomTargetTypesAsyncPager

async list_delivery_pipelines(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListDeliveryPipelinesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListDeliveryPipelinesAsyncPager[source]¶

Lists DeliveryPipelines in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_list_delivery_pipelines():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.ListDeliveryPipelinesRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.ListDeliveryPipelinesRequest, dict]]) – The request object. The request object for ListDeliveryPipelines.
parent (str) –
Required. The parent, which owns this collection of pipelines. Format must be projects/{project_id}/locations/{location_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response object from ListDeliveryPipelines.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListDeliveryPipelinesAsyncPager

async list_deploy_policies(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListDeployPoliciesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListDeployPoliciesAsyncPager[source]¶

Lists DeployPolicies in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_list_deploy_policies():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.ListDeployPoliciesRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.ListDeployPoliciesRequest, dict]]) – The request object. The request object for ListDeployPolicies.
parent (str) –
Required. The parent, which owns this collection of deploy policies. Format must be projects/{project_id}/locations/{location_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response object from ListDeployPolicies.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListDeployPoliciesAsyncPager

async list_job_runs(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListJobRunsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListJobRunsAsyncPager[source]¶

Lists JobRuns in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_list_job_runs():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.ListJobRunsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.ListJobRunsRequest, dict]]) – The request object. ListJobRunsRequest is the request object used by ListJobRuns.
parent (str) –
Required. The Rollout which owns this collection of JobRun objects.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

ListJobRunsResponse is the response object returned by ListJobRuns.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListJobRunsAsyncPager

async list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations method.
retry (google.api_core.retry_async.AsyncRetry) – 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 message for ListLocations method.

Return type

ListLocationsResponse

async list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations method.
retry (google.api_core.retry_async.AsyncRetry) – 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 message for ListOperations method.

Return type

ListOperationsResponse

async list_releases(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListReleasesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListReleasesAsyncPager[source]¶

Lists Releases in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_list_releases():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.ListReleasesRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.ListReleasesRequest, dict]]) – The request object. The request object for ListReleases.
parent (str) –
Required. The DeliveryPipeline which owns this collection of Release objects.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response object from ListReleases.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListReleasesAsyncPager

async list_rollouts(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListRolloutsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListRolloutsAsyncPager[source]¶

Lists Rollouts in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_list_rollouts():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.ListRolloutsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.ListRolloutsRequest, dict]]) – The request object. ListRolloutsRequest is the request object used by ListRollouts.
parent (str) –
Required. The Release which owns this collection of Rollout objects.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

ListRolloutsResponse is the response object reutrned by ListRollouts.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListRolloutsAsyncPager

async list_targets(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListTargetsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListTargetsAsyncPager[source]¶

Lists Targets in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_list_targets():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.ListTargetsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.ListTargetsRequest, dict]]) – The request object. The request object for ListTargets.
parent (str) –
Required. The parent, which owns this collection of targets. Format must be projects/{project_id}/locations/{location_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response object from ListTargets.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListTargetsAsyncPager

static membership_path(project: str, location: str, membership: str) → str¶: Returns a fully-qualified membership string.

static parse_automation_path(path: str) → Dict[str, str]¶: Parses a automation path into its component segments.

static parse_automation_run_path(path: str) → Dict[str, str]¶: Parses a automation_run path into its component segments.

static parse_build_path(path: str) → Dict[str, str]¶: Parses a build path into its component segments.

static parse_cluster_path(path: str) → Dict[str, str]¶: Parses a cluster 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_config_path(path: str) → Dict[str, str]¶: Parses a config path into its component segments.

static parse_custom_target_type_path(path: str) → Dict[str, str]¶: Parses a custom_target_type path into its component segments.

static parse_delivery_pipeline_path(path: str) → Dict[str, str]¶: Parses a delivery_pipeline path into its component segments.

static parse_deploy_policy_path(path: str) → Dict[str, str]¶: Parses a deploy_policy path into its component segments.

static parse_job_path(path: str) → Dict[str, str]¶: Parses a job path into its component segments.

static parse_job_run_path(path: str) → Dict[str, str]¶: Parses a job_run path into its component segments.

static parse_membership_path(path: str) → Dict[str, str]¶: Parses a membership path into its component segments.

static parse_release_path(path: str) → Dict[str, str]¶: Parses a release path into its component segments.

static parse_repository_path(path: str) → Dict[str, str]¶: Parses a repository path into its component segments.

static parse_rollout_path(path: str) → Dict[str, str]¶: Parses a rollout path into its component segments.

static parse_service_path(path: str) → Dict[str, str]¶: Parses a service path into its component segments.

static parse_target_path(path: str) → Dict[str, str]¶: Parses a target path into its component segments.

static parse_worker_pool_path(path: str) → Dict[str, str]¶: Parses a worker_pool path into its component segments.

static release_path(project: str, location: str, delivery_pipeline: str, release: str) → str¶: Returns a fully-qualified release string.

static repository_path(project: str, location: str, connection: str, repository: str) → str¶: Returns a fully-qualified repository string.

async retry_job(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.RetryJobRequest, dict]] = None, *, rollout: Optional[str] = None, phase_id: Optional[str] = None, job_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.RetryJobResponse[source]¶

Retries the specified Job in a Rollout.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_retry_job():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.RetryJobRequest(
        rollout="rollout_value",
        phase_id="phase_id_value",
        job_id="job_id_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.RetryJobRequest, dict]]) – The request object. RetryJobRequest is the request object used by RetryJob.
rollout (str) –
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

This corresponds to the rollout field on the request instance; if request is provided, this should not be set.
phase_id (str) –
Required. The phase ID the Job to retry belongs to.

This corresponds to the phase_id field on the request instance; if request is provided, this should not be set.
job_id (str) –
Required. The job ID for the Job to retry.

This corresponds to the job_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response object from ‘RetryJob’.

Return type

google.cloud.deploy_v1.types.RetryJobResponse

async rollback_target(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.RollbackTargetRequest, dict]] = None, *, name: Optional[str] = None, target_id: Optional[str] = None, rollout_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.RollbackTargetResponse[source]¶

Creates a Rollout to roll back the specified target.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_rollback_target():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.RollbackTargetRequest(
        name="name_value",
        target_id="target_id_value",
        rollout_id="rollout_id_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.RollbackTargetRequest, dict]]) – The request object. The request object for RollbackTarget.
name (str) –
Required. The DeliveryPipeline for which the rollback Rollout must be created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
target_id (str) –
Required. ID of the Target that is being rolled back.

This corresponds to the target_id field on the request instance; if request is provided, this should not be set.
rollout_id (str) – Required. ID of the rollback Rollout to create. This corresponds to the rollout_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response object from RollbackTarget.

Return type

google.cloud.deploy_v1.types.RollbackTargetResponse

static rollout_path(project: str, location: str, delivery_pipeline: str, release: str, rollout: str) → str¶: Returns a fully-qualified rollout string.

static service_path(project: str, location: str, service: str) → str¶: Returns a fully-qualified service string.

async set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.policy_pb2.Policy[source]¶

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters

request (SetIamPolicyRequest) – The request object. Request message for SetIamPolicy method.
retry (google.api_core.retry_async.AsyncRetry) – 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

Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.

JSON Example

{
  "bindings": [
    {
      "role": "roles/resourcemanager.organizationAdmin",
      "members": [
        "user:mike@example.com",
        "group:admins@example.com",
        "domain:google.com",
        "serviceAccount:my-project-id@appspot.gserviceaccount.com"
      ]
    },
    {
      "role": "roles/resourcemanager.organizationViewer",
      "members": ["user:eve@example.com"],
      "condition": {
        "title": "expirable access",
        "description": "Does not grant access after Sep 2020",
        "expression": "request.time <
        timestamp('2020-10-01T00:00:00.000Z')",
      }
    }
  ]
}

YAML Example

bindings:
- members:
  - user:mike@example.com
  - group:admins@example.com
  - domain:google.com
  - serviceAccount:my-project-id@appspot.gserviceaccount.com
  role: roles/resourcemanager.organizationAdmin
- members:
  - user:eve@example.com
  role: roles/resourcemanager.organizationViewer
  condition:
    title: expirable access
    description: Does not grant access after Sep 2020
    expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

For a description of IAM and its features, see the IAM developer’s guide.

Return type

Policy

static target_path(project: str, location: str, target: str) → str¶: Returns a fully-qualified target string.

async terminate_job_run(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.TerminateJobRunRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.TerminateJobRunResponse[source]¶

Terminates a Job Run in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_terminate_job_run():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.TerminateJobRunRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.TerminateJobRunRequest, dict]]) – The request object. The request object used by TerminateJobRun.
name (str) –
Required. Name of the JobRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The response object from TerminateJobRun.

Return type

google.cloud.deploy_v1.types.TerminateJobRunResponse

async test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse[source]¶

Tests the specified IAM permissions against the IAM access control: policy for a function.

If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Parameters

request (TestIamPermissionsRequest) – The request object. Request message for TestIamPermissions method.
retry (google.api_core.retry_async.AsyncRetry) – 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 message for TestIamPermissions method.

Return type

TestIamPermissionsResponse

property transport: google.cloud.deploy_v1.services.cloud_deploy.transports.base.CloudDeployTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: CloudDeployTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_automation(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.UpdateAutomationRequest, dict]] = None, *, automation: Optional[google.cloud.deploy_v1.types.cloud_deploy.Automation] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Updates the parameters of a single Automation resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_update_automation():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    automation = deploy_v1.Automation()
    automation.service_account = "service_account_value"
    automation.rules.promote_release_rule.id = "id_value"

    request = deploy_v1.UpdateAutomationRequest(
        automation=automation,
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.UpdateAutomationRequest, dict]]) – The request object. The request object for UpdateAutomation.
automation (google.cloud.deploy_v1.types.Automation) – Required. The Automation to update. This corresponds to the automation field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. Field mask is used to specify the fields to be overwritten by the update in the Automation resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it’s in the mask. If the user doesn’t provide a mask then all fields are overwritten.

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_async.AsyncRetry) – 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.deploy_v1.types.Automation An Automation resource in the Cloud Deploy API.

An Automation enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.

Return type

google.api_core.operation_async.AsyncOperation

async update_custom_target_type(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.UpdateCustomTargetTypeRequest, dict]] = None, *, custom_target_type: Optional[google.cloud.deploy_v1.types.cloud_deploy.CustomTargetType] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Updates a single CustomTargetType.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_update_custom_target_type():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    custom_target_type = deploy_v1.CustomTargetType()
    custom_target_type.custom_actions.deploy_action = "deploy_action_value"

    request = deploy_v1.UpdateCustomTargetTypeRequest(
        custom_target_type=custom_target_type,
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.UpdateCustomTargetTypeRequest, dict]]) – The request object. The request object for UpdateCustomTargetType.
custom_target_type (google.cloud.deploy_v1.types.CustomTargetType) – Required. The CustomTargetType to update. This corresponds to the custom_target_type field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. Field mask is used to specify the fields to be overwritten by the update in the CustomTargetType resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it’s in the mask. If the user doesn’t provide a mask then all fields are overwritten.

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_async.AsyncRetry) – 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.deploy_v1.types.CustomTargetType A CustomTargetType resource in the Cloud Deploy API.

A CustomTargetType defines a type of custom target that can be referenced in a Target in order to facilitate deploying to other systems besides the supported runtimes.

Return type

google.api_core.operation_async.AsyncOperation

async update_delivery_pipeline(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.UpdateDeliveryPipelineRequest, dict]] = None, *, delivery_pipeline: Optional[google.cloud.deploy_v1.types.cloud_deploy.DeliveryPipeline] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Updates the parameters of a single DeliveryPipeline.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_update_delivery_pipeline():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.UpdateDeliveryPipelineRequest(
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.UpdateDeliveryPipelineRequest, dict]]) – The request object. The request object for UpdateDeliveryPipeline.
delivery_pipeline (google.cloud.deploy_v1.types.DeliveryPipeline) – Required. The DeliveryPipeline to update. This corresponds to the delivery_pipeline field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. Field mask is used to specify the fields to be overwritten by the update in the DeliveryPipeline resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it’s in the mask. If the user doesn’t provide a mask then all fields are overwritten.

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_async.AsyncRetry) – 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.deploy_v1.types.DeliveryPipeline A DeliveryPipeline resource in the Cloud Deploy API.

A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.

Return type

google.api_core.operation_async.AsyncOperation

async update_deploy_policy(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.UpdateDeployPolicyRequest, dict]] = None, *, deploy_policy: Optional[google.cloud.deploy_v1.types.cloud_deploy.DeployPolicy] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Updates the parameters of a single DeployPolicy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_update_deploy_policy():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    deploy_policy = deploy_v1.DeployPolicy()
    deploy_policy.rules.rollout_restriction.id = "id_value"
    deploy_policy.rules.rollout_restriction.time_windows.time_zone = "time_zone_value"

    request = deploy_v1.UpdateDeployPolicyRequest(
        deploy_policy=deploy_policy,
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.UpdateDeployPolicyRequest, dict]]) – The request object. The request object for UpdateDeployPolicy.
deploy_policy (google.cloud.deploy_v1.types.DeployPolicy) – Required. The DeployPolicy to update. This corresponds to the deploy_policy field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. Field mask is used to specify the fields to be overwritten by the update in the DeployPolicy resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it’s in the mask. If the user doesn’t provide a mask then all fields are overwritten.

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_async.AsyncRetry) – 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.deploy_v1.types.DeployPolicy A DeployPolicy resource in the Cloud Deploy API.

A DeployPolicy inhibits manual or automation-driven actions within a Delivery Pipeline or Target.

Return type

google.api_core.operation_async.AsyncOperation

async update_target(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.UpdateTargetRequest, dict]] = None, *, target: Optional[google.cloud.deploy_v1.types.cloud_deploy.Target] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Updates the parameters of a single Target.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

async def sample_update_target():
    # Create a client
    client = deploy_v1.CloudDeployAsyncClient()

    # Initialize request argument(s)
    request = deploy_v1.UpdateTargetRequest(
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.deploy_v1.types.UpdateTargetRequest, dict]]) – The request object. The request object for UpdateTarget.
target (google.cloud.deploy_v1.types.Target) – Required. The Target to update. This corresponds to the target field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. Field mask is used to specify the fields to be overwritten by the update in the Target resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it’s in the mask. If the user doesn’t provide a mask then all fields are overwritten.

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_async.AsyncRetry) – 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.deploy_v1.types.Target A Target resource in the Cloud Deploy API.

A Target defines a location to which a Skaffold configuration can be deployed.

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.deploy_v1.services.cloud_deploy.CloudDeployClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.deploy_v1.services.cloud_deploy.transports.base.CloudDeployTransport, typing.Callable[[...], google.cloud.deploy_v1.services.cloud_deploy.transports.base.CloudDeployTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

CloudDeploy service creates and manages Continuous Delivery operations on Google Cloud Platform via Skaffold (https://skaffold.dev).

Instantiates the cloud deploy 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 (Optional[Union[str,CloudDeployTransport,Callable[..., CloudDeployTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the CloudDeployTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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!

abandon_release(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.AbandonReleaseRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.AbandonReleaseResponse[source]¶

Abandons a Release in the Delivery Pipeline.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_abandon_release():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.AbandonReleaseRequest(
        name="name_value",
    )

    # Make the request
    response = client.abandon_release(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.AbandonReleaseRequest, dict]) – The request object. The request object used by AbandonRelease.
name (str) –
Required. Name of the Release. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}.

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

The response object for AbandonRelease.

Return type

google.cloud.deploy_v1.types.AbandonReleaseResponse

advance_rollout(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.AdvanceRolloutRequest, dict]] = None, *, name: Optional[str] = None, phase_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.AdvanceRolloutResponse[source]¶

Advances a Rollout in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_advance_rollout():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.AdvanceRolloutRequest(
        name="name_value",
        phase_id="phase_id_value",
    )

    # Make the request
    response = client.advance_rollout(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.AdvanceRolloutRequest, dict]) – The request object. The request object used by AdvanceRollout.
name (str) –
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
phase_id (str) – Required. The phase ID to advance the Rollout to. This corresponds to the phase_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

The response object from AdvanceRollout.

Return type

google.cloud.deploy_v1.types.AdvanceRolloutResponse

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

approve_rollout(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ApproveRolloutRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.ApproveRolloutResponse[source]¶

Approves a Rollout.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_approve_rollout():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.ApproveRolloutRequest(
        name="name_value",
        approved=True,
    )

    # Make the request
    response = client.approve_rollout(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.ApproveRolloutRequest, dict]) – The request object. The request object used by ApproveRollout.
name (str) –
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

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

The response object from ApproveRollout.

Return type

google.cloud.deploy_v1.types.ApproveRolloutResponse

static automation_path(project: str, location: str, delivery_pipeline: str, automation: str) → str[source]¶: Returns a fully-qualified automation string.

static automation_run_path(project: str, location: str, delivery_pipeline: str, automation_run: str) → str[source]¶: Returns a fully-qualified automation_run string.

static build_path(project: str, location: str, build: str) → str[source]¶: Returns a fully-qualified build string.

cancel_automation_run(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CancelAutomationRunRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.CancelAutomationRunResponse[source]¶

Cancels an AutomationRun. The state of the AutomationRun after cancelling is CANCELLED. CancelAutomationRun can be called on AutomationRun in the state IN_PROGRESS and PENDING; AutomationRun in a different state returns an FAILED_PRECONDITION error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_cancel_automation_run():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.CancelAutomationRunRequest(
        name="name_value",
    )

    # Make the request
    response = client.cancel_automation_run(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.CancelAutomationRunRequest, dict]) – The request object. The request object used by CancelAutomationRun.
name (str) –
Required. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

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

The response object from CancelAutomationRun.

Return type

google.cloud.deploy_v1.types.CancelAutomationRunResponse

cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

request (CancelOperationRequest) – The request object. Request message for CancelOperation 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

None

cancel_rollout(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CancelRolloutRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.CancelRolloutResponse[source]¶

Cancels a Rollout in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_cancel_rollout():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.CancelRolloutRequest(
        name="name_value",
    )

    # Make the request
    response = client.cancel_rollout(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.CancelRolloutRequest, dict]) – The request object. The request object used by CancelRollout.
name (str) –
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

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

The response object from CancelRollout.

Return type

google.cloud.deploy_v1.types.CancelRolloutResponse

static cluster_path(project: str, location: str, cluster: str) → str[source]¶: Returns a fully-qualified cluster string.

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder 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.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

static config_path(project: str, location: str) → str[source]¶: Returns a fully-qualified config string.

create_automation(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateAutomationRequest, dict]] = None, *, parent: Optional[str] = None, automation: Optional[google.cloud.deploy_v1.types.cloud_deploy.Automation] = None, automation_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a new Automation in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_create_automation():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    automation = deploy_v1.Automation()
    automation.service_account = "service_account_value"
    automation.rules.promote_release_rule.id = "id_value"

    request = deploy_v1.CreateAutomationRequest(
        parent="parent_value",
        automation_id="automation_id_value",
        automation=automation,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.CreateAutomationRequest, dict]) – The request object. The request object for CreateAutomation.
parent (str) –
Required. The parent collection in which the Automation must be created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
automation (google.cloud.deploy_v1.types.Automation) – Required. The Automation to create. This corresponds to the automation field on the request instance; if request is provided, this should not be set.
automation_id (str) – Required. ID of the Automation. This corresponds to the automation_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

An object representing a long-running operation.

The result type for the operation will be google.cloud.deploy_v1.types.Automation An Automation resource in the Cloud Deploy API.

An Automation enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.

Return type

google.api_core.operation.Operation

create_custom_target_type(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateCustomTargetTypeRequest, dict]] = None, *, parent: Optional[str] = None, custom_target_type: Optional[google.cloud.deploy_v1.types.cloud_deploy.CustomTargetType] = None, custom_target_type_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a new CustomTargetType in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_create_custom_target_type():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    custom_target_type = deploy_v1.CustomTargetType()
    custom_target_type.custom_actions.deploy_action = "deploy_action_value"

    request = deploy_v1.CreateCustomTargetTypeRequest(
        parent="parent_value",
        custom_target_type_id="custom_target_type_id_value",
        custom_target_type=custom_target_type,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.CreateCustomTargetTypeRequest, dict]) – The request object. The request object for CreateCustomTargetType.
parent (str) –
Required. The parent collection in which the CustomTargetType must be created. The format is projects/{project_id}/locations/{location_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
custom_target_type (google.cloud.deploy_v1.types.CustomTargetType) – Required. The CustomTargetType to create. This corresponds to the custom_target_type field on the request instance; if request is provided, this should not be set.
custom_target_type_id (str) – Required. ID of the CustomTargetType. This corresponds to the custom_target_type_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

An object representing a long-running operation.

The result type for the operation will be google.cloud.deploy_v1.types.CustomTargetType A CustomTargetType resource in the Cloud Deploy API.

A CustomTargetType defines a type of custom target that can be referenced in a Target in order to facilitate deploying to other systems besides the supported runtimes.

Return type

google.api_core.operation.Operation

create_delivery_pipeline(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateDeliveryPipelineRequest, dict]] = None, *, parent: Optional[str] = None, delivery_pipeline: Optional[google.cloud.deploy_v1.types.cloud_deploy.DeliveryPipeline] = None, delivery_pipeline_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a new DeliveryPipeline in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_create_delivery_pipeline():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.CreateDeliveryPipelineRequest(
        parent="parent_value",
        delivery_pipeline_id="delivery_pipeline_id_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.CreateDeliveryPipelineRequest, dict]) – The request object. The request object for CreateDeliveryPipeline.
parent (str) –
Required. The parent collection in which the DeliveryPipeline must be created. The format is projects/{project_id}/locations/{location_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
delivery_pipeline (google.cloud.deploy_v1.types.DeliveryPipeline) – Required. The DeliveryPipeline to create. This corresponds to the delivery_pipeline field on the request instance; if request is provided, this should not be set.
delivery_pipeline_id (str) – Required. ID of the DeliveryPipeline. This corresponds to the delivery_pipeline_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

An object representing a long-running operation.

The result type for the operation will be google.cloud.deploy_v1.types.DeliveryPipeline A DeliveryPipeline resource in the Cloud Deploy API.

A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.

Return type

google.api_core.operation.Operation

create_deploy_policy(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateDeployPolicyRequest, dict]] = None, *, parent: Optional[str] = None, deploy_policy: Optional[google.cloud.deploy_v1.types.cloud_deploy.DeployPolicy] = None, deploy_policy_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a new DeployPolicy in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_create_deploy_policy():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    deploy_policy = deploy_v1.DeployPolicy()
    deploy_policy.rules.rollout_restriction.id = "id_value"
    deploy_policy.rules.rollout_restriction.time_windows.time_zone = "time_zone_value"

    request = deploy_v1.CreateDeployPolicyRequest(
        parent="parent_value",
        deploy_policy_id="deploy_policy_id_value",
        deploy_policy=deploy_policy,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.CreateDeployPolicyRequest, dict]) – The request object. The request object for CreateDeployPolicy.
parent (str) –
Required. The parent collection in which the DeployPolicy must be created. The format is projects/{project_id}/locations/{location_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
deploy_policy (google.cloud.deploy_v1.types.DeployPolicy) – Required. The DeployPolicy to create. This corresponds to the deploy_policy field on the request instance; if request is provided, this should not be set.
deploy_policy_id (str) – Required. ID of the DeployPolicy. This corresponds to the deploy_policy_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

An object representing a long-running operation.

The result type for the operation will be google.cloud.deploy_v1.types.DeployPolicy A DeployPolicy resource in the Cloud Deploy API.

A DeployPolicy inhibits manual or automation-driven actions within a Delivery Pipeline or Target.

Return type

google.api_core.operation.Operation

create_release(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateReleaseRequest, dict]] = None, *, parent: Optional[str] = None, release: Optional[google.cloud.deploy_v1.types.cloud_deploy.Release] = None, release_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a new Release in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_create_release():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.CreateReleaseRequest(
        parent="parent_value",
        release_id="release_id_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.CreateReleaseRequest, dict]) – The request object. The request object for CreateRelease,
parent (str) –
Required. The parent collection in which the Release is created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
release (google.cloud.deploy_v1.types.Release) – Required. The Release to create. This corresponds to the release field on the request instance; if request is provided, this should not be set.
release_id (str) – Required. ID of the Release. This corresponds to the release_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

An object representing a long-running operation.

The result type for the operation will be google.cloud.deploy_v1.types.Release A Release resource in the Cloud Deploy API.

A Release defines a specific Skaffold configuration instance that can be deployed.

Return type

google.api_core.operation.Operation

create_rollout(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateRolloutRequest, dict]] = None, *, parent: Optional[str] = None, rollout: Optional[google.cloud.deploy_v1.types.cloud_deploy.Rollout] = None, rollout_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a new Rollout in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_create_rollout():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    rollout = deploy_v1.Rollout()
    rollout.target_id = "target_id_value"

    request = deploy_v1.CreateRolloutRequest(
        parent="parent_value",
        rollout_id="rollout_id_value",
        rollout=rollout,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.CreateRolloutRequest, dict]) – The request object. CreateRolloutRequest is the request object used by CreateRollout.
parent (str) –
Required. The parent collection in which the Rollout must be created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
rollout (google.cloud.deploy_v1.types.Rollout) – Required. The Rollout to create. This corresponds to the rollout field on the request instance; if request is provided, this should not be set.
rollout_id (str) – Required. ID of the Rollout. This corresponds to the rollout_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

An object representing a long-running operation.

The result type for the operation will be google.cloud.deploy_v1.types.Rollout A Rollout resource in the Cloud Deploy API.

A Rollout contains information around a specific deployment to a Target.

Return type

google.api_core.operation.Operation

create_target(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.CreateTargetRequest, dict]] = None, *, parent: Optional[str] = None, target: Optional[google.cloud.deploy_v1.types.cloud_deploy.Target] = None, target_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Creates a new Target in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_create_target():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.CreateTargetRequest(
        parent="parent_value",
        target_id="target_id_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.CreateTargetRequest, dict]) – The request object. The request object for CreateTarget.
parent (str) –
Required. The parent collection in which the Target must be created. The format is projects/{project_id}/locations/{location_name}.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
target (google.cloud.deploy_v1.types.Target) – Required. The Target to create. This corresponds to the target field on the request instance; if request is provided, this should not be set.
target_id (str) – Required. ID of the Target. This corresponds to the target_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

An object representing a long-running operation.

The result type for the operation will be google.cloud.deploy_v1.types.Target A Target resource in the Cloud Deploy API.

A Target defines a location to which a Skaffold configuration can be deployed.

Return type

google.api_core.operation.Operation

static custom_target_type_path(project: str, location: str, custom_target_type: str) → str[source]¶: Returns a fully-qualified custom_target_type string.

delete_automation(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.DeleteAutomationRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes a single Automation resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_delete_automation():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.DeleteAutomationRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.DeleteAutomationRequest, dict]) – The request object. The request object for DeleteAutomation.
name (str) –
Required. The name of the Automation to delete. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}.

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

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

}

Return type

google.api_core.operation.Operation

delete_custom_target_type(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.DeleteCustomTargetTypeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes a single CustomTargetType.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_delete_custom_target_type():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.DeleteCustomTargetTypeRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.DeleteCustomTargetTypeRequest, dict]) – The request object. The request object for DeleteCustomTargetType.
name (str) –
Required. The name of the CustomTargetType to delete. Format must be projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}.

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

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

}

Return type

google.api_core.operation.Operation

delete_delivery_pipeline(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.DeleteDeliveryPipelineRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes a single DeliveryPipeline.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_delete_delivery_pipeline():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.DeleteDeliveryPipelineRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.DeleteDeliveryPipelineRequest, dict]) – The request object. The request object for DeleteDeliveryPipeline.
name (str) –
Required. The name of the DeliveryPipeline to delete. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

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

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

}

Return type

google.api_core.operation.Operation

delete_deploy_policy(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.DeleteDeployPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes a single DeployPolicy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_delete_deploy_policy():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.DeleteDeployPolicyRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.DeleteDeployPolicyRequest, dict]) – The request object. The request object for DeleteDeployPolicy.
name (str) –
Required. The name of the DeployPolicy to delete. The format is projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}.

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

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

}

Return type

google.api_core.operation.Operation

delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

request (DeleteOperationRequest) – The request object. Request message for DeleteOperation 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

None

delete_target(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.DeleteTargetRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Deletes a single Target.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_delete_target():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.DeleteTargetRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.DeleteTargetRequest, dict]) – The request object. The request object for DeleteTarget.
name (str) –
Required. The name of the Target to delete. The format is projects/{project_id}/locations/{location_name}/targets/{target_name}.

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

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

}

Return type

google.api_core.operation.Operation

static delivery_pipeline_path(project: str, location: str, delivery_pipeline: str) → str[source]¶: Returns a fully-qualified delivery_pipeline string.

static deploy_policy_path(project: str, location: str, deploy_policy: str) → str[source]¶: Returns a fully-qualified deploy_policy string.

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

CloudDeployClient

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

CloudDeployClient

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

CloudDeployClient

get_automation(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetAutomationRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.Automation[source]¶

Gets details of a single Automation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_get_automation():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.GetAutomationRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_automation(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.GetAutomationRequest, dict]) – The request object. The request object for GetAutomation
name (str) –
Required. Name of the Automation. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}.

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

An Automation resource in the Cloud Deploy API.

An Automation enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.

Return type

google.cloud.deploy_v1.types.Automation

get_automation_run(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetAutomationRunRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.AutomationRun[source]¶

Gets details of a single AutomationRun.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_get_automation_run():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.GetAutomationRunRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_automation_run(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.GetAutomationRunRequest, dict]) – The request object. The request object for GetAutomationRun
name (str) –
Required. Name of the AutomationRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

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

An AutomationRun resource in the Cloud Deploy API.

An AutomationRun represents an execution instance of an automation rule.

Return type

google.cloud.deploy_v1.types.AutomationRun

get_config(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.Config[source]¶

Gets the configuration for a location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_get_config():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.GetConfigRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_config(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.GetConfigRequest, dict]) – The request object. Request to get a configuration.
name (str) –
Required. Name of requested configuration.

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

Service-wide configuration.

Return type

google.cloud.deploy_v1.types.Config

get_custom_target_type(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetCustomTargetTypeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.CustomTargetType[source]¶

Gets details of a single CustomTargetType.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_get_custom_target_type():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.GetCustomTargetTypeRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_custom_target_type(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.GetCustomTargetTypeRequest, dict]) – The request object. The request object for GetCustomTargetType.
name (str) –
Required. Name of the CustomTargetType. Format must be projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}.

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

A CustomTargetType resource in the Cloud Deploy API.

A CustomTargetType defines a type of custom target that can be referenced in a Target in order to facilitate deploying to other systems besides the supported runtimes.

Return type

google.cloud.deploy_v1.types.CustomTargetType

get_delivery_pipeline(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetDeliveryPipelineRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.DeliveryPipeline[source]¶

Gets details of a single DeliveryPipeline.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_get_delivery_pipeline():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.GetDeliveryPipelineRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_delivery_pipeline(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.GetDeliveryPipelineRequest, dict]) – The request object. The request object for GetDeliveryPipeline
name (str) –
Required. Name of the DeliveryPipeline. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

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

A DeliveryPipeline resource in the Cloud Deploy API.

A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.

Return type

google.cloud.deploy_v1.types.DeliveryPipeline

get_deploy_policy(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetDeployPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.DeployPolicy[source]¶

Gets details of a single DeployPolicy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_get_deploy_policy():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.GetDeployPolicyRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_deploy_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.GetDeployPolicyRequest, dict]) – The request object. The request object for GetDeployPolicy
name (str) –
Required. Name of the DeployPolicy. Format must be projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}.

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

A DeployPolicy resource in the Cloud Deploy API.

A DeployPolicy inhibits manual or automation-driven actions within a Delivery Pipeline or Target.

Return type

google.cloud.deploy_v1.types.DeployPolicy

get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.policy_pb2.Policy[source]¶

Gets the IAM access control policy for a function.

Returns an empty policy if the function exists and does not have a policy set.

Parameters

request (GetIamPolicyRequest) – The request object. Request message for GetIamPolicy 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

Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.

JSON Example

{
  "bindings": [
    {
      "role": "roles/resourcemanager.organizationAdmin",
      "members": [
        "user:mike@example.com",
        "group:admins@example.com",
        "domain:google.com",
        "serviceAccount:my-project-id@appspot.gserviceaccount.com"
      ]
    },
    {
      "role": "roles/resourcemanager.organizationViewer",
      "members": ["user:eve@example.com"],
      "condition": {
        "title": "expirable access",
        "description": "Does not grant access after Sep 2020",
        "expression": "request.time <
        timestamp('2020-10-01T00:00:00.000Z')",
      }
    }
  ]
}

YAML Example

bindings:
- members:
  - user:mike@example.com
  - group:admins@example.com
  - domain:google.com
  - serviceAccount:my-project-id@appspot.gserviceaccount.com
  role: roles/resourcemanager.organizationAdmin
- members:
  - user:eve@example.com
  role: roles/resourcemanager.organizationViewer
  condition:
    title: expirable access
    description: Does not grant access after Sep 2020
    expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

For a description of IAM and its features, see the IAM developer’s guide.

Return type

Policy

get_job_run(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetJobRunRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.JobRun[source]¶

Gets details of a single JobRun.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_get_job_run():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.GetJobRunRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_job_run(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.GetJobRunRequest, dict]) – The request object. GetJobRunRequest is the request object used by GetJobRun.
name (str) –
Required. Name of the JobRun. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}/jobRuns/{job_run_name}.

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

A JobRun resource in the Cloud Deploy API.

A JobRun contains information of a single Rollout job evaluation.

Return type

google.cloud.deploy_v1.types.JobRun

get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (GetLocationRequest) – The request object. Request message for GetLocation 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

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. 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 variable 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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation 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

An Operation object.

Return type

Operation

get_release(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetReleaseRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.Release[source]¶

Gets details of a single Release.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_get_release():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.GetReleaseRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_release(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.GetReleaseRequest, dict]) – The request object. The request object for GetRelease.
name (str) –
Required. Name of the Release. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.

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

A Release resource in the Cloud Deploy API.

A Release defines a specific Skaffold configuration instance that can be deployed.

Return type

google.cloud.deploy_v1.types.Release

get_rollout(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetRolloutRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.Rollout[source]¶

Gets details of a single Rollout.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_get_rollout():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.GetRolloutRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_rollout(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.GetRolloutRequest, dict]) – The request object. GetRolloutRequest is the request object used by GetRollout.
name (str) –
Required. Name of the Rollout. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}.

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

A Rollout resource in the Cloud Deploy API.

A Rollout contains information around a specific deployment to a Target.

Return type

google.cloud.deploy_v1.types.Rollout

get_target(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.GetTargetRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.Target[source]¶

Gets details of a single Target.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_get_target():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.GetTargetRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_target(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.GetTargetRequest, dict]) – The request object. The request object for GetTarget.
name (str) –
Required. Name of the Target. Format must be projects/{project_id}/locations/{location_name}/targets/{target_name}.

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

A Target resource in the Cloud Deploy API.

A Target defines a location to which a Skaffold configuration can be deployed.

Return type

google.cloud.deploy_v1.types.Target

ignore_job(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.IgnoreJobRequest, dict]] = None, *, rollout: Optional[str] = None, phase_id: Optional[str] = None, job_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.IgnoreJobResponse[source]¶

Ignores the specified Job in a Rollout.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_ignore_job():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.IgnoreJobRequest(
        rollout="rollout_value",
        phase_id="phase_id_value",
        job_id="job_id_value",
    )

    # Make the request
    response = client.ignore_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.IgnoreJobRequest, dict]) – The request object. The request object used by IgnoreJob.
rollout (str) –
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

This corresponds to the rollout field on the request instance; if request is provided, this should not be set.
phase_id (str) –
Required. The phase ID the Job to ignore belongs to.

This corresponds to the phase_id field on the request instance; if request is provided, this should not be set.
job_id (str) –
Required. The job ID for the Job to ignore.

This corresponds to the job_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

The response object from IgnoreJob.

Return type

google.cloud.deploy_v1.types.IgnoreJobResponse

static job_path(project: str, location: str, job: str) → str[source]¶: Returns a fully-qualified job string.

static job_run_path(project: str, location: str, delivery_pipeline: str, release: str, rollout: str, job_run: str) → str[source]¶: Returns a fully-qualified job_run string.

list_automation_runs(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListAutomationRunsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListAutomationRunsPager[source]¶

Lists AutomationRuns in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_list_automation_runs():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.ListAutomationRunsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Union[google.cloud.deploy_v1.types.ListAutomationRunsRequest, dict]) – The request object. The request object for ListAutomationRuns.
parent (str) –
Required. The parent Delivery Pipeline, which owns this collection of automationRuns. Format must be projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}.

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

The response object from ListAutomationRuns.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListAutomationRunsPager

list_automations(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListAutomationsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListAutomationsPager[source]¶

Lists Automations in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_list_automations():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.ListAutomationsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Union[google.cloud.deploy_v1.types.ListAutomationsRequest, dict]) – The request object. The request object for ListAutomations.
parent (str) –
Required. The parent Delivery Pipeline, which owns this collection of automations. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

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

The response object from ListAutomations.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListAutomationsPager

list_custom_target_types(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListCustomTargetTypesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListCustomTargetTypesPager[source]¶

Lists CustomTargetTypes in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_list_custom_target_types():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.ListCustomTargetTypesRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Union[google.cloud.deploy_v1.types.ListCustomTargetTypesRequest, dict]) – The request object. The request object for ListCustomTargetTypes.
parent (str) –
Required. The parent that owns this collection of custom target types. Format must be projects/{project_id}/locations/{location_name}.

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

The response object from ListCustomTargetTypes.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListCustomTargetTypesPager

list_delivery_pipelines(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListDeliveryPipelinesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListDeliveryPipelinesPager[source]¶

Lists DeliveryPipelines in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_list_delivery_pipelines():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.ListDeliveryPipelinesRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Union[google.cloud.deploy_v1.types.ListDeliveryPipelinesRequest, dict]) – The request object. The request object for ListDeliveryPipelines.
parent (str) –
Required. The parent, which owns this collection of pipelines. Format must be projects/{project_id}/locations/{location_name}.

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

The response object from ListDeliveryPipelines.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListDeliveryPipelinesPager

list_deploy_policies(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListDeployPoliciesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListDeployPoliciesPager[source]¶

Lists DeployPolicies in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_list_deploy_policies():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.ListDeployPoliciesRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Union[google.cloud.deploy_v1.types.ListDeployPoliciesRequest, dict]) – The request object. The request object for ListDeployPolicies.
parent (str) –
Required. The parent, which owns this collection of deploy policies. Format must be projects/{project_id}/locations/{location_name}.

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

The response object from ListDeployPolicies.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListDeployPoliciesPager

list_job_runs(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListJobRunsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListJobRunsPager[source]¶

Lists JobRuns in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_list_job_runs():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.ListJobRunsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Union[google.cloud.deploy_v1.types.ListJobRunsRequest, dict]) – The request object. ListJobRunsRequest is the request object used by ListJobRuns.
parent (str) –
Required. The Rollout which owns this collection of JobRun objects.

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

ListJobRunsResponse is the response object returned by ListJobRuns.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListJobRunsPager

list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations 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

Response message for ListLocations method.

Return type

ListLocationsResponse

list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations 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

Response message for ListOperations method.

Return type

ListOperationsResponse

list_releases(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListReleasesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListReleasesPager[source]¶

Lists Releases in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_list_releases():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.ListReleasesRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Union[google.cloud.deploy_v1.types.ListReleasesRequest, dict]) – The request object. The request object for ListReleases.
parent (str) –
Required. The DeliveryPipeline which owns this collection of Release objects.

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

The response object from ListReleases.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListReleasesPager

list_rollouts(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListRolloutsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListRolloutsPager[source]¶

Lists Rollouts in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_list_rollouts():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.ListRolloutsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Union[google.cloud.deploy_v1.types.ListRolloutsRequest, dict]) – The request object. ListRolloutsRequest is the request object used by ListRollouts.
parent (str) –
Required. The Release which owns this collection of Rollout objects.

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

ListRolloutsResponse is the response object reutrned by ListRollouts.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListRolloutsPager

list_targets(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.ListTargetsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.services.cloud_deploy.pagers.ListTargetsPager[source]¶

Lists Targets in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_list_targets():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.ListTargetsRequest(
        parent="parent_value",
    )

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

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

Parameters

request (Union[google.cloud.deploy_v1.types.ListTargetsRequest, dict]) – The request object. The request object for ListTargets.
parent (str) –
Required. The parent, which owns this collection of targets. Format must be projects/{project_id}/locations/{location_name}.

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

The response object from ListTargets.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.deploy_v1.services.cloud_deploy.pagers.ListTargetsPager

static membership_path(project: str, location: str, membership: str) → str[source]¶: Returns a fully-qualified membership string.

static parse_automation_path(path: str) → Dict[str, str][source]¶: Parses a automation path into its component segments.

static parse_automation_run_path(path: str) → Dict[str, str][source]¶: Parses a automation_run path into its component segments.

static parse_build_path(path: str) → Dict[str, str][source]¶: Parses a build path into its component segments.

static parse_cluster_path(path: str) → Dict[str, str][source]¶: Parses a cluster 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_config_path(path: str) → Dict[str, str][source]¶: Parses a config path into its component segments.

static parse_custom_target_type_path(path: str) → Dict[str, str][source]¶: Parses a custom_target_type path into its component segments.

static parse_delivery_pipeline_path(path: str) → Dict[str, str][source]¶: Parses a delivery_pipeline path into its component segments.

static parse_deploy_policy_path(path: str) → Dict[str, str][source]¶: Parses a deploy_policy path into its component segments.

static parse_job_path(path: str) → Dict[str, str][source]¶: Parses a job path into its component segments.

static parse_job_run_path(path: str) → Dict[str, str][source]¶: Parses a job_run path into its component segments.

static parse_membership_path(path: str) → Dict[str, str][source]¶: Parses a membership path into its component segments.

static parse_release_path(path: str) → Dict[str, str][source]¶: Parses a release path into its component segments.

static parse_repository_path(path: str) → Dict[str, str][source]¶: Parses a repository path into its component segments.

static parse_rollout_path(path: str) → Dict[str, str][source]¶: Parses a rollout path into its component segments.

static parse_service_path(path: str) → Dict[str, str][source]¶: Parses a service path into its component segments.

static parse_target_path(path: str) → Dict[str, str][source]¶: Parses a target 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.

static release_path(project: str, location: str, delivery_pipeline: str, release: str) → str[source]¶: Returns a fully-qualified release string.

static repository_path(project: str, location: str, connection: str, repository: str) → str[source]¶: Returns a fully-qualified repository string.

retry_job(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.RetryJobRequest, dict]] = None, *, rollout: Optional[str] = None, phase_id: Optional[str] = None, job_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.RetryJobResponse[source]¶

Retries the specified Job in a Rollout.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_retry_job():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.RetryJobRequest(
        rollout="rollout_value",
        phase_id="phase_id_value",
        job_id="job_id_value",
    )

    # Make the request
    response = client.retry_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.RetryJobRequest, dict]) – The request object. RetryJobRequest is the request object used by RetryJob.
rollout (str) –
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

This corresponds to the rollout field on the request instance; if request is provided, this should not be set.
phase_id (str) –
Required. The phase ID the Job to retry belongs to.

This corresponds to the phase_id field on the request instance; if request is provided, this should not be set.
job_id (str) –
Required. The job ID for the Job to retry.

This corresponds to the job_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

The response object from ‘RetryJob’.

Return type

google.cloud.deploy_v1.types.RetryJobResponse

rollback_target(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.RollbackTargetRequest, dict]] = None, *, name: Optional[str] = None, target_id: Optional[str] = None, rollout_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.RollbackTargetResponse[source]¶

Creates a Rollout to roll back the specified target.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_rollback_target():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.RollbackTargetRequest(
        name="name_value",
        target_id="target_id_value",
        rollout_id="rollout_id_value",
    )

    # Make the request
    response = client.rollback_target(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.RollbackTargetRequest, dict]) – The request object. The request object for RollbackTarget.
name (str) –
Required. The DeliveryPipeline for which the rollback Rollout must be created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
target_id (str) –
Required. ID of the Target that is being rolled back.

This corresponds to the target_id field on the request instance; if request is provided, this should not be set.
rollout_id (str) – Required. ID of the rollback Rollout to create. This corresponds to the rollout_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

The response object from RollbackTarget.

Return type

google.cloud.deploy_v1.types.RollbackTargetResponse

static rollout_path(project: str, location: str, delivery_pipeline: str, release: str, rollout: str) → str[source]¶: Returns a fully-qualified rollout string.

static service_path(project: str, location: str, service: str) → str[source]¶: Returns a fully-qualified service string.

set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.policy_pb2.Policy[source]¶

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters

request (SetIamPolicyRequest) – The request object. Request message for SetIamPolicy 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

Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.

JSON Example

{
  "bindings": [
    {
      "role": "roles/resourcemanager.organizationAdmin",
      "members": [
        "user:mike@example.com",
        "group:admins@example.com",
        "domain:google.com",
        "serviceAccount:my-project-id@appspot.gserviceaccount.com"
      ]
    },
    {
      "role": "roles/resourcemanager.organizationViewer",
      "members": ["user:eve@example.com"],
      "condition": {
        "title": "expirable access",
        "description": "Does not grant access after Sep 2020",
        "expression": "request.time <
        timestamp('2020-10-01T00:00:00.000Z')",
      }
    }
  ]
}

YAML Example

bindings:
- members:
  - user:mike@example.com
  - group:admins@example.com
  - domain:google.com
  - serviceAccount:my-project-id@appspot.gserviceaccount.com
  role: roles/resourcemanager.organizationAdmin
- members:
  - user:eve@example.com
  role: roles/resourcemanager.organizationViewer
  condition:
    title: expirable access
    description: Does not grant access after Sep 2020
    expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

For a description of IAM and its features, see the IAM developer’s guide.

Return type

Policy

static target_path(project: str, location: str, target: str) → str[source]¶: Returns a fully-qualified target string.

terminate_job_run(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.TerminateJobRunRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.deploy_v1.types.cloud_deploy.TerminateJobRunResponse[source]¶

Terminates a Job Run in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_terminate_job_run():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.TerminateJobRunRequest(
        name="name_value",
    )

    # Make the request
    response = client.terminate_job_run(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.TerminateJobRunRequest, dict]) – The request object. The request object used by TerminateJobRun.
name (str) –
Required. Name of the JobRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}.

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

The response object from TerminateJobRun.

Return type

google.cloud.deploy_v1.types.TerminateJobRunResponse

test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse[source]¶

Tests the specified IAM permissions against the IAM access control: policy for a function.

If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Parameters

request (TestIamPermissionsRequest) – The request object. Request message for TestIamPermissions 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

Response message for TestIamPermissions method.

Return type

TestIamPermissionsResponse

property transport: google.cloud.deploy_v1.services.cloud_deploy.transports.base.CloudDeployTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

CloudDeployTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_automation(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.UpdateAutomationRequest, dict]] = None, *, automation: Optional[google.cloud.deploy_v1.types.cloud_deploy.Automation] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Updates the parameters of a single Automation resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_update_automation():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    automation = deploy_v1.Automation()
    automation.service_account = "service_account_value"
    automation.rules.promote_release_rule.id = "id_value"

    request = deploy_v1.UpdateAutomationRequest(
        automation=automation,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.UpdateAutomationRequest, dict]) – The request object. The request object for UpdateAutomation.
automation (google.cloud.deploy_v1.types.Automation) – Required. The Automation to update. This corresponds to the automation field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. Field mask is used to specify the fields to be overwritten by the update in the Automation resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it’s in the mask. If the user doesn’t provide a mask then all fields are overwritten.

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

An object representing a long-running operation.

The result type for the operation will be google.cloud.deploy_v1.types.Automation An Automation resource in the Cloud Deploy API.

An Automation enables the automation of manually driven actions for a Delivery Pipeline, which includes Release promotion among Targets, Rollout repair and Rollout deployment strategy advancement. The intention of Automation is to reduce manual intervention in the continuous delivery process.

Return type

google.api_core.operation.Operation

update_custom_target_type(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.UpdateCustomTargetTypeRequest, dict]] = None, *, custom_target_type: Optional[google.cloud.deploy_v1.types.cloud_deploy.CustomTargetType] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Updates a single CustomTargetType.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_update_custom_target_type():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    custom_target_type = deploy_v1.CustomTargetType()
    custom_target_type.custom_actions.deploy_action = "deploy_action_value"

    request = deploy_v1.UpdateCustomTargetTypeRequest(
        custom_target_type=custom_target_type,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.UpdateCustomTargetTypeRequest, dict]) – The request object. The request object for UpdateCustomTargetType.
custom_target_type (google.cloud.deploy_v1.types.CustomTargetType) – Required. The CustomTargetType to update. This corresponds to the custom_target_type field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. Field mask is used to specify the fields to be overwritten by the update in the CustomTargetType resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it’s in the mask. If the user doesn’t provide a mask then all fields are overwritten.

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

An object representing a long-running operation.

The result type for the operation will be google.cloud.deploy_v1.types.CustomTargetType A CustomTargetType resource in the Cloud Deploy API.

A CustomTargetType defines a type of custom target that can be referenced in a Target in order to facilitate deploying to other systems besides the supported runtimes.

Return type

google.api_core.operation.Operation

update_delivery_pipeline(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.UpdateDeliveryPipelineRequest, dict]] = None, *, delivery_pipeline: Optional[google.cloud.deploy_v1.types.cloud_deploy.DeliveryPipeline] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Updates the parameters of a single DeliveryPipeline.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_update_delivery_pipeline():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.UpdateDeliveryPipelineRequest(
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.UpdateDeliveryPipelineRequest, dict]) – The request object. The request object for UpdateDeliveryPipeline.
delivery_pipeline (google.cloud.deploy_v1.types.DeliveryPipeline) – Required. The DeliveryPipeline to update. This corresponds to the delivery_pipeline field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. Field mask is used to specify the fields to be overwritten by the update in the DeliveryPipeline resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it’s in the mask. If the user doesn’t provide a mask then all fields are overwritten.

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

An object representing a long-running operation.

The result type for the operation will be google.cloud.deploy_v1.types.DeliveryPipeline A DeliveryPipeline resource in the Cloud Deploy API.

A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.

Return type

google.api_core.operation.Operation

update_deploy_policy(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.UpdateDeployPolicyRequest, dict]] = None, *, deploy_policy: Optional[google.cloud.deploy_v1.types.cloud_deploy.DeployPolicy] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Updates the parameters of a single DeployPolicy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_update_deploy_policy():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    deploy_policy = deploy_v1.DeployPolicy()
    deploy_policy.rules.rollout_restriction.id = "id_value"
    deploy_policy.rules.rollout_restriction.time_windows.time_zone = "time_zone_value"

    request = deploy_v1.UpdateDeployPolicyRequest(
        deploy_policy=deploy_policy,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.UpdateDeployPolicyRequest, dict]) – The request object. The request object for UpdateDeployPolicy.
deploy_policy (google.cloud.deploy_v1.types.DeployPolicy) – Required. The DeployPolicy to update. This corresponds to the deploy_policy field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. Field mask is used to specify the fields to be overwritten by the update in the DeployPolicy resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it’s in the mask. If the user doesn’t provide a mask then all fields are overwritten.

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

An object representing a long-running operation.

The result type for the operation will be google.cloud.deploy_v1.types.DeployPolicy A DeployPolicy resource in the Cloud Deploy API.

A DeployPolicy inhibits manual or automation-driven actions within a Delivery Pipeline or Target.

Return type

google.api_core.operation.Operation

update_target(request: Optional[Union[google.cloud.deploy_v1.types.cloud_deploy.UpdateTargetRequest, dict]] = None, *, target: Optional[google.cloud.deploy_v1.types.cloud_deploy.Target] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Updates the parameters of a single Target.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import deploy_v1

def sample_update_target():
    # Create a client
    client = deploy_v1.CloudDeployClient()

    # Initialize request argument(s)
    request = deploy_v1.UpdateTargetRequest(
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.deploy_v1.types.UpdateTargetRequest, dict]) – The request object. The request object for UpdateTarget.
target (google.cloud.deploy_v1.types.Target) – Required. The Target to update. This corresponds to the target field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. Field mask is used to specify the fields to be overwritten by the update in the Target resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it’s in the mask. If the user doesn’t provide a mask then all fields are overwritten.

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

An object representing a long-running operation.

The result type for the operation will be google.cloud.deploy_v1.types.Target A Target resource in the Cloud Deploy API.

A Target defines a location to which a Skaffold configuration can be deployed.

Return type

google.api_core.operation.Operation

static worker_pool_path(project: str, location: str, worker_pool: str) → str[source]¶: Returns a fully-qualified worker_pool string.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListAutomationRunsAsyncPager(method: Callable[[...], Awaitable[google.cloud.deploy_v1.types.cloud_deploy.ListAutomationRunsResponse]], request: google.cloud.deploy_v1.types.cloud_deploy.ListAutomationRunsRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListAutomationRunsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_automation_runs requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListAutomationRunsResponse object, and provides an __aiter__ method to iterate through its automation_runs field.

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

All the usual google.cloud.deploy_v1.types.ListAutomationRunsResponse 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.deploy_v1.types.ListAutomationRunsRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListAutomationRunsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListAutomationRunsPager(method: Callable[[...], google.cloud.deploy_v1.types.cloud_deploy.ListAutomationRunsResponse], request: google.cloud.deploy_v1.types.cloud_deploy.ListAutomationRunsRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListAutomationRunsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_automation_runs requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListAutomationRunsResponse object, and provides an __iter__ method to iterate through its automation_runs field.

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

All the usual google.cloud.deploy_v1.types.ListAutomationRunsResponse 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.deploy_v1.types.ListAutomationRunsRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListAutomationRunsResponse) – The initial response object.
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.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListAutomationsAsyncPager(method: Callable[[...], Awaitable[google.cloud.deploy_v1.types.cloud_deploy.ListAutomationsResponse]], request: google.cloud.deploy_v1.types.cloud_deploy.ListAutomationsRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListAutomationsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_automations requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListAutomationsResponse object, and provides an __aiter__ method to iterate through its automations field.

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

All the usual google.cloud.deploy_v1.types.ListAutomationsResponse 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.deploy_v1.types.ListAutomationsRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListAutomationsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListAutomationsPager(method: Callable[[...], google.cloud.deploy_v1.types.cloud_deploy.ListAutomationsResponse], request: google.cloud.deploy_v1.types.cloud_deploy.ListAutomationsRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListAutomationsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_automations requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListAutomationsResponse object, and provides an __iter__ method to iterate through its automations field.

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

All the usual google.cloud.deploy_v1.types.ListAutomationsResponse 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.deploy_v1.types.ListAutomationsRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListAutomationsResponse) – The initial response object.
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.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListCustomTargetTypesAsyncPager(method: Callable[[...], Awaitable[google.cloud.deploy_v1.types.cloud_deploy.ListCustomTargetTypesResponse]], request: google.cloud.deploy_v1.types.cloud_deploy.ListCustomTargetTypesRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListCustomTargetTypesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_custom_target_types requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListCustomTargetTypesResponse object, and provides an __aiter__ method to iterate through its custom_target_types field.

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

All the usual google.cloud.deploy_v1.types.ListCustomTargetTypesResponse 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.deploy_v1.types.ListCustomTargetTypesRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListCustomTargetTypesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListCustomTargetTypesPager(method: Callable[[...], google.cloud.deploy_v1.types.cloud_deploy.ListCustomTargetTypesResponse], request: google.cloud.deploy_v1.types.cloud_deploy.ListCustomTargetTypesRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListCustomTargetTypesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_custom_target_types requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListCustomTargetTypesResponse object, and provides an __iter__ method to iterate through its custom_target_types field.

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

All the usual google.cloud.deploy_v1.types.ListCustomTargetTypesResponse 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.deploy_v1.types.ListCustomTargetTypesRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListCustomTargetTypesResponse) – The initial response object.
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.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListDeliveryPipelinesAsyncPager(method: Callable[[...], Awaitable[google.cloud.deploy_v1.types.cloud_deploy.ListDeliveryPipelinesResponse]], request: google.cloud.deploy_v1.types.cloud_deploy.ListDeliveryPipelinesRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListDeliveryPipelinesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_delivery_pipelines requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListDeliveryPipelinesResponse object, and provides an __aiter__ method to iterate through its delivery_pipelines field.

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

All the usual google.cloud.deploy_v1.types.ListDeliveryPipelinesResponse 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.deploy_v1.types.ListDeliveryPipelinesRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListDeliveryPipelinesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListDeliveryPipelinesPager(method: Callable[[...], google.cloud.deploy_v1.types.cloud_deploy.ListDeliveryPipelinesResponse], request: google.cloud.deploy_v1.types.cloud_deploy.ListDeliveryPipelinesRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListDeliveryPipelinesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_delivery_pipelines requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListDeliveryPipelinesResponse object, and provides an __iter__ method to iterate through its delivery_pipelines field.

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

All the usual google.cloud.deploy_v1.types.ListDeliveryPipelinesResponse 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.deploy_v1.types.ListDeliveryPipelinesRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListDeliveryPipelinesResponse) – The initial response object.
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.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListDeployPoliciesAsyncPager(method: Callable[[...], Awaitable[google.cloud.deploy_v1.types.cloud_deploy.ListDeployPoliciesResponse]], request: google.cloud.deploy_v1.types.cloud_deploy.ListDeployPoliciesRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListDeployPoliciesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_deploy_policies requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListDeployPoliciesResponse object, and provides an __aiter__ method to iterate through its deploy_policies field.

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

All the usual google.cloud.deploy_v1.types.ListDeployPoliciesResponse 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.deploy_v1.types.ListDeployPoliciesRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListDeployPoliciesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListDeployPoliciesPager(method: Callable[[...], google.cloud.deploy_v1.types.cloud_deploy.ListDeployPoliciesResponse], request: google.cloud.deploy_v1.types.cloud_deploy.ListDeployPoliciesRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListDeployPoliciesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_deploy_policies requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListDeployPoliciesResponse object, and provides an __iter__ method to iterate through its deploy_policies field.

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

All the usual google.cloud.deploy_v1.types.ListDeployPoliciesResponse 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.deploy_v1.types.ListDeployPoliciesRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListDeployPoliciesResponse) – The initial response object.
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.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListJobRunsAsyncPager(method: Callable[[...], Awaitable[google.cloud.deploy_v1.types.cloud_deploy.ListJobRunsResponse]], request: google.cloud.deploy_v1.types.cloud_deploy.ListJobRunsRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListJobRunsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_job_runs requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListJobRunsResponse object, and provides an __aiter__ method to iterate through its job_runs field.

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

All the usual google.cloud.deploy_v1.types.ListJobRunsResponse 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.deploy_v1.types.ListJobRunsRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListJobRunsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListJobRunsPager(method: Callable[[...], google.cloud.deploy_v1.types.cloud_deploy.ListJobRunsResponse], request: google.cloud.deploy_v1.types.cloud_deploy.ListJobRunsRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListJobRunsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_job_runs requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListJobRunsResponse object, and provides an __iter__ method to iterate through its job_runs field.

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

All the usual google.cloud.deploy_v1.types.ListJobRunsResponse 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.deploy_v1.types.ListJobRunsRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListJobRunsResponse) – The initial response object.
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.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListReleasesAsyncPager(method: Callable[[...], Awaitable[google.cloud.deploy_v1.types.cloud_deploy.ListReleasesResponse]], request: google.cloud.deploy_v1.types.cloud_deploy.ListReleasesRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListReleasesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_releases requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListReleasesResponse object, and provides an __aiter__ method to iterate through its releases field.

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

All the usual google.cloud.deploy_v1.types.ListReleasesResponse 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.deploy_v1.types.ListReleasesRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListReleasesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListReleasesPager(method: Callable[[...], google.cloud.deploy_v1.types.cloud_deploy.ListReleasesResponse], request: google.cloud.deploy_v1.types.cloud_deploy.ListReleasesRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListReleasesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_releases requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListReleasesResponse object, and provides an __iter__ method to iterate through its releases field.

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

All the usual google.cloud.deploy_v1.types.ListReleasesResponse 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.deploy_v1.types.ListReleasesRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListReleasesResponse) – The initial response object.
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.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListRolloutsAsyncPager(method: Callable[[...], Awaitable[google.cloud.deploy_v1.types.cloud_deploy.ListRolloutsResponse]], request: google.cloud.deploy_v1.types.cloud_deploy.ListRolloutsRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListRolloutsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_rollouts requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListRolloutsResponse object, and provides an __aiter__ method to iterate through its rollouts field.

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

All the usual google.cloud.deploy_v1.types.ListRolloutsResponse 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.deploy_v1.types.ListRolloutsRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListRolloutsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListRolloutsPager(method: Callable[[...], google.cloud.deploy_v1.types.cloud_deploy.ListRolloutsResponse], request: google.cloud.deploy_v1.types.cloud_deploy.ListRolloutsRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListRolloutsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_rollouts requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListRolloutsResponse object, and provides an __iter__ method to iterate through its rollouts field.

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

All the usual google.cloud.deploy_v1.types.ListRolloutsResponse 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.deploy_v1.types.ListRolloutsRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListRolloutsResponse) – The initial response object.
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.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListTargetsAsyncPager(method: Callable[[...], Awaitable[google.cloud.deploy_v1.types.cloud_deploy.ListTargetsResponse]], request: google.cloud.deploy_v1.types.cloud_deploy.ListTargetsRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListTargetsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_targets requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListTargetsResponse object, and provides an __aiter__ method to iterate through its targets field.

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

All the usual google.cloud.deploy_v1.types.ListTargetsResponse 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.deploy_v1.types.ListTargetsRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListTargetsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.deploy_v1.services.cloud_deploy.pagers.ListTargetsPager(method: Callable[[...], google.cloud.deploy_v1.types.cloud_deploy.ListTargetsResponse], request: google.cloud.deploy_v1.types.cloud_deploy.ListTargetsRequest, response: google.cloud.deploy_v1.types.cloud_deploy.ListTargetsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_targets requests.

This class thinly wraps an initial google.cloud.deploy_v1.types.ListTargetsResponse object, and provides an __iter__ method to iterate through its targets field.

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

All the usual google.cloud.deploy_v1.types.ListTargetsResponse 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.deploy_v1.types.ListTargetsRequest) – The initial request object.
response (google.cloud.deploy_v1.types.ListTargetsResponse) – The initial response object.
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.

CloudDeploy¶

google-cloud-deploy

Navigation

Related Topics