Module org.elasticsearch.xcore
Class TableColumnAttributeBuilder
java.lang.Object
org.elasticsearch.xpack.core.common.table.TableColumnAttributeBuilder
Helper to build
RestTable display attributes-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()static TableColumnAttributeBuilderbuilder()static TableColumnAttributeBuilderstatic TableColumnAttributeBuildersetAliases(String... aliases) Set the various aliases available to this column The API consumer can supply one of these strings in the parameter flags instead of the full column name Default: no configured aliasessetDescription(String description) Human readable description of the column.setDisplayByDefault(Boolean displayByDefault) Whether or not to display the column by default Default: true, always display the columnsetSibling(String sibling) The sibling column for this column If a normal column is included and the sibling is requested, then the sibling is included as well Example: Cat indices, requesting `pri` and wanting the `cs` columns (which have a sibling, pri.cs)GET _cat/indices?pri&h=cs&vss pri.ss 290kb 290kb 230b 230b Default: No siblingsetTextAlignment(TableColumnAttributeBuilder.TextAlign textAlignment) Text alignment for the column when building the table Default:TableColumnAttributeBuilder.TextAlign.LEFT
-
Constructor Details
-
TableColumnAttributeBuilder
public TableColumnAttributeBuilder()
-
-
Method Details
-
builder
-
builder
-
builder
-
setAliases
Set the various aliases available to this column The API consumer can supply one of these strings in the parameter flags instead of the full column name Default: no configured aliases- Parameters:
aliases- Non-null array of strings
-
setDisplayByDefault
Whether or not to display the column by default Default: true, always display the column- Parameters:
displayByDefault- When false, the user must specify to display the column in the REST request
-
setDescription
Human readable description of the column. Consumed via the `help` REST call. Default: "not available"- Parameters:
description- Human readable description
-
setTextAlignment
public TableColumnAttributeBuilder setTextAlignment(TableColumnAttributeBuilder.TextAlign textAlignment) Text alignment for the column when building the table Default:TableColumnAttributeBuilder.TextAlign.LEFT- Parameters:
textAlignment- The desired text alignment
-
setSibling
The sibling column for this column If a normal column is included and the sibling is requested, then the sibling is included as well Example: Cat indices, requesting `pri` and wanting the `cs` columns (which have a sibling, pri.cs)GET _cat/indices?pri&h=cs&vss pri.ss 290kb 290kb 230b 230b Default: No sibling- Parameters:
sibling- The sibling column prefix
-
build
-