インターフェース ClientConfiguration
public interface ClientConfiguration
Elasticsearch クライアントの共通クライアント構成プロパティを公開する構成インターフェース。
- 導入:
- 3.2
- 作成者:
- Mark Paluch, Peter-Josef Meisch, Huw Ayling-Miller, Henrique Amaral
ネストされたクラスの要約
ネストされたクラス修飾子と型インターフェース説明static interfacestatic interfaceクライアントを構成するために実行されるコールバック。static interfacestatic interface方法の概要
修飾子と型メソッド説明builder()新しいClientConfigurationBuilderインスタンスを作成します。static ClientConfigurationhostAndPortを指定して、単一のホストに構成された新しいClientConfigurationインスタンスを作成します。static ClientConfigurationcreate(InetSocketAddressSE socketAddress) InetSocketAddressSE を指定して、単一のホストに構成された新しいClientConfigurationインスタンスを作成します。connect timeoutSE を返します。デフォルトで使用するHttpHeadersを入手します。構成されたエンドポイントを返します。非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。6.0 以降@Nullable StringSEプロキシの背後にある Elasticsearch の HTTP(s) リクエストの先頭に追加する必要があるパスプレフィックスを返します。getProxy()オプションで設定されたプロキシを host:port の形式で返します通常、SO タイムアウト / 読み取りタイムアウトとして適用されるsocket timeoutSE を返します。使用するSSLContextSE を返します。static ClientConfigurationローカルホストに設定された新しいClientConfigurationインスタンスを作成します。booleanuseSsl()クライアントが SSL を使用する必要がある場合は true を返します。
メソッドの詳細
builder
新しいClientConfigurationBuilderインスタンスを作成します。- 戻り値:
- 新しい
ClientConfigurationBuilderインスタンス。
localhost
ローカルホストに設定された新しいClientConfigurationインスタンスを作成します。// "localhost:9200" ClientConfiguration configuration = ClientConfiguration.localhost();
create
hostAndPortを指定して、単一のホストに構成された新しいClientConfigurationインスタンスを作成します。たとえば、エンドポイント http://localhost:9200 を指定するClientConfiguration configuration = ClientConfiguration.create("localhost:9200");- 戻り値:
- 新しい
ClientConfigurationBuilderインスタンス。
create
InetSocketAddressSE を指定して、単一のホストに構成された新しいClientConfigurationインスタンスを作成します。たとえば、エンドポイント http://localhost:9200 を指定するClientConfiguration configuration = ClientConfiguration .create(InetSocketAddress.createUnresolved("localhost", 9200));- 戻り値:
- 新しい
ClientConfigurationBuilderインスタンス。
getEndpoints
ListSE<InetSocketAddressSE> getEndpoints()構成されたエンドポイントを返します。- 戻り値:
- 構成されたエンドポイント。
getDefaultHeaders
HttpHeaders getDefaultHeaders()デフォルトで使用するHttpHeadersを入手します。- 戻り値:
- デフォルトで使用される
HttpHeaders。
useSsl
boolean useSsl()クライアントが SSL を使用する必要がある場合は true を返します。- 戻り値:
- クライアントが SSL を使用する場合は true です。
getSslContext
OptionalSE<SSLContextSE> getSslContext()使用するSSLContextSE を返します。構成されていない場合はOptional.empty()になります。- 戻り値:
- 使用する
SSLContextSE。設定されていない場合はOptional.empty()になります。
getCaFingerprint
OptionalSE<StringSE> getCaFingerprint()- 戻り値:
- 起動時に Elasticsearch によって出力される自己署名付き http_ca.crt 証明書のオプションの SHA-256 フィンガープリント。
getHostNameVerifier
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。6.0 以降使用するHostnameVerifierSE を返します。設定されていない場合はOptional.empty()にする必要があります。Elasticsearch 9 以降で使用される Rest5Client では、基盤となる Apache HTTP コンポーネント 5 ではこれを設定する方法が提供されていないため、使用できません。ホスト名検証機能が必要なユーザーは、SSLContext にこれを組み込む必要があります。この場合、ここで値を返しても無視されます。- 戻り値:
- 使用する
HostnameVerifierSE。設定されていない場合はOptional.empty()になります。
getConnectTimeout
DurationSE getConnectTimeout()connect timeoutSE を返します。getSocketTimeout
DurationSE getSocketTimeout()通常、SO タイムアウト / 読み取りタイムアウトとして適用されるsocket timeoutSE を返します。getPathPrefix
@Nullable StringSE getPathPrefix()プロキシの背後にある Elasticsearch の HTTP(s) リクエストの先頭に追加する必要があるパスプレフィックスを返します。- 戻り値:
- パスプレフィックス。
- 導入:
- 4.0
getProxy
OptionalSE<StringSE> getProxy()オプションで設定されたプロキシを host:port の形式で返します- 戻り値:
- オプションのプロキシ
- 導入:
- 4.0
getClientConfigurers
- 戻り値:
- クライアント構成コールバック
- 導入:
- 4.3
getHeadersSupplier
SupplierSE<HttpHeaders> getHeadersSupplier()- 戻り値:
- カスタムヘッダーのサプライヤー。