Google Cloud Chronicle V1 Client - Class DashboardChart (0.4.0)

Reference documentation and code samples for the Google Cloud Chronicle V1 Client class DashboardChart.

DashboardChart resource.

Generated from protobuf message google.cloud.chronicle.v1.DashboardChart

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Output only. Name of the dashboardChart.

↳ display_name
string

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

↳ description
string

Optional. Description of the dashboardChart.

↳ native_dashboard
string

Output only. NativeDashboard this chart belongs to.

↳ tile_type
int

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

↳ chart_datasource
DashboardChart\ChartDatasource

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

↳ visualization
DashboardChart\Visualization

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

↳ etag
string

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.

↳ drill_down_config
DashboardChart\DrillDownConfig

Optional. Drill down configuration.

↳ tokens
string[]

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.

getName

Output only. Name of the dashboardChart.

Returns
Type
Description
string

setName

Output only. Name of the dashboardChart.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

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

Returns
Type
Description
string

setDisplayName

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDescription

Optional. Description of the dashboardChart.

Returns
Type
Description
string

setDescription

Optional. Description of the dashboardChart.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getNativeDashboard

Output only. NativeDashboard this chart belongs to.

Returns
Type
Description
string

setNativeDashboard

Output only. NativeDashboard this chart belongs to.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTileType

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

Returns
Type
Description
int
Enum of type TileType .

setTileType

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

Parameter
Name
Description
var
int

Enum of type TileType .

Returns
Type
Description
$this

getChartDatasource

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

Returns
Type
Description

hasChartDatasource

clearChartDatasource

setChartDatasource

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

Parameter
Name
Description
Returns
Type
Description
$this

getVisualization

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

Returns
Type
Description

hasVisualization

clearVisualization

setVisualization

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

Parameter
Name
Description
Returns
Type
Description
$this

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.

Returns
Type
Description
string

setEtag

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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDrillDownConfig

Optional. Drill down configuration.

Returns
Type
Description

hasDrillDownConfig

clearDrillDownConfig

setDrillDownConfig

Optional. Drill down configuration.

Parameter
Name
Description
Returns
Type
Description
$this

getTokens

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.

Returns
Type
Description

setTokens

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.

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: