Class DocumentServiceAsyncClient (0.11.11)

Service for ingesting Document information of the customer's website.

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 document service async client.

Returns a fully-qualified branch 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.

Creates a xref_Document.

# 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 discoveryengine_v1

async def sample_create_document():
    # Create a client
    client = discoveryengine_v1.DocumentServiceAsyncClient()

    # Initialize request argument(s)
    request = discoveryengine_v1.CreateDocumentRequest(
        parent="parent_value",
        document_id="document_id_value",
    )

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

    # Handle the response
    print(response)

Deletes a xref_Document.

# 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 discoveryengine_v1

async def sample_delete_document():
    # Create a client
    client = discoveryengine_v1.DocumentServiceAsyncClient()

    # Initialize request argument(s)
    request = discoveryengine_v1.DeleteDocumentRequest(
        name="name_value",
    )

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

Returns a fully-qualified document string.

Returns a fully-qualified fhir_store 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 a xref_Document.

# 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 discoveryengine_v1

async def sample_get_document():
    # Create a client
    client = discoveryengine_v1.DocumentServiceAsyncClient()

    # Initialize request argument(s)
    request = discoveryengine_v1.GetDocumentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

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.

Returns an appropriate transport class.

Bulk import of multiple xref_Documents. Request processing may be synchronous. Non-existing items will be created.

Note: It is possible for a subset of the xref_Documents to be successfully updated.

# 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 discoveryengine_v1

async def sample_import_documents():
    # Create a client
    client = discoveryengine_v1.DocumentServiceAsyncClient()

    # Initialize request argument(s)
    request = discoveryengine_v1.ImportDocumentsRequest(
        parent="parent_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Gets a list of xref_Documents.

# 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 discoveryengine_v1

async def sample_list_documents():
    # Create a client
    client = discoveryengine_v1.DocumentServiceAsyncClient()

    # Initialize request argument(s)
    request = discoveryengine_v1.ListDocumentsRequest(
        parent="parent_value",
    )

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

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

Lists operations that match the specified filter in the request.

Parses a branch 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 document path into its component segments.

Parses a fhir_store path into its component segments.

Permanently deletes all selected xref_Documents in a branch.

This process is asynchronous. Depending on the number of xref_Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some xref_Documents might still be returned by xref_DocumentService.GetDocument or xref_DocumentService.ListDocuments.

To get a list of the xref_Documents to be deleted, set xref_PurgeDocumentsRequest.force to false.

# 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 discoveryengine_v1

async def sample_purge_documents():
    # Create a client
    client = discoveryengine_v1.DocumentServiceAsyncClient()

    # Initialize request argument(s)
    request = discoveryengine_v1.PurgeDocumentsRequest(
        parent="parent_value",
        filter="filter_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Updates a xref_Document.

# 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 discoveryengine_v1

async def sample_update_document():
    # Create a client
    client = discoveryengine_v1.DocumentServiceAsyncClient()

    # Initialize request argument(s)
    request = discoveryengine_v1.UpdateDocumentRequest(
    )

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

    # Handle the response
    print(response)