Interface DashboardChartOrBuilder (0.31.0)

public interface DashboardChartOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getChartDatasource()

public abstract DashboardChart.ChartDatasource getChartDatasource()

Optional. Query and datasource used in the chart. Should be empty for Button Tiles.

.google.cloud.chronicle.v1.DashboardChart.ChartDatasource chart_datasource = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DashboardChart.ChartDatasource

The chartDatasource.

getChartDatasourceOrBuilder()

public abstract DashboardChart.ChartDatasourceOrBuilder getChartDatasourceOrBuilder()

Optional. Query and datasource used in the chart. Should be empty for Button Tiles.

.google.cloud.chronicle.v1.DashboardChart.ChartDatasource chart_datasource = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DashboardChart.ChartDatasourceOrBuilder

getDescription()

public abstract String getDescription()

Optional. Description of the dashboardChart.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. Description of the dashboardChart.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Required. Display name/Title of the dashboardChart visible to users.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. Display name/Title of the dashboardChart visible to users.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getDrillDownConfig()

public abstract DashboardChart.DrillDownConfig getDrillDownConfig()

Optional. Drill down configuration.

.google.cloud.chronicle.v1.DashboardChart.DrillDownConfig drill_down_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DashboardChart.DrillDownConfig

The drillDownConfig.

getDrillDownConfigOrBuilder()

public abstract DashboardChart.DrillDownConfigOrBuilder getDrillDownConfigOrBuilder()

Optional. Drill down configuration.

.google.cloud.chronicle.v1.DashboardChart.DrillDownConfig drill_down_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DashboardChart.DrillDownConfigOrBuilder

getEtag()

public abstract String getEtag()

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for etag.

getName()

public abstract String getName()

Output only. Name of the dashboardChart.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. Name of the dashboardChart.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getNativeDashboard()

public abstract String getNativeDashboard()

Output only. NativeDashboard this chart belongs to.

string native_dashboard = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The nativeDashboard.

getNativeDashboardBytes()

public abstract ByteString getNativeDashboardBytes()

Output only. NativeDashboard this chart belongs to.

string native_dashboard = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for nativeDashboard.

getTileType()

public abstract TileType getTileType()

Optional. Type of tile i.e., visualization, button or text.

.google.cloud.chronicle.v1.TileType tile_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TileType

The tileType.

getTileTypeValue()

public abstract int getTileTypeValue()

Optional. Type of tile i.e., visualization, button or text.

.google.cloud.chronicle.v1.TileType tile_type = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for tileType.

getTokens(int index)

public abstract String getTokens(int index)

Optional. List of Advanced Filter tokens used in this chart's query (e.g., "hostname", "ip"). This allows the UI to identify dependencies without parsing the query text. The tokens are stored without the wrapping '$' characters. The number of tokens are not expected to be more than 10.

repeated string tokens = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The tokens at the given index.

getTokensBytes(int index)

public abstract ByteString getTokensBytes(int index)

Optional. List of Advanced Filter tokens used in this chart's query (e.g., "hostname", "ip"). This allows the UI to identify dependencies without parsing the query text. The tokens are stored without the wrapping '$' characters. The number of tokens are not expected to be more than 10.

repeated string tokens = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the tokens at the given index.

getTokensCount()

public abstract int getTokensCount()

Optional. List of Advanced Filter tokens used in this chart's query (e.g., "hostname", "ip"). This allows the UI to identify dependencies without parsing the query text. The tokens are stored without the wrapping '$' characters. The number of tokens are not expected to be more than 10.

repeated string tokens = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of tokens.

getTokensList()

public abstract List<String> getTokensList()

Optional. List of Advanced Filter tokens used in this chart's query (e.g., "hostname", "ip"). This allows the UI to identify dependencies without parsing the query text. The tokens are stored without the wrapping '$' characters. The number of tokens are not expected to be more than 10.

repeated string tokens = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the tokens.

getVisualization()

public abstract DashboardChart.Visualization getVisualization()

Required. Depending on tile_type one of below fields will be required.

.google.cloud.chronicle.v1.DashboardChart.Visualization visualization = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DashboardChart.Visualization

The visualization.

getVisualizationOrBuilder()

public abstract DashboardChart.VisualizationOrBuilder getVisualizationOrBuilder()

Required. Depending on tile_type one of below fields will be required.

.google.cloud.chronicle.v1.DashboardChart.Visualization visualization = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DashboardChart.VisualizationOrBuilder

hasChartDatasource()

public abstract boolean hasChartDatasource()

Optional. Query and datasource used in the chart. Should be empty for Button Tiles.

.google.cloud.chronicle.v1.DashboardChart.ChartDatasource chart_datasource = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the chartDatasource field is set.

hasDrillDownConfig()

public abstract boolean hasDrillDownConfig()

Optional. Drill down configuration.

.google.cloud.chronicle.v1.DashboardChart.DrillDownConfig drill_down_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the drillDownConfig field is set.

hasVisualization()

public abstract boolean hasVisualization()

Required. Depending on tile_type one of below fields will be required.

.google.cloud.chronicle.v1.DashboardChart.Visualization visualization = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the visualization field is set.