Reference documentation and code samples for the Google Cloud Chronicle V1 Client class AddChartRequest.
Request message to add chart in a dashboard.
Generated from protobuf message google.cloud.chronicle.v1.AddChartRequest
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The dashboard name to add chart in. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard} |
↳ dashboard_query |
DashboardQuery
Optional. Query used to create the chart. |
↳ dashboard_chart |
DashboardChart
Required. Chart to be added to the dashboard. |
↳ chart_layout |
DashboardDefinition\ChartConfig\ChartLayout
Required. ChartLayout for newly added chart. |
getName
Required. The dashboard name to add chart in.
Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The dashboard name to add chart in.
Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDashboardQuery
Optional. Query used to create the chart.
| Returns | |
|---|---|
| Type | Description |
DashboardQuery|null |
|
hasDashboardQuery
clearDashboardQuery
setDashboardQuery
Optional. Query used to create the chart.
| Parameter | |
|---|---|
| Name | Description |
var |
DashboardQuery
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDashboardChart
Required. Chart to be added to the dashboard.
| Returns | |
|---|---|
| Type | Description |
DashboardChart|null |
|
hasDashboardChart
clearDashboardChart
setDashboardChart
Required. Chart to be added to the dashboard.
| Parameter | |
|---|---|
| Name | Description |
var |
DashboardChart
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getChartLayout
Required. ChartLayout for newly added chart.
| Returns | |
|---|---|
| Type | Description |
DashboardDefinition\ChartConfig\ChartLayout|null |
|
hasChartLayout
clearChartLayout
setChartLayout
Required. ChartLayout for newly added chart.
| Parameter | |
|---|---|
| Name | Description |
var |
DashboardDefinition\ChartConfig\ChartLayout
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The dashboard name to add chart in. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard} Please see NativeDashboardServiceClient::nativeDashboardName() for help formatting this field. |
dashboardQuery |
DashboardQuery
Optional. Query used to create the chart. |
dashboardChart |
DashboardChart
Required. Chart to be added to the dashboard. |
| Returns | |
|---|---|
| Type | Description |
AddChartRequest |
|