Class CloudDeployClient (2.4.1)

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

Return the API endpoint used by the client instance.

Returns the transport used by the client instance.

Return the universe domain used by the client instance.

Instantiates the cloud deploy client.

Releases underlying transport's resources.

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)

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)

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)

Returns a fully-qualified automation string.

Returns a fully-qualified automation_run string.

Returns a fully-qualified build string.

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)

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.

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)

Returns a fully-qualified cluster string.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

Returns a fully-qualified config string.

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)

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)

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)

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)

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)

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)

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)

Returns a fully-qualified custom_target_type string.

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)

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)

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)

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)

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.

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)

Returns a fully-qualified delivery_pipeline string.

Returns a fully-qualified deploy_policy string.

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

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

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

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)

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)

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)

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)

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)

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)

Gets the IAM access control policy for a function.

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

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)

Gets information about a location.

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.

Gets the latest state of a long-running operation.

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)

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)

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)

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)

Returns a fully-qualified job string.

Returns a fully-qualified job_run string.

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)

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)

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)

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)

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)

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)

Lists information about the supported locations for this service.

Lists operations that match the specified filter in the request.

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)

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)

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)

Returns a fully-qualified membership string.

Parses a automation path into its component segments.

Parses a automation_run path into its component segments.

Parses a build path into its component segments.

Parses a cluster path into its component segments.

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a config path into its component segments.

Parses a custom_target_type path into its component segments.

Parses a delivery_pipeline path into its component segments.

Parses a deploy_policy path into its component segments.

Parses a job path into its component segments.

Parses a job_run path into its component segments.

Parses a membership path into its component segments.

Parses a release path into its component segments.

Parses a repository path into its component segments.

Parses a rollout path into its component segments.

Parses a service path into its component segments.

Parses a target path into its component segments.

Parses a worker_pool path into its component segments.

Returns a fully-qualified release string.

Returns a fully-qualified repository string.

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)

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)

Returns a fully-qualified rollout string.

Returns a fully-qualified service string.

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Returns a fully-qualified target string.

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)

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.

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)

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)

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)

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)

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)

Returns a fully-qualified worker_pool string.