Class SiteSearchEngineServiceClient (2.31.0)

Service for managing site search related resources.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

SiteSearchEngineServiceClient(SiteSearchEngineServiceClient const &)

Copy and move support

Parameter
Name	Description
	`SiteSearchEngineServiceClient const &`

SiteSearchEngineServiceClient(SiteSearchEngineServiceClient &&)

Copy and move support

Parameter
Name	Description
	`SiteSearchEngineServiceClient &&`

SiteSearchEngineServiceClient(std::shared_ptr< SiteSearchEngineServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< SiteSearchEngineServiceConnection >`
`opts`	`Options`

Operators

operator=(SiteSearchEngineServiceClient const &)

Copy and move support

Parameter
Name	Description
	`SiteSearchEngineServiceClient const &`

Returns
Type	Description
`SiteSearchEngineServiceClient &`

operator=(SiteSearchEngineServiceClient &&)

Copy and move support

Parameter
Name	Description
	`SiteSearchEngineServiceClient &&`

Returns
Type	Description
`SiteSearchEngineServiceClient &`

Functions

GetSiteSearchEngine(std::string const &, Options)

Gets the SiteSearchEngine.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of SiteSearchEngine, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::discoveryengine::v1::SiteSearchEngine >`	the result of the RPC. The response message type (google.cloud.discoveryengine.v1.SiteSearchEngine) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetSiteSearchEngine(google::cloud::discoveryengine::v1::GetSiteSearchEngineRequest const &, Options)

Gets the SiteSearchEngine.

Parameters
Name	Description
`request`	`google::cloud::discoveryengine::v1::GetSiteSearchEngineRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.GetSiteSearchEngineRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::discoveryengine::v1::SiteSearchEngine >`	the result of the RPC. The response message type (google.cloud.discoveryengine.v1.SiteSearchEngine) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateTargetSite(std::string const &, google::cloud::discoveryengine::v1::TargetSite const &, Options)

Creates a TargetSite.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
`target_site`	`google::cloud::discoveryengine::v1::TargetSite const &` Required. The TargetSite to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::discoveryengine::v1::TargetSite > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.discoveryengine.v1.TargetSite proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateTargetSite(NoAwaitTag, std::string const &, google::cloud::discoveryengine::v1::TargetSite const &, Options)

Creates a TargetSite.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`parent`	`std::string const &`
`target_site`	`google::cloud::discoveryengine::v1::TargetSite const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

CreateTargetSite(google::cloud::discoveryengine::v1::CreateTargetSiteRequest const &, Options)

Creates a TargetSite.

Parameters
Name	Description
`request`	`google::cloud::discoveryengine::v1::CreateTargetSiteRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.CreateTargetSiteRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::discoveryengine::v1::TargetSite > >

CreateTargetSite(NoAwaitTag, google::cloud::discoveryengine::v1::CreateTargetSiteRequest const &, Options)

Creates a TargetSite.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::discoveryengine::v1::CreateTargetSiteRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

CreateTargetSite(google::longrunning::Operation const &, Options)

Creates a TargetSite.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::discoveryengine::v1::TargetSite > >`

BatchCreateTargetSites(google::cloud::discoveryengine::v1::BatchCreateTargetSitesRequest const &, Options)

Creates TargetSite in a batch.

Parameters
Name	Description
`request`	`google::cloud::discoveryengine::v1::BatchCreateTargetSitesRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.BatchCreateTargetSitesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::discoveryengine::v1::BatchCreateTargetSitesResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.discoveryengine.v1.BatchCreateTargetSitesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchCreateTargetSites(NoAwaitTag, google::cloud::discoveryengine::v1::BatchCreateTargetSitesRequest const &, Options)

Creates TargetSite in a batch.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::discoveryengine::v1::BatchCreateTargetSitesRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

BatchCreateTargetSites(google::longrunning::Operation const &, Options)

Creates TargetSite in a batch.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::discoveryengine::v1::BatchCreateTargetSitesResponse > >`

GetTargetSite(std::string const &, Options)

Gets a TargetSite.

Parameters
Name	Description
`name`	`std::string const &` Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::discoveryengine::v1::TargetSite >`	the result of the RPC. The response message type (google.cloud.discoveryengine.v1.TargetSite) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetTargetSite(google::cloud::discoveryengine::v1::GetTargetSiteRequest const &, Options)

Gets a TargetSite.

Parameters
Name	Description
`request`	`google::cloud::discoveryengine::v1::GetTargetSiteRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.GetTargetSiteRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::discoveryengine::v1::TargetSite >`	the result of the RPC. The response message type (google.cloud.discoveryengine.v1.TargetSite) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateTargetSite(google::cloud::discoveryengine::v1::TargetSite const &, Options)

Updates a TargetSite.

Parameters
Name	Description
`target_site`	`google::cloud::discoveryengine::v1::TargetSite const &` Required. The target site to update. If the caller does not have permission to update the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the TargetSite to update does not exist, a NOT_FOUND error is returned.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::discoveryengine::v1::TargetSite > >

UpdateTargetSite(NoAwaitTag, google::cloud::discoveryengine::v1::TargetSite const &, Options)

Updates a TargetSite.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`target_site`	`google::cloud::discoveryengine::v1::TargetSite const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

UpdateTargetSite(google::cloud::discoveryengine::v1::UpdateTargetSiteRequest const &, Options)

Updates a TargetSite.

Parameters
Name	Description
`request`	`google::cloud::discoveryengine::v1::UpdateTargetSiteRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.UpdateTargetSiteRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::discoveryengine::v1::TargetSite > >

UpdateTargetSite(NoAwaitTag, google::cloud::discoveryengine::v1::UpdateTargetSiteRequest const &, Options)

Updates a TargetSite.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::discoveryengine::v1::UpdateTargetSiteRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

UpdateTargetSite(google::longrunning::Operation const &, Options)

Updates a TargetSite.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::discoveryengine::v1::TargetSite > >`

DeleteTargetSite(std::string const &, Options)

Deletes a TargetSite.

Parameters
Name	Description
`name`	`std::string const &` Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::discoveryengine::v1::DeleteTargetSiteMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.discoveryengine.v1.DeleteTargetSiteMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteTargetSite(NoAwaitTag, std::string const &, Options)

Deletes a TargetSite.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

DeleteTargetSite(google::cloud::discoveryengine::v1::DeleteTargetSiteRequest const &, Options)

Deletes a TargetSite.

Parameters
Name	Description
`request`	`google::cloud::discoveryengine::v1::DeleteTargetSiteRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.DeleteTargetSiteRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::discoveryengine::v1::DeleteTargetSiteMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.discoveryengine.v1.DeleteTargetSiteMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteTargetSite(NoAwaitTag, google::cloud::discoveryengine::v1::DeleteTargetSiteRequest const &, Options)

Deletes a TargetSite.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::discoveryengine::v1::DeleteTargetSiteRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

DeleteTargetSite(google::longrunning::Operation const &, Options)

Deletes a TargetSite.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::discoveryengine::v1::DeleteTargetSiteMetadata > >`

ListTargetSites(std::string const &, Options)

Gets a list of TargetSites.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent site search engine resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::discoveryengine::v1::TargetSite >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.discoveryengine.v1.TargetSite, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTargetSites(google::cloud::discoveryengine::v1::ListTargetSitesRequest, Options)

Gets a list of TargetSites.

Parameters
Name	Description
`request`	`google::cloud::discoveryengine::v1::ListTargetSitesRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.ListTargetSitesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::discoveryengine::v1::TargetSite >

EnableAdvancedSiteSearch(google::cloud::discoveryengine::v1::EnableAdvancedSiteSearchRequest const &, Options)

Upgrade from basic site search to advanced site search.

Parameters
Name	Description
`request`	`google::cloud::discoveryengine::v1::EnableAdvancedSiteSearchRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.EnableAdvancedSiteSearchRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::discoveryengine::v1::EnableAdvancedSiteSearchResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.discoveryengine.v1.EnableAdvancedSiteSearchResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

EnableAdvancedSiteSearch(NoAwaitTag, google::cloud::discoveryengine::v1::EnableAdvancedSiteSearchRequest const &, Options)

Upgrade from basic site search to advanced site search.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::discoveryengine::v1::EnableAdvancedSiteSearchRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

EnableAdvancedSiteSearch(google::longrunning::Operation const &, Options)

Upgrade from basic site search to advanced site search.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::discoveryengine::v1::EnableAdvancedSiteSearchResponse > >`

DisableAdvancedSiteSearch(google::cloud::discoveryengine::v1::DisableAdvancedSiteSearchRequest const &, Options)

Downgrade from advanced site search to basic site search.

Parameters
Name	Description
`request`	`google::cloud::discoveryengine::v1::DisableAdvancedSiteSearchRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.DisableAdvancedSiteSearchRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::discoveryengine::v1::DisableAdvancedSiteSearchResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.discoveryengine.v1.DisableAdvancedSiteSearchResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DisableAdvancedSiteSearch(NoAwaitTag, google::cloud::discoveryengine::v1::DisableAdvancedSiteSearchRequest const &, Options)

Downgrade from advanced site search to basic site search.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::discoveryengine::v1::DisableAdvancedSiteSearchRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

DisableAdvancedSiteSearch(google::longrunning::Operation const &, Options)

Downgrade from advanced site search to basic site search.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::discoveryengine::v1::DisableAdvancedSiteSearchResponse > >`

RecrawlUris(google::cloud::discoveryengine::v1::RecrawlUrisRequest const &, Options)

Request on-demand recrawl for a list of URIs.

Parameters
Name	Description
`request`	`google::cloud::discoveryengine::v1::RecrawlUrisRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.RecrawlUrisRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::discoveryengine::v1::RecrawlUrisResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.discoveryengine.v1.RecrawlUrisResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RecrawlUris(NoAwaitTag, google::cloud::discoveryengine::v1::RecrawlUrisRequest const &, Options)

Request on-demand recrawl for a list of URIs.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::discoveryengine::v1::RecrawlUrisRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

RecrawlUris(google::longrunning::Operation const &, Options)

Request on-demand recrawl for a list of URIs.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::discoveryengine::v1::RecrawlUrisResponse > >`

BatchVerifyTargetSites(google::cloud::discoveryengine::v1::BatchVerifyTargetSitesRequest const &, Options)

Verify target sites' ownership and validity.

This API sends all the target sites under site search engine for verification.

Parameters
Name	Description
`request`	`google::cloud::discoveryengine::v1::BatchVerifyTargetSitesRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.BatchVerifyTargetSitesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::discoveryengine::v1::BatchVerifyTargetSitesResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.discoveryengine.v1.BatchVerifyTargetSitesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BatchVerifyTargetSites(NoAwaitTag, google::cloud::discoveryengine::v1::BatchVerifyTargetSitesRequest const &, Options)

Verify target sites' ownership and validity.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::discoveryengine::v1::BatchVerifyTargetSitesRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

BatchVerifyTargetSites(google::longrunning::Operation const &, Options)

Verify target sites' ownership and validity.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::discoveryengine::v1::BatchVerifyTargetSitesResponse > >`

FetchDomainVerificationStatus(google::cloud::discoveryengine::v1::FetchDomainVerificationStatusRequest, Options)

Returns list of target sites with its domain verification status.

This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.

Parameters
Name	Description
`request`	`google::cloud::discoveryengine::v1::FetchDomainVerificationStatusRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.discoveryengine.v1.FetchDomainVerificationStatusRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::discoveryengine::v1::TargetSite >

ListOperations(std::string const &, std::string const &, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters
Name	Description
`name`	`std::string const &` The name of the operation's parent resource.
`filter`	`std::string const &` The standard list filter.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::longrunning::Operation >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListOperations(google::longrunning::ListOperationsRequest, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name	Description
`request`	`google::longrunning::ListOperationsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.ListOperationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::longrunning::Operation >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetOperation(std::string const &, Options)

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.

Parameters
Name	Description
`name`	`std::string const &` The name of the operation resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`	the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetOperation(google::longrunning::GetOperationRequest const &, Options)

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.

Parameters
Name	Description
`request`	`google::longrunning::GetOperationRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.GetOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`	the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CancelOperation(std::string const &, Options)

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. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name	Description
`name`	`std::string const &` The name of the operation resource to be cancelled.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CancelOperation(google::longrunning::CancelOperationRequest const &, Options)

Starts asynchronous cancellation on a long-running operation.

Parameters
Name	Description
`request`	`google::longrunning::CancelOperationRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.CancelOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.