Class EngineServiceClient (0.11.11)

Service for managing Engine configuration.

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 engine service client.

Releases underlying transport's resources.

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

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

def sample_create_engine():
    # Create a client
    client = discoveryengine_v1alpha.EngineServiceClient()

    # Initialize request argument(s)
    engine = discoveryengine_v1alpha.Engine()
    engine.display_name = "display_name_value"
    engine.solution_type = "SOLUTION_TYPE_GENERATIVE_CHAT"

    request = discoveryengine_v1alpha.CreateEngineRequest(
        parent="parent_value",
        engine=engine,
        engine_id="engine_id_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Deletes a xref_Engine.

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

def sample_delete_engine():
    # Create a client
    client = discoveryengine_v1alpha.EngineServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.DeleteEngineRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

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

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

def sample_get_engine():
    # Create a client
    client = discoveryengine_v1alpha.EngineServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.GetEngineRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

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.

Lists all the xref_Engines associated with the project.

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

def sample_list_engines():
    # Create a client
    client = discoveryengine_v1alpha.EngineServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.ListEnginesRequest(
        parent="parent_value",
    )

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

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

Lists operations that match the specified filter in the request.

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

Pauses the training of an existing engine. Only applicable if xref_SolutionType is xref_SOLUTION_TYPE_RECOMMENDATION.

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

def sample_pause_engine():
    # Create a client
    client = discoveryengine_v1alpha.EngineServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.PauseEngineRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Resumes the training of an existing engine. Only applicable if xref_SolutionType is xref_SOLUTION_TYPE_RECOMMENDATION.

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

def sample_resume_engine():
    # Create a client
    client = discoveryengine_v1alpha.EngineServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.ResumeEngineRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Tunes an existing engine. Only applicable if xref_SolutionType is xref_SOLUTION_TYPE_RECOMMENDATION.

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

def sample_tune_engine():
    # Create a client
    client = discoveryengine_v1alpha.EngineServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1alpha.TuneEngineRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Updates an xref_Engine

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

def sample_update_engine():
    # Create a client
    client = discoveryengine_v1alpha.EngineServiceClient()

    # Initialize request argument(s)
    engine = discoveryengine_v1alpha.Engine()
    engine.display_name = "display_name_value"
    engine.solution_type = "SOLUTION_TYPE_GENERATIVE_CHAT"

    request = discoveryengine_v1alpha.UpdateEngineRequest(
        engine=engine,
    )

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

    # Handle the response
    print(response)