com.criteo.marketing.model

Class AudienceError

java.lang.Object

com.criteo.marketing.model.AudienceError

public class AudienceError
extends java.lang.Object

Definition of an audience error

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AudienceError.TypeEnum (REQUIRED) The classification of the error

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_STACK_TRACE
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
AudienceError()

Method Summary

Modifier and Type	Method and Description
AudienceError	addStackTraceItem(java.lang.String stackTraceItem)
AudienceError	code(java.lang.String code)
AudienceError	detail(java.lang.String detail)
boolean	equals(java.lang.Object o)
java.lang.String	getCode() (REQUIRED) A machine-readable unique error code, expressed as a string value.
java.lang.String	getDetail() (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem
java.lang.String	getInstance() (REQUIRED) A URI reference that identifies the specific occurrence of the problem
java.lang.Object	getSource() (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s)
java.util.List<java.lang.String>	getStackTrace() (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology
java.lang.String	getTitle() (RECOMMENDED) A short, human-readable summary of the problem type
java.lang.String	getTraceId() (REQUIRED) The Correlation ID provided by the Gateway.
AudienceError.TypeEnum	getType() (REQUIRED) The classification of the error
int	hashCode()
AudienceError	instance(java.lang.String instance)
void	setCode(java.lang.String code)
void	setDetail(java.lang.String detail)
void	setInstance(java.lang.String instance)
void	setSource(java.lang.Object source)
void	setStackTrace(java.util.List<java.lang.String> stackTrace)
void	setTitle(java.lang.String title)
void	setTraceId(java.lang.String traceId)
void	setType(AudienceError.TypeEnum type)
AudienceError	source(java.lang.Object source)
AudienceError	stackTrace(java.util.List<java.lang.String> stackTrace)
AudienceError	title(java.lang.String title)
java.lang.String	toString()
AudienceError	traceId(java.lang.String traceId)
AudienceError	type(AudienceError.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

SERIALIZED_NAME_STACK_TRACE

public static final java.lang.String SERIALIZED_NAME_STACK_TRACE

See Also:

Constant Field Values

Constructor Detail

AudienceError

public AudienceError()

Method Detail

traceId

public AudienceError traceId(java.lang.String traceId)

getTraceId

@Nullable
public java.lang.String getTraceId()

(REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.

Returns:

traceId

setTraceId

public void setTraceId(java.lang.String traceId)

type

public AudienceError type(AudienceError.TypeEnum type)

getType

public AudienceError.TypeEnum getType()

(REQUIRED) The classification of the error

Returns:

type

setType

public void setType(AudienceError.TypeEnum type)

code

public AudienceError code(java.lang.String code)

getCode

public java.lang.String getCode()

(REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case.

Returns:

code

setCode

public void setCode(java.lang.String code)

instance

public AudienceError instance(java.lang.String instance)

getInstance

public java.lang.String getInstance()

(REQUIRED) A URI reference that identifies the specific occurrence of the problem

Returns:

instance

setInstance

public void setInstance(java.lang.String instance)

title

public AudienceError title(java.lang.String title)

getTitle

@Nullable
public java.lang.String getTitle()

(RECOMMENDED) A short, human-readable summary of the problem type

Returns:

title

setTitle

public void setTitle(java.lang.String title)

detail

public AudienceError detail(java.lang.String detail)

getDetail

@Nullable
public java.lang.String getDetail()

(RECOMMENDED) A human-readable explanation specific to this occurrence of the problem

Returns:

detail

setDetail

public void setDetail(java.lang.String detail)

source

public AudienceError source(java.lang.Object source)

getSource

@Nullable
public java.lang.Object getSource()

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

Returns:

source

setSource

public void setSource(java.lang.Object source)

stackTrace

public AudienceError stackTrace(java.util.List<java.lang.String> stackTrace)

addStackTraceItem

public AudienceError addStackTraceItem(java.lang.String stackTraceItem)

getStackTrace

@Nullable
public java.util.List<java.lang.String> getStackTrace()

(NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology

Returns:

stackTrace

setStackTrace

public void setStackTrace(java.util.List<java.lang.String> stackTrace)

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