Reference documentation and code samples for the Google Cloud Chronicle V1 Client class EditChartRequest.
Request message to edit chart in a dashboard.
Generated from protobuf message google.cloud.chronicle.v1.EditChartRequest
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 edit chart in. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard} |
↳ dashboard_query |
DashboardQuery
Optional. Query for the edited chart. |
↳ dashboard_chart |
DashboardChart
Optional. Edited chart. |
↳ edit_mask |
Google\Protobuf\FieldMask
Required. The list of fields to edit for chart and query. Supported paths in chart are - dashboard_chart.display_name dashboard_chart.description dashboard_chart.chart_datasource.data_sources dashboard_chart.visualization dashboard_chart.visualization.button dashboard_chart.visualization.markdown dashboard_chart.drill_down_config Supported paths in query are - dashboard_query.query dashboard_query.input |
↳ language_features |
int[]
Optional. Language Features present in the query. |
getName
Required. The dashboard name to edit chart in.
Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The dashboard name to edit chart in.
Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDashboardQuery
Optional. Query for the edited chart.
| Returns | |
|---|---|
| Type | Description |
DashboardQuery|null |
|
hasDashboardQuery
clearDashboardQuery
setDashboardQuery
Optional. Query for the edited chart.
| Parameter | |
|---|---|
| Name | Description |
var |
DashboardQuery
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDashboardChart
Optional. Edited chart.
| Returns | |
|---|---|
| Type | Description |
DashboardChart|null |
|
hasDashboardChart
clearDashboardChart
setDashboardChart
Optional. Edited chart.
| Parameter | |
|---|---|
| Name | Description |
var |
DashboardChart
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEditMask
Required. The list of fields to edit for chart and query.
Supported paths in chart are - dashboard_chart.display_name dashboard_chart.description dashboard_chart.chart_datasource.data_sources dashboard_chart.visualization dashboard_chart.visualization.button dashboard_chart.visualization.markdown dashboard_chart.drill_down_config Supported paths in query are - dashboard_query.query dashboard_query.input
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null |
|
hasEditMask
clearEditMask
setEditMask
Required. The list of fields to edit for chart and query.
Supported paths in chart are - dashboard_chart.display_name dashboard_chart.description dashboard_chart.chart_datasource.data_sources dashboard_chart.visualization dashboard_chart.visualization.button dashboard_chart.visualization.markdown dashboard_chart.drill_down_config Supported paths in query are - dashboard_query.query dashboard_query.input
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLanguageFeatures
Optional. Language Features present in the query.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<int> |
|
setLanguageFeatures
Optional. Language Features present in the query.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The dashboard name to edit chart in. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard} Please see NativeDashboardServiceClient::nativeDashboardName() for help formatting this field. |
dashboardQuery |
DashboardQuery
Optional. Query for the edited chart. |
dashboardChart |
DashboardChart
Optional. Edited chart. |
editMask |
Google\Protobuf\FieldMask
Required. The list of fields to edit for chart and query. Supported paths in chart are - dashboard_chart.display_name dashboard_chart.description dashboard_chart.chart_datasource.data_sources dashboard_chart.visualization dashboard_chart.visualization.button dashboard_chart.visualization.markdown dashboard_chart.drill_down_config Supported paths in query are - dashboard_query.query dashboard_query.input |
| Returns | |
|---|---|
| Type | Description |
EditChartRequest |
|