Package com.cognite.client.servicesV1.request

Class GetJobIdRequestProvider

java.lang.Object

com.cognite.client.servicesV1.request.GetJobIdRequestProvider

All Implemented Interfaces:

RequestProvider, Serializable

public abstract class GetJobIdRequestProvider
extends Object

Builds request to get results from an async api job based on a jobId. Used by various context api services as most context services are based on an async api pattern. Job id is specified via the Request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetJobIdRequestProvider.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	apiVersion
protected org.slf4j.Logger	LOG
protected String	randomIdString

Constructor Summary

Constructors

Constructor	Description
GetJobIdRequestProvider()

Method Summary

Modifier and Type	Method	Description
protected okhttp3.Request.Builder	buildGenericRequest()
protected okhttp3.HttpUrl.Builder	buildGenericUrl()
okhttp3.Request	buildRequest(Optional<String> cursor)	Builds a request based on the basline RequestParameters provided via the withRequestParameters method.
abstract String	getAppIdentifier()
abstract String	getEndpoint()
abstract Request	getRequest()
abstract String	getSdkIdentifier()
abstract String	getSessionIdentifier()
abstract boolean	isBetaEnabled()
static GetJobIdRequestProvider	of(String endpoint)	Returns a request provider that will get job results from a jobId endpoint.
abstract GetJobIdRequestProvider.Builder	toBuilder()
GetJobIdRequestProvider	withRequest(Request parameters)	Set the baseline Request to build requests from.

Methods inherited from class java.lang.Object

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

Field Detail

apiVersion

protected static final String apiVersion

See Also:

Constant Field Values

LOG

protected final org.slf4j.Logger LOG

randomIdString

protected final String randomIdString

Constructor Detail

GetJobIdRequestProvider

public GetJobIdRequestProvider()

Method Detail

of

public static GetJobIdRequestProvider of(String endpoint)

Returns a request provider that will get job results from a jobId endpoint.

Returns:

toBuilder

public abstract GetJobIdRequestProvider.Builder toBuilder()

withRequest

public GetJobIdRequestProvider withRequest(Request parameters)

Description copied from interface: RequestProvider

Set the baseline Request to build requests from. This is typically the application-provided Request that kicks off a potential series of requests (in the case of iterating over a results set). This baseline Request do not change over the life-cycle of a request-response series.

Returns:

buildRequest

public okhttp3.Request buildRequest(Optional<String> cursor)
                             throws URISyntaxException

Description copied from interface: RequestProvider

Builds a request based on the basline RequestParameters provided via the withRequestParameters method. If a cursor is provided, this will typically lead the RequestProvider to modify the underlying Request. In order to get the exact Request used to build the latest request, call the getEffectiveRequestParameters method.

Returns:

Throws:

URISyntaxException

getSdkIdentifier

public abstract String getSdkIdentifier()

getAppIdentifier

public abstract String getAppIdentifier()

getSessionIdentifier

public abstract String getSessionIdentifier()

getEndpoint

public abstract String getEndpoint()

getRequest

public abstract Request getRequest()

isBetaEnabled

public abstract boolean isBetaEnabled()

buildGenericRequest

protected okhttp3.Request.Builder buildGenericRequest()
                                               throws URISyntaxException

Throws:

URISyntaxException

buildGenericUrl

protected okhttp3.HttpUrl.Builder buildGenericUrl()
                                           throws URISyntaxException

Throws:

URISyntaxException