Class ServingConfigServiceClient (1.19.1)

Service for modifying ServingConfig.

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 serving config service client.

Releases underlying transport's resources.

Enables a Control on the specified ServingConfig. The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control.

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

def sample_add_control():
    # Create a client
    client = retail_v2beta.ServingConfigServiceClient()

    # Initialize request argument(s)
    request = retail_v2beta.AddControlRequest(
        serving_config="serving_config_value",
        control_id="control_id_value",
    )

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

    # Handle the response
    print(response)

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

A maximum of 100 xref_ServingConfigs are allowed in a xref_Catalog, otherwise a FAILED_PRECONDITION error is returned.

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

def sample_create_serving_config():
    # Create a client
    client = retail_v2beta.ServingConfigServiceClient()

    # Initialize request argument(s)
    serving_config = retail_v2beta.ServingConfig()
    serving_config.display_name = "display_name_value"
    serving_config.solution_types = ['SOLUTION_TYPE_SEARCH']

    request = retail_v2beta.CreateServingConfigRequest(
        parent="parent_value",
        serving_config=serving_config,
        serving_config_id="serving_config_id_value",
    )

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

    # Handle the response
    print(response)

Deletes a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

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

def sample_delete_serving_config():
    # Create a client
    client = retail_v2beta.ServingConfigServiceClient()

    # Initialize request argument(s)
    request = retail_v2beta.DeleteServingConfigRequest(
        name="name_value",
    )

    # Make the request
    client.delete_serving_config(request=request)

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.

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 a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

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

def sample_get_serving_config():
    # Create a client
    client = retail_v2beta.ServingConfigServiceClient()

    # Initialize request argument(s)
    request = retail_v2beta.GetServingConfigRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Lists operations that match the specified filter in the request.

Lists all ServingConfigs linked to this catalog.

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

def sample_list_serving_configs():
    # Create a client
    client = retail_v2beta.ServingConfigServiceClient()

    # Initialize request argument(s)
    request = retail_v2beta.ListServingConfigsRequest(
        parent="parent_value",
    )

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

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

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

Disables a Control on the specified ServingConfig. The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig.

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

def sample_remove_control():
    # Create a client
    client = retail_v2beta.ServingConfigServiceClient()

    # Initialize request argument(s)
    request = retail_v2beta.RemoveControlRequest(
        serving_config="serving_config_value",
        control_id="control_id_value",
    )

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

    # Handle the response
    print(response)

Returns a fully-qualified serving_config string.

Updates a ServingConfig.

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

def sample_update_serving_config():
    # Create a client
    client = retail_v2beta.ServingConfigServiceClient()

    # Initialize request argument(s)
    serving_config = retail_v2beta.ServingConfig()
    serving_config.display_name = "display_name_value"
    serving_config.solution_types = ['SOLUTION_TYPE_SEARCH']

    request = retail_v2beta.UpdateServingConfigRequest(
        serving_config=serving_config,
    )

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

    # Handle the response
    print(response)