com.criteo.marketing.model

Class CriteoApiError

java.lang.Object

com.criteo.marketing.model.CriteoApiError

public class CriteoApiError
extends java.lang.Object

Criteo API response error

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CriteoApiError.CodeEnum A machine-readable error code string in kabab-case.
static class	CriteoApiError.TypeEnum A machine-readable code specifying error category

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SERIALIZED_NAME_CODE
static java.lang.String	SERIALIZED_NAME_DETAIL
static java.lang.String	SERIALIZED_NAME_INSTANCE
static java.lang.String	SERIALIZED_NAME_SOURCE
static java.lang.String	SERIALIZED_NAME_TITLE
static java.lang.String	SERIALIZED_NAME_TRACE_ID
static java.lang.String	SERIALIZED_NAME_TYPE

Constructor Summary

Constructors

Constructor and Description
CriteoApiError()

Method Summary

Modifier and Type	Method and Description
CriteoApiError	code(CriteoApiError.CodeEnum code)
CriteoApiError	detail(java.lang.String detail)
boolean	equals(java.lang.Object o)
CriteoApiError.CodeEnum	getCode() A machine-readable error code string in kabab-case.
java.lang.String	getDetail() A human-readable explanation specific to this occurrence of the problem.
java.lang.String	getInstance() A URI reference that identifies the specific occurrence of the problem
java.util.Map<java.lang.String,java.lang.String>	getSource() A machine-readable structure to reference to the exact location(s) causing the error(s).
java.lang.String	getTitle() A short, human-readable summary of the problem type.
java.lang.String	getTraceId() The correlation ID provided by the gateway
CriteoApiError.TypeEnum	getType() A machine-readable code specifying error category
int	hashCode()
CriteoApiError	instance(java.lang.String instance)
CriteoApiError	putSourceItem(java.lang.String key, java.lang.String sourceItem)
void	setCode(CriteoApiError.CodeEnum code)
void	setDetail(java.lang.String detail)
void	setInstance(java.lang.String instance)
void	setSource(java.util.Map<java.lang.String,java.lang.String> source)
void	setTitle(java.lang.String title)
void	setTraceId(java.lang.String traceId)
void	setType(CriteoApiError.TypeEnum type)
CriteoApiError	source(java.util.Map<java.lang.String,java.lang.String> source)
CriteoApiError	title(java.lang.String title)
java.lang.String	toString()
CriteoApiError	traceId(java.lang.String traceId)
CriteoApiError	type(CriteoApiError.TypeEnum type)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_TRACE_ID

public static final java.lang.String SERIALIZED_NAME_TRACE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_TYPE

public static final java.lang.String SERIALIZED_NAME_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_CODE

public static final java.lang.String SERIALIZED_NAME_CODE

See Also:

Constant Field Values

SERIALIZED_NAME_INSTANCE

public static final java.lang.String SERIALIZED_NAME_INSTANCE

See Also:

Constant Field Values

SERIALIZED_NAME_TITLE

public static final java.lang.String SERIALIZED_NAME_TITLE

See Also:

Constant Field Values

SERIALIZED_NAME_DETAIL

public static final java.lang.String SERIALIZED_NAME_DETAIL

See Also:

Constant Field Values

SERIALIZED_NAME_SOURCE

public static final java.lang.String SERIALIZED_NAME_SOURCE

See Also:

Constant Field Values

Constructor Detail

CriteoApiError

public CriteoApiError()

Method Detail

traceId

public CriteoApiError traceId(java.lang.String traceId)

getTraceId

@Nullable
public java.lang.String getTraceId()

The correlation ID provided by the gateway

Returns:

traceId

setTraceId

public void setTraceId(java.lang.String traceId)

type

public CriteoApiError type(CriteoApiError.TypeEnum type)

getType

@Nullable
public CriteoApiError.TypeEnum getType()

A machine-readable code specifying error category

Returns:

type

setType

public void setType(CriteoApiError.TypeEnum type)

code

public CriteoApiError code(CriteoApiError.CodeEnum code)

getCode

@Nullable
public CriteoApiError.CodeEnum getCode()

A machine-readable error code string in kabab-case. Unique across Criteo

Returns:

code

setCode

public void setCode(CriteoApiError.CodeEnum code)

instance

public CriteoApiError instance(java.lang.String instance)

getInstance

@Nullable
public java.lang.String getInstance()

A URI reference that identifies the specific occurrence of the problem

Returns:

instance

setInstance

public void setInstance(java.lang.String instance)

title

public CriteoApiError title(java.lang.String title)

getTitle

@Nullable
public java.lang.String getTitle()

A short, human-readable summary of the problem type.

Returns:

title

setTitle

public void setTitle(java.lang.String title)

detail

public CriteoApiError detail(java.lang.String detail)

getDetail

@Nullable
public java.lang.String getDetail()

A human-readable explanation specific to this occurrence of the problem.

Returns:

detail

setDetail

public void setDetail(java.lang.String detail)

source

public CriteoApiError source(java.util.Map<java.lang.String,java.lang.String> source)

putSourceItem

public CriteoApiError putSourceItem(java.lang.String key,
                                    java.lang.String sourceItem)

getSource

@Nullable
public java.util.Map<java.lang.String,java.lang.String> getSource()

A machine-readable structure to reference to the exact location(s) causing the error(s).

Returns:

source

setSource

public void setSource(java.util.Map<java.lang.String,java.lang.String> source)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object