構造体 RecommendationService(0.5.0)

Discovery Engine API のクライアントを実装します。

例

# tokio_test::block_on(async {
# use google_cloud_discoveryengine_v1::client::RecommendationService;
let client = RecommendationService::builder().build().await?;
// use `client` to make requests to the Discovery Engine API.
# gax::client_builder::Result::<()>::Ok(()) });

サービスの説明

レコメンデーションを行うサービス。

構成

RecommendationService を構成するには、[builder()][RecommendationService::builder] によって返される型の with_* メソッドを使用します。ほとんどのアプリケーションでは、デフォルトの構成で機能します。一般的な構成の変更には、次のようなものがあります。

  • with_endpoint(): デフォルトでは、このクライアントはグローバル デフォルト エンドポイント(https://discoveryengine.googleapis.com)を使用します。リージョン エンドポイントを使用するアプリケーションや、制限付きネットワーク(デフォルトをオーバーライドするように構成されたネットワークなど)で実行されているアプリケーションは、このデフォルトをオーバーライドします。
  • with_credentials(): デフォルトでは、このクライアントはアプリケーションのデフォルト認証情報を使用します。カスタム認証を使用するアプリケーションでは、このデフォルトをオーバーライドする必要がある場合があります。

プーリングとクローニング

RecommendationService は内部で接続プールを保持するため、1 つ作成して再利用することをおすすめします。RecommendationService は内部で Arc を使用しているため、再利用するために Rc や Arc でラップする必要はありません。

実装

ビルダー

 fn builder() -> super::builder::recommendation_service::ClientBuilder

[RecommendationService] のビルダーを返します。

# tokio_test::block_on(async {
# use google_cloud_discoveryengine_v1::client::RecommendationService;
let client = RecommendationService::builder().build().await?;
# gax::client_builder::Result::<()>::Ok(()) });

from_stub

 fn from_stub<T>(stub: T) -> Self
where
    T: super::stub::RecommendationService + 'static,

指定されたスタブから新しいクライアントを作成します。

この関数を呼び出す最も一般的なケースは、クライアントの動作をモックするテストです。

recommend

 fn recommend(self: &Self) -> super::builder::recommendation_service::Recommend

コンテキスト ユーザー イベントを必要とするレコメンデーションを作成します。

list_operations

 fn list_operations(self: &Self) -> super::builder::recommendation_service::ListOperations

このサービスでオペレーション サービス機能を提供します。

get_operation

 fn get_operation(self: &Self) -> super::builder::recommendation_service::GetOperation

このサービスでオペレーション サービス機能を提供します。

cancel_operation

 fn cancel_operation(self: &Self) -> super::builder::recommendation_service::CancelOperation

このサービスでオペレーション サービス機能を提供します。