Class SampleQueryServiceClient (0.12.3)

SampleQueryServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.sample_query_service.transports.base.SampleQueryServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.services.sample_query_service.transports.base.SampleQueryServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service for managing SampleQuerys,

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
SampleQueryServiceTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

SampleQueryServiceClient

SampleQueryServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.discoveryengine_v1beta.services.sample_query_service.transports.base.SampleQueryServiceTransport, typing.Callable[[...], google.cloud.discoveryengine_v1beta.services.sample_query_service.transports.base.SampleQueryServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the sample query service client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Optional[Union[str,SampleQueryServiceTransport,Callable[..., SampleQueryServiceTransport]]]

The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the SampleQueryServiceTransport constructor. If set to None, a transport is chosen automatically.

client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.CancelOperationRequest

The request object. Request message for CancelOperation method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_sample_query

create_sample_query(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.sample_query_service.CreateSampleQueryRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    sample_query: typing.Optional[
        google.cloud.discoveryengine_v1beta.types.sample_query.SampleQuery
    ] = None,
    sample_query_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.sample_query.SampleQuery

Creates a xref_SampleQuery

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

def sample_create_sample_query():
    # Create a client
    client = discoveryengine_v1beta.SampleQueryServiceClient()

    # Initialize request argument(s)
    sample_query = discoveryengine_v1beta.SampleQuery()
    sample_query.query_entry.query = "query_value"

    request = discoveryengine_v1beta.CreateSampleQueryRequest(
        parent="parent_value",
        sample_query=sample_query,
        sample_query_id="sample_query_id_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.discoveryengine_v1beta.types.CreateSampleQueryRequest, dict]

The request object. Request message for SampleQueryService.CreateSampleQuery method.

parent str

Required. The parent resource name, such as projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

sample_query google.cloud.discoveryengine_v1beta.types.SampleQuery

Required. The SampleQuery to create. This corresponds to the sample_query field on the request instance; if request is provided, this should not be set.

sample_query_id str

Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to RFC-1034 https://tools.ietf.org/html/rfc1034__ standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. This corresponds to the sample_query_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.discoveryengine_v1beta.types.SampleQuery Sample Query captures metadata to be used for evaluation.

delete_sample_query

delete_sample_query(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.sample_query_service.DeleteSampleQueryRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a xref_SampleQuery.

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

def sample_delete_sample_query():
    # Create a client
    client = discoveryengine_v1beta.SampleQueryServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1beta.DeleteSampleQueryRequest(
        name="name_value",
    )

    # Make the request
    client.delete_sample_query(request=request)
Parameters
Name Description
request Union[google.cloud.discoveryengine_v1beta.types.DeleteSampleQueryRequest, dict]

The request object. Request message for SampleQueryService.DeleteSampleQuery method.

name str

Required. Full resource name of SampleQuery, such as projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the SampleQuery to delete does not exist, a NOT_FOUND error is returned. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.

Returns
Type Description
SampleQueryServiceClient The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name Description
info dict

The service account private key info.

Returns
Type Description
SampleQueryServiceClient The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.

Returns
Type Description
SampleQueryServiceClient The constructed client.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

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.

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
.operations_pb2.Operation An Operation object.

get_sample_query

get_sample_query(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.sample_query_service.GetSampleQueryRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.sample_query.SampleQuery

Gets a xref_SampleQuery.

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

def sample_get_sample_query():
    # Create a client
    client = discoveryengine_v1beta.SampleQueryServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1beta.GetSampleQueryRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.discoveryengine_v1beta.types.GetSampleQueryRequest, dict]

The request object. Request message for SampleQueryService.GetSampleQuery method.

name str

Required. Full resource name of SampleQuery, such as projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.discoveryengine_v1beta.types.SampleQuery Sample Query captures metadata to be used for evaluation.

import_sample_queries

import_sample_queries(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.import_config.ImportSampleQueriesRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Bulk import of multiple xref_SampleQuerys. Sample queries that already exist may be deleted.

Note: It is possible for a subset of the xref_SampleQuerys to be successfully imported.

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

def sample_import_sample_queries():
    # Create a client
    client = discoveryengine_v1beta.SampleQueryServiceClient()

    # Initialize request argument(s)
    inline_source = discoveryengine_v1beta.InlineSource()
    inline_source.sample_queries.query_entry.query = "query_value"

    request = discoveryengine_v1beta.ImportSampleQueriesRequest(
        inline_source=inline_source,
        parent="parent_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.discoveryengine_v1beta.types.ImportSampleQueriesRequest, dict]

The request object. Request message for SampleQueryService.ImportSampleQueries method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be ImportSampleQueriesResponse Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

list_sample_queries

list_sample_queries(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.sample_query_service.ListSampleQueriesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.discoveryengine_v1beta.services.sample_query_service.pagers.ListSampleQueriesPager
)

Gets a list of xref_SampleQuerys.

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

def sample_list_sample_queries():
    # Create a client
    client = discoveryengine_v1beta.SampleQueryServiceClient()

    # Initialize request argument(s)
    request = discoveryengine_v1beta.ListSampleQueriesRequest(
        parent="parent_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.discoveryengine_v1beta.types.ListSampleQueriesRequest, dict]

The request object. Request message for SampleQueryService.ListSampleQueries method.

parent str

Required. The parent sample query set resource name, such as projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a PERMISSION_DENIED error is returned. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.discoveryengine_v1beta.services.sample_query_service.pagers.ListSampleQueriesPager Response message for SampleQueryService.ListSampleQueries method. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_sample_query_path

parse_sample_query_path(path: str) -> typing.Dict[str, str]

Parses a sample_query path into its component segments.

parse_sample_query_set_path

parse_sample_query_set_path(path: str) -> typing.Dict[str, str]

Parses a sample_query_set path into its component segments.

sample_query_path

sample_query_path(
    project: str, location: str, sample_query_set: str, sample_query: str
) -> str

Returns a fully-qualified sample_query string.

sample_query_set_path

sample_query_set_path(project: str, location: str, sample_query_set: str) -> str

Returns a fully-qualified sample_query_set string.

update_sample_query

update_sample_query(
    request: typing.Optional[
        typing.Union[
            google.cloud.discoveryengine_v1beta.types.sample_query_service.UpdateSampleQueryRequest,
            dict,
        ]
    ] = None,
    *,
    sample_query: typing.Optional[
        google.cloud.discoveryengine_v1beta.types.sample_query.SampleQuery
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.discoveryengine_v1beta.types.sample_query.SampleQuery

Updates a xref_SampleQuery.

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

def sample_update_sample_query():
    # Create a client
    client = discoveryengine_v1beta.SampleQueryServiceClient()

    # Initialize request argument(s)
    sample_query = discoveryengine_v1beta.SampleQuery()
    sample_query.query_entry.query = "query_value"

    request = discoveryengine_v1beta.UpdateSampleQueryRequest(
        sample_query=sample_query,
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.discoveryengine_v1beta.types.UpdateSampleQueryRequest, dict]

The request object. Request message for SampleQueryService.UpdateSampleQuery method.

sample_query google.cloud.discoveryengine_v1beta.types.SampleQuery

Required. The simple query to update. If the caller does not have permission to update the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the SampleQuery to update does not exist a NOT_FOUND error is returned. This corresponds to the sample_query field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.discoveryengine_v1beta.types.SampleQuery Sample Query captures metadata to be used for evaluation.