search_engine_operations

Creates, updates, deletes, gets or lists a search_engine_operations resource.

Overview

Name	search_engine_operations
Type	Resource
Id	google.discoveryengine.search_engine_operations

Fields

The following fields are returned by SELECT queries:

projects_locations_collections_data_stores_site_search_engine_operations_get

Name	Datatype	Description
name	string	The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
done	boolean	If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
error	object	The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. (id: GoogleRpcStatus)
metadata	object	Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
response	object	The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

projects_locations_collections_data_stores_site_search_engine_operations_list

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_collections_data_stores_site_search_engine_operations_get	select	projectsId, locationsId, collectionsId, dataStoresId, operationsId		Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
projects_locations_collections_data_stores_site_search_engine_operations_list	select	projectsId, locationsId, collectionsId, dataStoresId	pageSize, pageToken, filter, returnPartialSuccess	Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
collectionsId	string
dataStoresId	string
locationsId	string
operationsId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string
returnPartialSuccess	boolean

SELECT examples

projects_locations_collections_data_stores_site_search_engine_operations_get

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

SELECT
name,
done,
error,
metadata,
response
FROM google.discoveryengine.search_engine_operations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND operationsId = '{{ operationsId }}' -- required
;

projects_locations_collections_data_stores_site_search_engine_operations_list

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

SELECT
*
FROM google.discoveryengine.search_engine_operations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;