com.datadog.api.client.v1.model

Class LogStreamWidgetDefinition

java.lang.Object

com.datadog.api.client.v1.model.LogStreamWidgetDefinition

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

The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_COLUMNS
static String	JSON_PROPERTY_INDEXES
static String	JSON_PROPERTY_LOGSET
static String	JSON_PROPERTY_MESSAGE_DISPLAY
static String	JSON_PROPERTY_QUERY
static String	JSON_PROPERTY_SHOW_DATE_COLUMN
static String	JSON_PROPERTY_SHOW_MESSAGE_COLUMN
static String	JSON_PROPERTY_SORT
static String	JSON_PROPERTY_TIME
static String	JSON_PROPERTY_TITLE
static String	JSON_PROPERTY_TITLE_ALIGN
static String	JSON_PROPERTY_TITLE_SIZE
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
LogStreamWidgetDefinition()
LogStreamWidgetDefinition(LogStreamWidgetDefinitionType type)

Method Summary

Modifier and Type	Method and Description
LogStreamWidgetDefinition	addColumnsItem(String columnsItem)
LogStreamWidgetDefinition	addIndexesItem(String indexesItem)
LogStreamWidgetDefinition	columns(List<String> columns)
boolean	equals(Object o) Return true if this LogStreamWidgetDefinition 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.
List<String>	getColumns() Which columns to display on the widget.
List<String>	getIndexes() An array of index names to query in the stream.
String	getLogset() Deprecated.
WidgetMessageDisplay	getMessageDisplay() Amount of log lines to display
String	getQuery() Query to filter the log stream with.
Boolean	getShowDateColumn() Whether to show the date column or not
Boolean	getShowMessageColumn() Whether to show the message column or not
WidgetFieldSort	getSort() Which column and order to sort by
WidgetTime	getTime() Time setting for the widget.
String	getTitle() Title of the widget.
WidgetTextAlign	getTitleAlign() How to align the text on the widget.
String	getTitleSize() Size of the title.
LogStreamWidgetDefinitionType	getType() Type of the log stream widget.
int	hashCode()
LogStreamWidgetDefinition	indexes(List<String> indexes)
LogStreamWidgetDefinition	logset(String logset)
LogStreamWidgetDefinition	messageDisplay(WidgetMessageDisplay messageDisplay)
LogStreamWidgetDefinition	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
LogStreamWidgetDefinition	query(String query)
void	setColumns(List<String> columns)
void	setIndexes(List<String> indexes)
void	setLogset(String logset) Deprecated.
void	setMessageDisplay(WidgetMessageDisplay messageDisplay)
void	setQuery(String query)
void	setShowDateColumn(Boolean showDateColumn)
void	setShowMessageColumn(Boolean showMessageColumn)
void	setSort(WidgetFieldSort sort)
void	setTime(WidgetTime time)
void	setTitle(String title)
void	setTitleAlign(WidgetTextAlign titleAlign)
void	setTitleSize(String titleSize)
void	setType(LogStreamWidgetDefinitionType type)
LogStreamWidgetDefinition	showDateColumn(Boolean showDateColumn)
LogStreamWidgetDefinition	showMessageColumn(Boolean showMessageColumn)
LogStreamWidgetDefinition	sort(WidgetFieldSort sort)
LogStreamWidgetDefinition	time(WidgetTime time)
LogStreamWidgetDefinition	title(String title)
LogStreamWidgetDefinition	titleAlign(WidgetTextAlign titleAlign)
LogStreamWidgetDefinition	titleSize(String titleSize)
String	toString()
LogStreamWidgetDefinition	type(LogStreamWidgetDefinitionType type)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_COLUMNS

public static final String JSON_PROPERTY_COLUMNS

See Also:

Constant Field Values

JSON_PROPERTY_INDEXES

public static final String JSON_PROPERTY_INDEXES

See Also:

Constant Field Values

JSON_PROPERTY_LOGSET

public static final String JSON_PROPERTY_LOGSET

See Also:

Constant Field Values

JSON_PROPERTY_MESSAGE_DISPLAY

public static final String JSON_PROPERTY_MESSAGE_DISPLAY

See Also:

Constant Field Values

JSON_PROPERTY_QUERY

public static final String JSON_PROPERTY_QUERY

See Also:

Constant Field Values

JSON_PROPERTY_SHOW_DATE_COLUMN

public static final String JSON_PROPERTY_SHOW_DATE_COLUMN

See Also:

Constant Field Values

JSON_PROPERTY_SHOW_MESSAGE_COLUMN

public static final String JSON_PROPERTY_SHOW_MESSAGE_COLUMN

See Also:

Constant Field Values

JSON_PROPERTY_SORT

public static final String JSON_PROPERTY_SORT

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 Detail

LogStreamWidgetDefinition

public LogStreamWidgetDefinition()

LogStreamWidgetDefinition

public LogStreamWidgetDefinition(LogStreamWidgetDefinitionType type)

Method Detail

columns

public LogStreamWidgetDefinition columns(List<String> columns)

addColumnsItem

public LogStreamWidgetDefinition addColumnsItem(String columnsItem)

getColumns

@Nullable
public List<String> getColumns()

Which columns to display on the widget.

Returns:

columns

setColumns

public void setColumns(List<String> columns)

indexes

public LogStreamWidgetDefinition indexes(List<String> indexes)

addIndexesItem

public LogStreamWidgetDefinition addIndexesItem(String indexesItem)

getIndexes

@Nullable
public List<String> getIndexes()

An array of index names to query in the stream. Use [] to query all indexes at once.

Returns:

indexes

setIndexes

public void setIndexes(List<String> indexes)

logset

public LogStreamWidgetDefinition logset(String logset)

getLogset

@Deprecated
 @Nullable
public String getLogset()

Deprecated.

ID of the log set to use.

Returns:

logset

setLogset

@Deprecated
public void setLogset(String logset)

Deprecated.

messageDisplay

public LogStreamWidgetDefinition messageDisplay(WidgetMessageDisplay messageDisplay)

getMessageDisplay

@Nullable
public WidgetMessageDisplay getMessageDisplay()

Amount of log lines to display

Returns:

messageDisplay

setMessageDisplay

public void setMessageDisplay(WidgetMessageDisplay messageDisplay)

query

public LogStreamWidgetDefinition query(String query)

getQuery

@Nullable
public String getQuery()

Query to filter the log stream with.

Returns:

query

setQuery

public void setQuery(String query)

showDateColumn

public LogStreamWidgetDefinition showDateColumn(Boolean showDateColumn)

getShowDateColumn

@Nullable
public Boolean getShowDateColumn()

Whether to show the date column or not

Returns:

showDateColumn

setShowDateColumn

public void setShowDateColumn(Boolean showDateColumn)

showMessageColumn

public LogStreamWidgetDefinition showMessageColumn(Boolean showMessageColumn)

getShowMessageColumn

@Nullable
public Boolean getShowMessageColumn()

Whether to show the message column or not

Returns:

showMessageColumn

setShowMessageColumn

public void setShowMessageColumn(Boolean showMessageColumn)

sort

public LogStreamWidgetDefinition sort(WidgetFieldSort sort)

getSort

@Nullable
public WidgetFieldSort getSort()

Which column and order to sort by

Returns:

sort

setSort

public void setSort(WidgetFieldSort sort)

time

public LogStreamWidgetDefinition time(WidgetTime time)

getTime

@Nullable
public WidgetTime getTime()

Time setting for the widget.

Returns:

time

setTime

public void setTime(WidgetTime time)

title

public LogStreamWidgetDefinition title(String title)

getTitle

@Nullable
public String getTitle()

Title of the widget.

Returns:

title

setTitle

public void setTitle(String title)

titleAlign

public LogStreamWidgetDefinition 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 LogStreamWidgetDefinition titleSize(String titleSize)

getTitleSize

@Nullable
public String getTitleSize()

Size of the title.

Returns:

titleSize

setTitleSize

public void setTitleSize(String titleSize)

type

public LogStreamWidgetDefinition type(LogStreamWidgetDefinitionType type)

getType

public LogStreamWidgetDefinitionType getType()

Type of the log stream widget.

Returns:

type

setType

public void setType(LogStreamWidgetDefinitionType type)

putAdditionalProperty

public LogStreamWidgetDefinition 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:

LogStreamWidgetDefinition

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 LogStreamWidgetDefinition 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