com.indix.client

Interface BulkQueryApi

All Known Subinterfaces:

IndixApiClient

public interface BulkQueryApi

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	getBulkJobOutput(JobQuery query) get output of job returned against bulk query
JobInfo	getBulkJobStatus(JobQuery query) get status of job returned against bulk query
JobInfo	postBulkJob(ProductsViewType productsViewType, BulkLookupQuery query) Posts a bulk job for the appropriate resource type for lookup cases
JobInfo	postBulkJob(ProductsViewType productsViewType, BulkProductsQuery query) Posts a bulk job for the appropriate resource type for search cases

Method Detail

postBulkJob

JobInfo postBulkJob(ProductsViewType productsViewType,
                  BulkProductsQuery query)
                    throws IndixApiException,
                           IOException,
                           URISyntaxException

Posts a bulk job for the appropriate resource type for search cases

Parameters:

productsViewType - ProductsViewType

query - Instance of BulkProductsQuery with appropriate parameters

Returns:

JobInfo

Throws:

{@link - IndixApiException}

IndixApiException

IOException

URISyntaxException

postBulkJob

JobInfo postBulkJob(ProductsViewType productsViewType,
                  BulkLookupQuery query)
                    throws IndixApiException,
                           IOException,
                           URISyntaxException

Posts a bulk job for the appropriate resource type for lookup cases

Parameters:

productsViewType - ProductsViewType

query - Instance of BulkLookupQuery with appropriate parameters

Returns:

JobInfo

Throws:

{@link - IndixApiException}

IndixApiException

IOException

URISyntaxException

getBulkJobStatus

JobInfo getBulkJobStatus(JobQuery query)
                         throws IndixApiException,
                                IOException,
                                URISyntaxException

get status of job returned against bulk query

Parameters:

query - Instance of JobQuery with appropriate jobId

Returns:

JobInfo

Throws:

{@link - IndixApiException}

IndixApiException

IOException

URISyntaxException

getBulkJobOutput

InputStream getBulkJobOutput(JobQuery query)
                             throws IndixApiException,
                                    IOException,
                                    URISyntaxException

get output of job returned against bulk query

Parameters:

query - Instance of JobQuery with appropriate jobId

Returns:

stream of data obtained as response from the bulk job

Throws:

{@link - IndixApiException}

IndixApiException

IOException

URISyntaxException