workflows/cloud-client/execute_with_arguments.py

# Copyright 2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import os

from google.cloud.workflows.executions_v1 import Execution


def execute_workflow_with_arguments(
    project_id: str,
    location: str,
    workflow_id: str
) -> Execution:
    """Execute a workflow and print the execution results.

    Args:
        project: The ID of the Google Cloud project
            which contains the workflow to execute.
        location: The location for the workflow.
        workflow: The ID of the workflow to execute.

    Returns:
        The execution response.
    """

# [START workflows_execute_with_arguments]
    import time

    from google.cloud import workflows_v1
    from google.cloud.workflows import executions_v1

    from google.cloud.workflows.executions_v1.types import executions

    # TODO(developer): Update and uncomment the following lines.
    # project_id = "YOUR_PROJECT_ID"
    # location = "YOUR_LOCATION"  # For example: us-central1
    # workflow_id = "YOUR_WORKFLOW_ID"  # For example: myFirstWorkflow

    # Initialize API clients.
    execution_client = executions_v1.ExecutionsClient()
    workflows_client = workflows_v1.WorkflowsClient()

    # Construct the fully qualified location path.
    parent = workflows_client.workflow_path(project_id, location, workflow_id)

    # Execute the workflow adding an dictionary of arguments.
    # Find more information about the Execution object here:
    # https://cloud.google.com/python/docs/reference/workflows/latest/google.cloud.workflows.executions_v1.types.Execution
    execution = executions_v1.Execution(
        name=parent,
        argument='{"searchTerm": "Cloud"}',
    )

    response = execution_client.create_execution(
        parent=parent,
        execution=execution,
    )
    print(f"Created execution: {response.name}")

    # Wait for execution to finish, then print results.
    execution_finished = False
    backoff_delay = 1  # Start wait with delay of 1 second.
    print("Poll for result...")

    # Keep polling the state until the execution finishes,
    # using exponential backoff.
    while not execution_finished:
        execution = execution_client.get_execution(
            request={"name": response.name}
        )
        execution_finished = execution.state != executions.Execution.State.ACTIVE

        # If we haven't seen the result yet, keep waiting.
        if not execution_finished:
            print("- Waiting for results...")
            time.sleep(backoff_delay)
            # Double the delay to provide exponential backoff.
            backoff_delay *= 2
        else:
            print(f"Execution finished with state: {execution.state.name}")
            print(f"Execution results: {execution.result}")
# [END workflows_execute_with_arguments]
            return execution


if __name__ == "__main__":
    PROJECT = os.getenv("GOOGLE_CLOUD_PROJECT")
    assert PROJECT, "'GOOGLE_CLOUD_PROJECT' environment variable not set."

    execute_workflow_with_arguments(PROJECT, "us-central1", "myFirstWorkflow")