Class DashboardChart (0.31.0)

public final class DashboardChart extends GeneratedMessage implements DashboardChartOrBuilder

DashboardChart resource.

Protobuf type google.cloud.chronicle.v1.DashboardChart

Static Fields

CHART_DATASOURCE_FIELD_NUMBER

public static final int CHART_DATASOURCE_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

DRILL_DOWN_CONFIG_FIELD_NUMBER

public static final int DRILL_DOWN_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NATIVE_DASHBOARD_FIELD_NUMBER

public static final int NATIVE_DASHBOARD_FIELD_NUMBER
Field Value
Type Description
int

TILE_TYPE_FIELD_NUMBER

public static final int TILE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

TOKENS_FIELD_NUMBER

public static final int TOKENS_FIELD_NUMBER
Field Value
Type Description
int

VISUALIZATION_FIELD_NUMBER

public static final int VISUALIZATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DashboardChart getDefaultInstance()
Returns
Type Description
DashboardChart

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DashboardChart.Builder newBuilder()
Returns
Type Description
DashboardChart.Builder

newBuilder(DashboardChart prototype)

public static DashboardChart.Builder newBuilder(DashboardChart prototype)
Parameter
Name Description
prototype DashboardChart
Returns
Type Description
DashboardChart.Builder

parseDelimitedFrom(InputStream input)

public static DashboardChart parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DashboardChart
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DashboardChart parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardChart
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DashboardChart parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DashboardChart
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DashboardChart parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardChart
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DashboardChart parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DashboardChart
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DashboardChart parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardChart
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DashboardChart parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DashboardChart
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DashboardChart parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardChart
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DashboardChart parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DashboardChart
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DashboardChart parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardChart
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DashboardChart parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DashboardChart
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DashboardChart parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DashboardChart
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DashboardChart> parser()
Returns
Type Description
Parser<DashboardChart>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getChartDatasource()

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

getDefaultInstanceForType()

public DashboardChart getDefaultInstanceForType()
Returns
Type Description
DashboardChart

getDescription()

public String getDescription()

Optional. Description of the dashboardChart.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public 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 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 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 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 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 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 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 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 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 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 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.

getParserForType()

public Parser<DashboardChart> getParserForType()
Returns
Type Description
Parser<DashboardChart>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTileType()

public 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 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the tokens.

getVisualization()

public 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 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DashboardChart.Builder newBuilderForType()
Returns
Type Description
DashboardChart.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DashboardChart.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DashboardChart.Builder
Overrides

toBuilder()

public DashboardChart.Builder toBuilder()
Returns
Type Description
DashboardChart.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException