com.ibm.watson.assistant.v2.model

Class SearchSettingsElasticSearch

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.assistant.v2.model.SearchSettingsElasticSearch

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class SearchSettingsElasticSearch
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Configuration settings for the Elasticsearch service used by the search integration. You can provide either basic auth or apiKey auth.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchSettingsElasticSearch.Builder Builder.

Method Summary

Modifier and Type	Method and Description
String	apikey() Gets the apikey.
List<Object>	filter() Gets the filter.
String	index() Gets the index.
String	managedIndex() Gets the managedIndex.
SearchSettingsElasticSearch.Builder	newBuilder() New builder.
String	password() Gets the password.
String	port() Gets the port.
Map<String,Object>	queryBody() Gets the queryBody.
String	url() Gets the url.
String	username() Gets the username.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public SearchSettingsElasticSearch.Builder newBuilder()

New builder.

Returns:

a SearchSettingsElasticSearch builder

url

public String url()

Gets the url.

The URL for the Elasticsearch service.

Returns:

the url

port

public String port()

Gets the port.

The port number for the Elasticsearch service URL.

**Note:** It can be omitted if a port number is appended to the URL.

Returns:

the port

username

public String username()

Gets the username.

The username of the basic authentication method.

Returns:

the username

password

public String password()

Gets the password.

The password of the basic authentication method. The credentials are not returned due to security reasons.

Returns:

the password

index

public String index()

Gets the index.

The Elasticsearch index to use for the search integration.

Returns:

the index

filter

public List<Object> filter()

Gets the filter.

An array of filters that can be applied to the search results via the `$FILTER` variable in the `query_body`.For more information, see [Elasticsearch filter documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/filter-search-results.html).

Returns:

the filter

queryBody

public Map<String,Object> queryBody()

Gets the queryBody.

The Elasticsearch query object. For more information, see [Elasticsearch search API documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html).

Returns:

the queryBody

managedIndex

public String managedIndex()

Gets the managedIndex.

The Elasticsearch index for uploading documents. It is created automatically when the upload document option is selected from the user interface.

Returns:

the managedIndex

apikey

public String apikey()

Gets the apikey.

The API key of the apiKey authentication method. Use either basic auth or apiKey auth. The credentials are not returned due to security reasons.

Returns:

the apikey