com.adobe.target.delivery.v1.model

Class MboxResponse

java.lang.Object

com.adobe.target.delivery.v1.model.MboxResponse

Direct Known Subclasses:

PrefetchMboxResponse

public class MboxResponse
extends java.lang.Object

Mbox response object.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	$type

Constructor Summary

Constructors

Constructor and Description
MboxResponse()

Method Summary

Modifier and Type	Method and Description
MboxResponse	$type(java.lang.String $type)
MboxResponse	addMetricsItem(Metric metricsItem)
MboxResponse	addOptionsItem(Option optionsItem)
MboxResponse	analytics(AnalyticsResponse analytics)
boolean	equals(java.lang.Object o)
java.lang.String	get$Type() Get $type
AnalyticsResponse	getAnalytics() Get analytics
java.lang.Integer	getIndex() Indicates that the response is for mbox with the same index, as was specified in the prefetch or execute request.
java.util.List<Metric>	getMetrics() Click metrics.
java.lang.String	getName() The name of the mbox.
java.util.List<Option>	getOptions() The option that was matched for the current mbox.
java.util.Map<java.lang.String,java.lang.Object>	getTrace() The object containing all trace data for the request, only present if the trace token was provided in the request.
int	hashCode()
MboxResponse	index(java.lang.Integer index)
MboxResponse	metrics(java.util.List<Metric> metrics)
MboxResponse	name(java.lang.String name)
MboxResponse	options(java.util.List<Option> options)
MboxResponse	putTraceItem(java.lang.String key, java.lang.Object traceItem)
void	set$Type(java.lang.String $type)
void	setAnalytics(AnalyticsResponse analytics)
void	setIndex(java.lang.Integer index)
void	setMetrics(java.util.List<Metric> metrics)
void	setName(java.lang.String name)
void	setOptions(java.util.List<Option> options)
void	setTrace(java.util.Map<java.lang.String,java.lang.Object> trace)
java.lang.String	toString()
MboxResponse	trace(java.util.Map<java.lang.String,java.lang.Object> trace)

Methods inherited from class java.lang.Object

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

Field Detail

$type

protected java.lang.String $type

Constructor Detail

MboxResponse

public MboxResponse()

Method Detail

$type

public MboxResponse $type(java.lang.String $type)

get$Type

public java.lang.String get$Type()

Get $type

Returns:

$type

set$Type

public void set$Type(java.lang.String $type)

index

public MboxResponse index(java.lang.Integer index)

getIndex

public java.lang.Integer getIndex()

Indicates that the response is for mbox with the same index, as was specified in the prefetch or execute request.

Returns:

index

setIndex

public void setIndex(java.lang.Integer index)

name

public MboxResponse name(java.lang.String name)

getName

public java.lang.String getName()

The name of the mbox. Since the same mbox name can be specified multiple times in the request it should be used in conjunction with the index.

Returns:

name

setName

public void setName(java.lang.String name)

options

public MboxResponse options(java.util.List<Option> options)

addOptionsItem

public MboxResponse addOptionsItem(Option optionsItem)

getOptions

public java.util.List<Option> getOptions()

The option that was matched for the current mbox. Cannot be an offer with templates or a visual offer.

Returns:

options

setOptions

public void setOptions(java.util.List<Option> options)

metrics

public MboxResponse metrics(java.util.List<Metric> metrics)

addMetricsItem

public MboxResponse addMetricsItem(Metric metricsItem)

getMetrics

public java.util.List<Metric> getMetrics()

Click metrics.

Returns:

metrics

setMetrics

public void setMetrics(java.util.List<Metric> metrics)

analytics

public MboxResponse analytics(AnalyticsResponse analytics)

getAnalytics

public AnalyticsResponse getAnalytics()

Get analytics

Returns:

analytics

setAnalytics

public void setAnalytics(AnalyticsResponse analytics)

trace

public MboxResponse trace(java.util.Map<java.lang.String,java.lang.Object> trace)

putTraceItem

public MboxResponse putTraceItem(java.lang.String key,
                                 java.lang.Object traceItem)

getTrace

public java.util.Map<java.lang.String,java.lang.Object> getTrace()

The object containing all trace data for the request, only present if the trace token was provided in the request.

Returns:

trace

setTrace

public void setTrace(java.util.Map<java.lang.String,java.lang.Object> trace)

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