com.textkernel.tx

Class TxClient

java.lang.Object

com.textkernel.tx.TxClient

public class TxClient
extends Object

The SDK client to perform Tx API calls.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ShowFullRequestBodyInExceptions Set to true for debugging API errors.

Constructor Summary

Constructors

Constructor and Description
TxClient(TxClientSettings settings) Create an SDK client to perform Tx API calls
TxClient(TxClientSettings settings, long httpTimeoutSecs) Create an SDK client to perform Tx API calls

Method Summary

Modifier and Type	Method and Description
AccountService	account()
FormatterService	formatter()
GeocoderService	geocoder()
ParserService	parser()
SearchMatchService	searchMatchV1()
MatchV2Service	searchMatchV2()
SkillsIntelligenceService	skillsIntelligence()

Methods inherited from class java.lang.Object

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

Field Detail

ShowFullRequestBodyInExceptions

public static boolean ShowFullRequestBodyInExceptions

Set to true for debugging API errors. It will show the full JSON request body in TxException.RequestBody
NOTE: do not set this to true in your production system, as it increases the memory footprint

Constructor Detail

TxClient

public TxClient(TxClientSettings settings)

Create an SDK client to perform Tx API calls

Parameters:

settings - - The settings for this client

Throws:

IllegalArgumentException - if the accountId, serviceKey, or dataCenter are null/empty

TxClient

public TxClient(TxClientSettings settings,
                long httpTimeoutSecs)

Create an SDK client to perform Tx API calls

Parameters:

settings - - The settings for this client

httpTimeoutSecs - - Optional override for the OkHttp client read timeout (write and connect are 10 seconds, read is 30 seconds by default)

Throws:

IllegalArgumentException - if the accountId, serviceKey, or dataCenter are null/empty

Method Detail

account

public AccountService account()

Returns:

access all endpoints/methods for Accounts

formatter

public FormatterService formatter()

Returns:

access all endpoints/methods for the Resumer Formatter

geocoder

public GeocoderService geocoder()

Returns:

access all endpoints/methods for the Geocoder

searchMatchV2

public MatchV2Service searchMatchV2()

Returns:

access all endpoints/methods for Search & Match V2

parser

public ParserService parser()

Returns:

access all endpoints/methods for the Resume & Job Parsers

skillsIntelligence

public SkillsIntelligenceService skillsIntelligence()

Returns:

access all endpoints/methods for Skills Intelligence

searchMatchV1

public SearchMatchService searchMatchV1()

Returns:

access all endpoints/methods for Search & Match V1