Get details about a long running operation
Stay organized with collections
Save and categorize content based on your preferences.
Get the status and details about a long running operation (LRO).
Explore further
For detailed documentation that includes this code sample, see the following:
Code sample
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],[],[[["\u003cp\u003eThis content provides instructions on how to retrieve the status and details of a long-running operation (LRO) using the Vertex AI Agent Builder.\u003c/p\u003e\n"],["\u003cp\u003eThe provided code sample demonstrates how to use the \u003ccode\u003ediscoveryengine\u003c/code\u003e library in Python to get the status of an operation using its name.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication to Vertex AI Agent Builder requires setting up Application Default Credentials, as referenced in the linked documentation.\u003c/p\u003e\n"],["\u003cp\u003eThe full documentation for monitoring long-running operations, as well as the Vertex AI Agent Builder Python API reference, are available through the provided links.\u003c/p\u003e\n"],["\u003cp\u003eAdditional code samples for other Google Cloud products can be found using the provided Google Cloud sample browser link.\u003c/p\u003e\n"]]],[],null,["# Get details about a long running operation\n\nGet the status and details about a long running operation (LRO).\n\nExplore further\n---------------\n\n\nFor detailed documentation that includes this code sample, see the following:\n\n- [Monitor long-running operations](/agentspace/docs/long-running-operations)\n- [Monitor long-running operations](/generative-ai-app-builder/docs/long-running-operations)\n\nCode sample\n-----------\n\n### Python\n\n\nFor more information, see the\n[AI Applications Python API\nreference documentation](/python/docs/reference/discoveryengine/latest).\n\n\nTo authenticate to AI Applications, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n from google.cloud import discoveryengine\n from google.longrunning import operations_pb2\n\n # TODO(developer): Uncomment these variables before running the sample.\n # Example: `projects/{project}/locations/{location}/collections/{default_collection}/dataStores/{search_engine_id}/branches/{0}/operations/{operation_id}`\n # operation_name = \"YOUR_OPERATION_NAME\"\n\n\n def get_operation_sample(operation_name: str) -\u003e operations_pb2.Operation:\n # Create a client\n client = discoveryengine.DocumentServiceClient()\n\n # Make GetOperation request\n request = operations_pb2.GetOperationRequest(name=operation_name)\n operation = client.get_operation(request=request)\n\n # Print the Operation Information\n print(operation)\n\n return operation\n\nWhat's next\n-----------\n\n\nTo search and filter code samples for other Google Cloud products, see the\n[Google Cloud sample browser](/docs/samples?product=genappbuilder)."]]