Package com.datadog.api.client.v1.model

Class FunnelWidgetDefinition

java.lang.Object

com.datadog.api.client.v1.model.FunnelWidgetDefinition

@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class FunnelWidgetDefinition
extends Object

The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_DESCRIPTION
static final String	JSON_PROPERTY_GROUPED_DISPLAY
static final String	JSON_PROPERTY_REQUESTS
static final String	JSON_PROPERTY_TIME
static final String	JSON_PROPERTY_TITLE
static final String	JSON_PROPERTY_TITLE_ALIGN
static final String	JSON_PROPERTY_TITLE_SIZE
static final String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
FunnelWidgetDefinition()
FunnelWidgetDefinition(List<FunnelWidgetRequest> requests, FunnelWidgetDefinitionType type)

Method Summary

Modifier and Type	Method	Description
FunnelWidgetDefinition	addRequestsItem(FunnelWidgetRequest requestsItem)
FunnelWidgetDefinition	description(String description)
boolean	equals(Object o)	Return true if this FunnelWidgetDefinition object is equal to o.
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
String	getDescription()	The description of the widget.
FunnelGroupedDisplay	getGroupedDisplay()	Display mode for grouped funnel results.
List<FunnelWidgetRequest>	getRequests()	Request payload used to query items.
WidgetTime	getTime()	Time setting for the widget.
String	getTitle()	The title of the widget.
WidgetTextAlign	getTitleAlign()	How to align the text on the widget.
String	getTitleSize()	The size of the title.
FunnelWidgetDefinitionType	getType()	Type of funnel widget.
FunnelWidgetDefinition	groupedDisplay(FunnelGroupedDisplay groupedDisplay)
int	hashCode()
FunnelWidgetDefinition	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
FunnelWidgetDefinition	requests(List<FunnelWidgetRequest> requests)
void	setDescription(String description)
void	setGroupedDisplay(FunnelGroupedDisplay groupedDisplay)
void	setRequests(List<FunnelWidgetRequest> requests)
void	setTime(WidgetTime time)
void	setTitle(String title)
void	setTitleAlign(WidgetTextAlign titleAlign)
void	setTitleSize(String titleSize)
void	setType(FunnelWidgetDefinitionType type)
FunnelWidgetDefinition	time(WidgetTime time)
FunnelWidgetDefinition	title(String title)
FunnelWidgetDefinition	titleAlign(WidgetTextAlign titleAlign)
FunnelWidgetDefinition	titleSize(String titleSize)
String	toString()
FunnelWidgetDefinition	type(FunnelWidgetDefinitionType type)

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

• Constant Field Values

JSON_PROPERTY_GROUPED_DISPLAY

public static final String JSON_PROPERTY_GROUPED_DISPLAY

See Also:

• Constant Field Values

JSON_PROPERTY_REQUESTS

public static final String JSON_PROPERTY_REQUESTS

See Also:

• Constant Field Values

JSON_PROPERTY_TIME

public static final String JSON_PROPERTY_TIME

See Also:

• Constant Field Values

JSON_PROPERTY_TITLE

public static final String JSON_PROPERTY_TITLE

See Also:

• Constant Field Values

JSON_PROPERTY_TITLE_ALIGN

public static final String JSON_PROPERTY_TITLE_ALIGN

See Also:

• Constant Field Values

JSON_PROPERTY_TITLE_SIZE

public static final String JSON_PROPERTY_TITLE_SIZE

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

Constructor Details

FunnelWidgetDefinition

public FunnelWidgetDefinition()

FunnelWidgetDefinition

public FunnelWidgetDefinition(List<FunnelWidgetRequest> requests,
 FunnelWidgetDefinitionType type)

Method Details

description

public FunnelWidgetDefinition description(String description)

getDescription

@Nullable
public String getDescription()

The description of the widget.

Returns:

description

setDescription

public void setDescription(String description)

groupedDisplay

public FunnelWidgetDefinition groupedDisplay(FunnelGroupedDisplay groupedDisplay)

getGroupedDisplay

@Nullable
public FunnelGroupedDisplay getGroupedDisplay()

Display mode for grouped funnel results.

Returns:

groupedDisplay

setGroupedDisplay

public void setGroupedDisplay(FunnelGroupedDisplay groupedDisplay)

requests

public FunnelWidgetDefinition requests(List<FunnelWidgetRequest> requests)

addRequestsItem

public FunnelWidgetDefinition addRequestsItem(FunnelWidgetRequest requestsItem)

getRequests

public List<FunnelWidgetRequest> getRequests()

Request payload used to query items.

Returns:

requests

setRequests

public void setRequests(List<FunnelWidgetRequest> requests)

time

public FunnelWidgetDefinition time(WidgetTime time)

getTime

@Nullable
public WidgetTime getTime()

Time setting for the widget.

Returns:

time

setTime

public void setTime(WidgetTime time)

title

public FunnelWidgetDefinition title(String title)

getTitle

@Nullable
public String getTitle()

The title of the widget.

Returns:

title

setTitle

public void setTitle(String title)

titleAlign

public FunnelWidgetDefinition titleAlign(WidgetTextAlign titleAlign)

getTitleAlign

@Nullable
public WidgetTextAlign getTitleAlign()

How to align the text on the widget.

Returns:

titleAlign

setTitleAlign

public void setTitleAlign(WidgetTextAlign titleAlign)

titleSize

public FunnelWidgetDefinition titleSize(String titleSize)

getTitleSize

@Nullable
public String getTitleSize()

The size of the title.

Returns:

titleSize

setTitleSize

public void setTitleSize(String titleSize)

type

public FunnelWidgetDefinition type(FunnelWidgetDefinitionType type)

getType

public FunnelWidgetDefinitionType getType()

Type of funnel widget.

Returns:

type

setType

public void setType(FunnelWidgetDefinitionType type)

putAdditionalProperty

public FunnelWidgetDefinition putAdditionalProperty(String key,
 Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - The arbitrary key to set

value - The associated value

Returns:

FunnelWidgetDefinition

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

The additional properties

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - The arbitrary key to get

Returns:

The specific additional property for the given key

equals

public boolean equals(Object o)

Return true if this FunnelWidgetDefinition object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object