Package com.mindee.v2.http

Class MindeeHttpApiV2

java.lang.Object

com.mindee.http.MindeeApiCommon

com.mindee.v2.http.MindeeApiV2

com.mindee.v2.http.MindeeHttpApiV2

public final class MindeeHttpApiV2
extends MindeeApiV2

HTTP Client class for the V2 API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MindeeHttpApiV2.MindeeHttpApiV2Builder

Constructor Summary

Constructors

Constructor	Description
MindeeHttpApiV2(MindeeSettings mindeeSettings)

Method Summary

Modifier and Type	Method	Description
static MindeeHttpApiV2.MindeeHttpApiV2Builder	builder()
JobResponse	reqGetJobById(String jobId)	Attempts to poll the queue.
<TResponse extends CommonResponse> TResponse	reqGetResultById(Class<TResponse> responseClass, String inferenceId)	Retrieves the inference from a 302 redirect.
<TResponse extends CommonResponse> TResponse	reqGetResultByUrl(Class<TResponse> responseClass, String inferenceUrl)	Retrieves the inference from a given URL.
<TSearchResponse extends BaseSearchResponse> TSearchResponse	reqGetSearch(BaseSearchParameters<TSearchResponse> parameters)	Retrieves a list of resources with the given criteria.
SearchResponse	reqGetSearch(ModelSearchParameters parameters)	Deprecated.
JobResponse	reqPostEnqueue(LocalInputSource inputSource, BaseProductParameters parameters)	Enqueues a doc with the POST method.
JobResponse	reqPostEnqueue(URLInputSource inputSource, BaseProductParameters options)	Enqueues a doc with the POST method.

Methods inherited from class com.mindee.v2.http.MindeeApiV2

getParamsProductAttributes, getResponseProductAttributes, makeUnknownError

Methods inherited from class com.mindee.http.MindeeApiCommon

getUserAgent, isInvalidStatusCode, readRawResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MindeeHttpApiV2

public MindeeHttpApiV2(MindeeSettings mindeeSettings)

Method Detail

reqPostEnqueue

public JobResponse reqPostEnqueue(LocalInputSource inputSource,
                                  BaseProductParameters parameters)

Enqueues a doc with the POST method.

Specified by:

reqPostEnqueue in class MindeeApiV2

Parameters:

inputSource - Input source to send.

parameters - Options to send the file along with.

Returns:

A job response.

reqPostEnqueue

public JobResponse reqPostEnqueue(URLInputSource inputSource,
                                  BaseProductParameters options)

Enqueues a doc with the POST method.

Specified by:

reqPostEnqueue in class MindeeApiV2

Parameters:

inputSource - Input source to send.

options - Options to send the file along with.

Returns:

A job response.

reqGetJobById

public JobResponse reqGetJobById(String jobId)

Description copied from class: MindeeApiV2

Attempts to poll the queue.

Specified by:

reqGetJobById in class MindeeApiV2

Parameters:

jobId - id of the job to get.

reqGetResultById

public <TResponse extends CommonResponse> TResponse reqGetResultById(Class<TResponse> responseClass,
                                                                     String inferenceId)

Description copied from class: MindeeApiV2

Retrieves the inference from a 302 redirect.

Specified by:

reqGetResultById in class MindeeApiV2

inferenceId - ID of the inference to poll.

reqGetResultByUrl

public <TResponse extends CommonResponse> TResponse reqGetResultByUrl(Class<TResponse> responseClass,
                                                                      String inferenceUrl)

Description copied from class: MindeeApiV2

Retrieves the inference from a given URL. The inference will only be available after it has finished processing.

Specified by:

reqGetResultByUrl in class MindeeApiV2

reqGetSearch

public <TSearchResponse extends BaseSearchResponse> TSearchResponse reqGetSearch(BaseSearchParameters<TSearchResponse> parameters)

Description copied from class: MindeeApiV2

Retrieves a list of resources with the given criteria.

Specified by:

reqGetSearch in class MindeeApiV2

reqGetSearch

@Deprecated
public SearchResponse reqGetSearch(ModelSearchParameters parameters)

Deprecated.

Specified by:

reqGetSearch in class MindeeApiV2

builder

public static MindeeHttpApiV2.MindeeHttpApiV2Builder builder()