com.ibm.watson.developer_cloud.document_conversion.v1.model

Class IndexConfiguration

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

com.ibm.watson.developer_cloud.document_conversion.v1.model.IndexConfiguration

public class IndexConfiguration
extends GenericModel

Structure that stores the configuration for the Retrieve and Rank service when indexing documents through the Document Conversion service.

See Also:

DocumentConversion

Constructor Summary

Constructors

Constructor and Description
IndexConfiguration(String serviceInstanceId, String clusterId, String searchCollectionName) Constructor for the Retrieve and Rank configuration.
IndexConfiguration(String serviceInstanceId, String clusterId, String searchCollectionName, IndexFields fields) Constructor for the Retrieve and Rank configuration.

Method Summary

Modifier and Type	Method and Description
String	getClusterId() Gets the cluster id for the Retrieve and Rank service.
IndexFields	getFields() Gets the fields object to pass to the Retrieve and Rank service.
String	getSearchCollectionName() Gets the search collection name for the Retrieve and Rank service.
String	getServiceInstanceId() Gets the service instance id for the Retrieve and Rank service.

Methods inherited from class com.ibm.watson.developer_cloud.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IndexConfiguration

public IndexConfiguration(String serviceInstanceId,
                          String clusterId,
                          String searchCollectionName)

Constructor for the Retrieve and Rank configuration. You will need to get Retrieve and Rank service credentials and create a Solr cluster through the Retrieve and Rank service prior to creating this configuration object.

Parameters:

serviceInstanceId - The instance id for the Retrieve and Rank service. To find your service_instance_id, click the tile for your service in Bluemix, and then look at the URL in the browser for the serviceGuid= request parameter. The value for service_instance_id is the value for serviceGuid.

clusterId - The Solr cluster id from the Retrieve and Rank service

searchCollectionName - The Solr search collection name

IndexConfiguration

public IndexConfiguration(String serviceInstanceId,
                          String clusterId,
                          String searchCollectionName,
                          IndexFields fields)

Constructor for the Retrieve and Rank configuration. You will need to get Retrieve and Rank service credentials and create a Solr cluster through the Retrieve and Rank service prior to creating this configuration object.

Parameters:

serviceInstanceId - The instance id for the Retrieve and Rank service

clusterId - The Solr cluster id from the Retrieve and Rank service

searchCollectionName - The Solr search collection name

fields - The field mapping object to pass to the Retrieve and Rank service

Method Detail

getClusterId

public String getClusterId()

Gets the cluster id for the Retrieve and Rank service.

Returns:

String the cluster id

getFields

public IndexFields getFields()

Gets the fields object to pass to the Retrieve and Rank service.

Returns:

Fields the fields

getSearchCollectionName

public String getSearchCollectionName()

Gets the search collection name for the Retrieve and Rank service.

Returns:

String the collection name

getServiceInstanceId

public String getServiceInstanceId()

Gets the service instance id for the Retrieve and Rank service. To find your service_instance_id, click the tile for your service in Bluemix, and then look at the URL in the browser for the serviceGuid= request parameter. The value for service_instance_id is the value for serviceGuid.

Returns:

String the service instance id