Class: Google::Cloud::Chronicle::V1::DashboardChart
- Inherits:
-
Object
- Object
- Google::Cloud::Chronicle::V1::DashboardChart
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/chronicle/v1/dashboard_chart.rb
Overview
DashboardChart resource.
Defined Under Namespace
Classes: ChartDatasource, DrillDownConfig, Visualization
Instance Attribute Summary collapse
-
#chart_datasource ⇒ ::Google::Cloud::Chronicle::V1::DashboardChart::ChartDatasource
Optional.
-
#description ⇒ ::String
Optional.
-
#display_name ⇒ ::String
Required.
-
#drill_down_config ⇒ ::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig
Optional.
-
#etag ⇒ ::String
Optional.
-
#name ⇒ ::String
readonly
Output only.
-
#native_dashboard ⇒ ::String
readonly
Output only.
-
#tile_type ⇒ ::Google::Cloud::Chronicle::V1::TileType
Optional.
-
#tokens ⇒ ::Array<::String>
Optional.
-
#visualization ⇒ ::Google::Cloud::Chronicle::V1::DashboardChart::Visualization
Required.
Instance Attribute Details
#chart_datasource ⇒ ::Google::Cloud::Chronicle::V1::DashboardChart::ChartDatasource
Returns Optional. Query and datasource used in the chart. Should be empty for Button Tiles.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 |
# File 'proto_docs/google/cloud/chronicle/v1/dashboard_chart.rb', line 62 class DashboardChart include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Datasource of the chart including the query reference and source name. # @!attribute [rw] dashboard_query # @return [::String] # Reference to dashboard query resource used in the chart. # @!attribute [rw] data_sources # @return [::Array<::Google::Cloud::Chronicle::V1::DataSource>] # Name of the datasource used in the chart. class ChartDatasource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Visualization config for a chart. # https://echarts.apache.org/en/option.html#series # @!attribute [rw] x_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] y_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] series # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series>] # @!attribute [rw] tooltip # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Tooltip] # @!attribute [rw] legends # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Legend>] # @!attribute [rw] column_defs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnDef>] # Column Definition to represent chart as a table. # @!attribute [rw] table_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::TableConfig] # Optional. Configuration for table appearance. # @!attribute [rw] button # @return [::Google::Cloud::Chronicle::V1::Button] # Button config for a chart if tileType is TILE_TYPE_BUTTON. # @!attribute [rw] markdown # @return [::Google::Cloud::Chronicle::V1::Markdown] # Optional. Markdown config for a chart if tileType is TILE_TYPE_MARKDOWN. # @!attribute [rw] series_column # @return [::Array<::String>] # Optional. Selected column for series # @!attribute [rw] grouping_type # @return [::String] # Optional. Selected grouping type for series # @!attribute [rw] google_maps_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig] # Optional. Google Maps config for a chart if type is GOOGLE MAPS. # @!attribute [rw] threshold_coloring_enabled # @return [::Boolean] # Optional. Whether threshold coloring is enabled for the chart. If it's # enabled, the chart will be colored based on the values stored in # VisualMap below. # @!attribute [rw] visual_maps # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap>] # Optional. Visual maps for the chart. class Visualization include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] axis_type # @return [::Google::Cloud::Chronicle::V1::AxisType] # @!attribute [rw] display_name # @return [::String] # @!attribute [rw] min # @return [::Integer] # Minimum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.min # @!attribute [rw] max # @return [::Integer] # Maximum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.max class Axis include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] series_type # @return [::Google::Cloud::Chronicle::V1::SeriesType] # @!attribute [rw] series_name # @return [::String] # user specified series label # @!attribute [rw] show_symbol # @return [::Boolean] # @!attribute [rw] show_background # @return [::Boolean] # @!attribute [rw] stack # @return [::String] # @!attribute [rw] series_stack_strategy # @return [::Google::Cloud::Chronicle::V1::SeriesStackStrategy] # @!attribute [rw] encode # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::Encode] # @!attribute [rw] label # @return [::String] # @!attribute [rw] field # @return [::String] # @!attribute [rw] data_label # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::DataLabel] # Optional. Data label config for a series. # Displays data vaule in the chart # @!attribute [rw] radius # @return [::Array<::String>] # Optional. Used to make a pie chart into a douhnut chart # @!attribute [rw] item_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemStyle] # Optional. Custom styling for chart # @!attribute [rw] series_unique_value # @return [::String] # Optional. Series unique value from the query result # @!attribute [rw] area_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::AreaStyle] # Optional. Custom styling for area chart # @!attribute [rw] item_colors # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemColors] # Optional. Field to be saved for retrieving slice colors for the chart # @!attribute [rw] gauge_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeConfig] # Optional. Field to be saved for retrieving gauge config for gauge chart # @!attribute [rw] metric_trend_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::MetricTrendConfig] # Optional. Fields to capture trend config for metric charts class Series include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] x # @return [::String] # @!attribute [rw] y # @return [::String] # @!attribute [rw] value # @return [::String] # For some type of series that are not in any coordinate system, like # 'pie' # @!attribute [rw] item_name # @return [::String] # This is useful in charts like 'pie', where data item name can be # displayed in legend. class Encode include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Data label config for a series. # @!attribute [rw] show # @return [::Boolean] # Optional. Whether to show data label. class DataLabel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for chart # @!attribute [rw] border_width # @return [::Integer] # Optional. Used to add border width # @!attribute [rw] border_color # @return [::String] # Optional. Used to add border color # @!attribute [rw] color # @return [::String] # Optional. Used to add color class ItemStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for area chart # @!attribute [rw] color # @return [::String] # Optional. Used to add color # @!attribute [rw] origin # @return [::String] # Optional. Used to add origin # @!attribute [rw] shadow_blur # @return [::Integer] # Optional. Used to add shadow blur # @!attribute [rw] shadow_color # @return [::String] # Optional. Used to add shadow color # @!attribute [rw] shadow_offset_x # @return [::Integer] # Optional. Used to add shadow offsetX # @!attribute [rw] shadow_offset_y # @return [::Integer] # Optional. Used to add shadow offsetY # @!attribute [rw] opacity # @return [::Integer] # Optional. Used to add opacity class AreaStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # User selected color and label for the slice of the chart # @!attribute [rw] color # @return [::String] # Optional. User specified color of a pie slice # @!attribute [rw] label # @return [::String] # Optional. User specified label for a pie slice class UserSelectedValues include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Slice containing the key and value for a slice in the chart # @!attribute [rw] key # @return [::String] # Optional. Key for the slice # @!attribute [rw] value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::UserSelectedValues] # Optional. Value for the slice class ChartSliceColor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving slice colors for the chart # @!attribute [rw] colors # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ChartSliceColor>] # Optional. Slice colors array class ItemColors include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] value # @return [::Integer] # Optional. Value for gauge chart # @!attribute [rw] color # @return [::String] # Optional. Color for gauge chart class GaugeValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] base_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Base value for gauge chart # @!attribute [rw] limit_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Limit value for gauge chart # @!attribute [rw] threshold_values # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue>] # Optional. Threshold values for gauge chart class GaugeConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Metric trend config for displaying trend value in Metrics chart # @!attribute [rw] metric_format # @return [::Google::Cloud::Chronicle::V1::MetricFormat] # Optional. Metric chart configuration to display metric trend # @!attribute [rw] show_metric_trend # @return [::Boolean] # Optional. Metric chart configuration to toggle the trend value # display # @!attribute [rw] metric_display_trend # @return [::Google::Cloud::Chronicle::V1::MetricDisplayTrend] # Optional. Metric chart configuration to display the trend value # @!attribute [rw] metric_trend_type # @return [::Google::Cloud::Chronicle::V1::MetricTrendType] # Optional. Metric chart configuration to display trend type whether # regular or inverse class MetricTrendConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] tooltip_trigger # @return [::Google::Cloud::Chronicle::V1::ToolTipTrigger] class Tooltip include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] id # @return [::String] # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] z_level # @return [::Integer] # @!attribute [rw] z # @return [::Integer] # @!attribute [rw] left # @return [::Integer] # @!attribute [rw] top # @return [::Integer] # @!attribute [rw] right # @return [::Integer] # @!attribute [rw] bottom # @return [::Integer] # @!attribute [rw] legend_orient # @return [::Google::Cloud::Chronicle::V1::LegendOrient] # @!attribute [rw] legend_align # @return [::Google::Cloud::Chronicle::V1::LegendAlign] # @!attribute [rw] padding # @return [::Array<::Integer>] class Legend include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column Definition. # @!attribute [rw] field # @return [::String] # Field key in data. # @!attribute [rw] header # @return [::String] # Header name for column. class ColumnDef include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column render type settings. This is used to determine the data render # type of the column in the table. # @!attribute [rw] field # @return [::String] # Optional. Field key in data. # @!attribute [rw] column_render_type # @return [::Google::Cloud::Chronicle::V1::RenderType] # Optional. Column render type. class ColumnRenderTypeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Settings for tooltip for column header and cell. # @!attribute [rw] field # @return [::String] # Required. Field key in data. # @!attribute [rw] header_tooltip_text # @return [::String] # Optional. Column header tooltip text. # @!attribute [rw] cell_tooltip_text # @return [::String] # Optional. Column cell tooltip text. class ColumnTooltipSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration for table appearance. # @!attribute [rw] enable_text_wrap # @return [::Boolean] # Optional. Whether to show the table. # @!attribute [rw] column_render_type_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnRenderTypeSettings>] # Optional. Column render type settings. # @!attribute [rw] column_tooltip_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnTooltipSettings>] # Optional. Settings for tooltip for column header and cell. class TableConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Google Maps config for a chart if chart type is map. # @!attribute [rw] data_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::DataSettings] # Optional. Data settings for the map. # @!attribute [rw] plot_mode # @return [::Google::Cloud::Chronicle::V1::PlotMode] # Optional. Plot mode for the map. This is used to determine whether to # show points, heatmap or both. # @!attribute [rw] map_position # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::MapPosition] # Optional. Map position settings for the map. # @!attribute [rw] point_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::PointSettings] # Optional. Point settings for the map. class GoogleMapsConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Data settings for the map. # @!attribute [rw] latitude_column # @return [::String] # Optional. Latitude column. # @!attribute [rw] longitude_column # @return [::String] # Optional. Longitude column. # @!attribute [rw] count_column # @return [::String] # Optional. Field to count. class DataSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Map position settings for the map. # @!attribute [rw] fit_data # @return [::Boolean] # Optional. Whether to fit the map to the data. # If true, the map will be resized to fit the data. # If false, langitude and longitude will be used to set the map size. # @!attribute [rw] latitude_value # @return [::Float] # Optional. Latitude of the map. # @!attribute [rw] longitude_value # @return [::Float] # Optional. Longitude of the map. # @!attribute [rw] zoom_scale_value # @return [::Float] # Optional. Scale of the map. class MapPosition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Point settings for the map. # @!attribute [rw] point_size_type # @return [::Google::Cloud::Chronicle::V1::PointSizeType] # Optional. Point size type for the map. This is used to # determine the size of the points on the map. # @!attribute [rw] color # @return [::String] # Optional. Color for the point on the map. class PointSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Conveys what range of values should be rendered in what color. This field # is used when threshold_coloring_enabled is true. # @!attribute [rw] visual_map_type # @return [::Google::Cloud::Chronicle::V1::VisualMapType] # Optional. Contains one of the valid visual map types such as # 'continuous' or 'piecewise'. # @!attribute [rw] pieces # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap::VisualMapPiece>] # Optional. Pieces of the visual map. class VisualMap include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An ECharts visual map of type 'piecewise' contain many pieces. Each # piece has a min, max, and color with which it's rendered. # @!attribute [rw] min # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] max # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] color # @return [::String] # Optional. Color to render the piece in when the value is between min # and max. # @!attribute [rw] label # @return [::String] # Optional. Label used in visual map controller. class VisualMapPiece include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end # Drill down configuration. # @!attribute [rw] left_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Left click drill downs. # @!attribute [rw] right_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Right click drill downs. class DrillDownConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down config. # @!attribute [rw] default_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::DefaultDrillDownSettings] # Default drill down settings. # # Note: The following fields are mutually exclusive: `default_settings`, `custom_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] custom_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings] # Custom drill down settings. # # Note: The following fields are mutually exclusive: `custom_settings`, `default_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] id # @return [::String] # Required. ID of the drill down. # @!attribute [rw] display_name # @return [::String] # Required. Display name of the drill down. class DrillDown include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Default drill down settings. # @!attribute [rw] enabled # @return [::Boolean] # Required. Whether the default drill down is enabled. class DefaultDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom drill down settings. # @!attribute [rw] query # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownQuery] # Drill down query action config. # # Note: The following fields are mutually exclusive: `query`, `filter`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] filter # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter] # Drill down filter action config. # # Note: The following fields are mutually exclusive: `filter`, `query`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] external_link # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownExternalLink] # Drill down external link action config. # # Note: The following fields are mutually exclusive: `external_link`, `query`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] new_tab # @return [::Boolean] # Required. Whether to open the drill down action in a new tab. # @!attribute [rw] left_click_column # @return [::String] # Optional. Table chart column name to associate the custom drill down # action on left click. class CustomDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down query config. # @!attribute [rw] query # @return [::String] # Required. Search query to be executed on drill down. class DrillDownQuery include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Drill down filter config. # @!attribute [rw] dashboard_filters # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter::DrillDownDashboardFilter>] # Required. Dashboard filters to be applied on drill down. class DrillDownFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down dashboard filter config. # @!attribute [rw] dashboard_filter_id # @return [::String] # Required. ID of the dashboard filter. # @!attribute [rw] filter_operator_and_values # @return [::Array<::Google::Cloud::Chronicle::V1::FilterOperatorAndValues>] # Required. Filter operator and field values for the dashboard # filter. class DrillDownDashboardFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Drill down external link config. # @!attribute [rw] link # @return [::String] # Required. External link the drill down action should redirect to. # @!attribute [rw] description # @return [::String] # Optional. Description of the external link. class DrillDownExternalLink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end end end |
#description ⇒ ::String
Returns Optional. Description of the dashboardChart.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 |
# File 'proto_docs/google/cloud/chronicle/v1/dashboard_chart.rb', line 62 class DashboardChart include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Datasource of the chart including the query reference and source name. # @!attribute [rw] dashboard_query # @return [::String] # Reference to dashboard query resource used in the chart. # @!attribute [rw] data_sources # @return [::Array<::Google::Cloud::Chronicle::V1::DataSource>] # Name of the datasource used in the chart. class ChartDatasource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Visualization config for a chart. # https://echarts.apache.org/en/option.html#series # @!attribute [rw] x_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] y_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] series # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series>] # @!attribute [rw] tooltip # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Tooltip] # @!attribute [rw] legends # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Legend>] # @!attribute [rw] column_defs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnDef>] # Column Definition to represent chart as a table. # @!attribute [rw] table_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::TableConfig] # Optional. Configuration for table appearance. # @!attribute [rw] button # @return [::Google::Cloud::Chronicle::V1::Button] # Button config for a chart if tileType is TILE_TYPE_BUTTON. # @!attribute [rw] markdown # @return [::Google::Cloud::Chronicle::V1::Markdown] # Optional. Markdown config for a chart if tileType is TILE_TYPE_MARKDOWN. # @!attribute [rw] series_column # @return [::Array<::String>] # Optional. Selected column for series # @!attribute [rw] grouping_type # @return [::String] # Optional. Selected grouping type for series # @!attribute [rw] google_maps_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig] # Optional. Google Maps config for a chart if type is GOOGLE MAPS. # @!attribute [rw] threshold_coloring_enabled # @return [::Boolean] # Optional. Whether threshold coloring is enabled for the chart. If it's # enabled, the chart will be colored based on the values stored in # VisualMap below. # @!attribute [rw] visual_maps # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap>] # Optional. Visual maps for the chart. class Visualization include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] axis_type # @return [::Google::Cloud::Chronicle::V1::AxisType] # @!attribute [rw] display_name # @return [::String] # @!attribute [rw] min # @return [::Integer] # Minimum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.min # @!attribute [rw] max # @return [::Integer] # Maximum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.max class Axis include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] series_type # @return [::Google::Cloud::Chronicle::V1::SeriesType] # @!attribute [rw] series_name # @return [::String] # user specified series label # @!attribute [rw] show_symbol # @return [::Boolean] # @!attribute [rw] show_background # @return [::Boolean] # @!attribute [rw] stack # @return [::String] # @!attribute [rw] series_stack_strategy # @return [::Google::Cloud::Chronicle::V1::SeriesStackStrategy] # @!attribute [rw] encode # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::Encode] # @!attribute [rw] label # @return [::String] # @!attribute [rw] field # @return [::String] # @!attribute [rw] data_label # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::DataLabel] # Optional. Data label config for a series. # Displays data vaule in the chart # @!attribute [rw] radius # @return [::Array<::String>] # Optional. Used to make a pie chart into a douhnut chart # @!attribute [rw] item_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemStyle] # Optional. Custom styling for chart # @!attribute [rw] series_unique_value # @return [::String] # Optional. Series unique value from the query result # @!attribute [rw] area_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::AreaStyle] # Optional. Custom styling for area chart # @!attribute [rw] item_colors # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemColors] # Optional. Field to be saved for retrieving slice colors for the chart # @!attribute [rw] gauge_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeConfig] # Optional. Field to be saved for retrieving gauge config for gauge chart # @!attribute [rw] metric_trend_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::MetricTrendConfig] # Optional. Fields to capture trend config for metric charts class Series include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] x # @return [::String] # @!attribute [rw] y # @return [::String] # @!attribute [rw] value # @return [::String] # For some type of series that are not in any coordinate system, like # 'pie' # @!attribute [rw] item_name # @return [::String] # This is useful in charts like 'pie', where data item name can be # displayed in legend. class Encode include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Data label config for a series. # @!attribute [rw] show # @return [::Boolean] # Optional. Whether to show data label. class DataLabel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for chart # @!attribute [rw] border_width # @return [::Integer] # Optional. Used to add border width # @!attribute [rw] border_color # @return [::String] # Optional. Used to add border color # @!attribute [rw] color # @return [::String] # Optional. Used to add color class ItemStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for area chart # @!attribute [rw] color # @return [::String] # Optional. Used to add color # @!attribute [rw] origin # @return [::String] # Optional. Used to add origin # @!attribute [rw] shadow_blur # @return [::Integer] # Optional. Used to add shadow blur # @!attribute [rw] shadow_color # @return [::String] # Optional. Used to add shadow color # @!attribute [rw] shadow_offset_x # @return [::Integer] # Optional. Used to add shadow offsetX # @!attribute [rw] shadow_offset_y # @return [::Integer] # Optional. Used to add shadow offsetY # @!attribute [rw] opacity # @return [::Integer] # Optional. Used to add opacity class AreaStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # User selected color and label for the slice of the chart # @!attribute [rw] color # @return [::String] # Optional. User specified color of a pie slice # @!attribute [rw] label # @return [::String] # Optional. User specified label for a pie slice class UserSelectedValues include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Slice containing the key and value for a slice in the chart # @!attribute [rw] key # @return [::String] # Optional. Key for the slice # @!attribute [rw] value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::UserSelectedValues] # Optional. Value for the slice class ChartSliceColor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving slice colors for the chart # @!attribute [rw] colors # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ChartSliceColor>] # Optional. Slice colors array class ItemColors include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] value # @return [::Integer] # Optional. Value for gauge chart # @!attribute [rw] color # @return [::String] # Optional. Color for gauge chart class GaugeValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] base_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Base value for gauge chart # @!attribute [rw] limit_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Limit value for gauge chart # @!attribute [rw] threshold_values # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue>] # Optional. Threshold values for gauge chart class GaugeConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Metric trend config for displaying trend value in Metrics chart # @!attribute [rw] metric_format # @return [::Google::Cloud::Chronicle::V1::MetricFormat] # Optional. Metric chart configuration to display metric trend # @!attribute [rw] show_metric_trend # @return [::Boolean] # Optional. Metric chart configuration to toggle the trend value # display # @!attribute [rw] metric_display_trend # @return [::Google::Cloud::Chronicle::V1::MetricDisplayTrend] # Optional. Metric chart configuration to display the trend value # @!attribute [rw] metric_trend_type # @return [::Google::Cloud::Chronicle::V1::MetricTrendType] # Optional. Metric chart configuration to display trend type whether # regular or inverse class MetricTrendConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] tooltip_trigger # @return [::Google::Cloud::Chronicle::V1::ToolTipTrigger] class Tooltip include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] id # @return [::String] # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] z_level # @return [::Integer] # @!attribute [rw] z # @return [::Integer] # @!attribute [rw] left # @return [::Integer] # @!attribute [rw] top # @return [::Integer] # @!attribute [rw] right # @return [::Integer] # @!attribute [rw] bottom # @return [::Integer] # @!attribute [rw] legend_orient # @return [::Google::Cloud::Chronicle::V1::LegendOrient] # @!attribute [rw] legend_align # @return [::Google::Cloud::Chronicle::V1::LegendAlign] # @!attribute [rw] padding # @return [::Array<::Integer>] class Legend include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column Definition. # @!attribute [rw] field # @return [::String] # Field key in data. # @!attribute [rw] header # @return [::String] # Header name for column. class ColumnDef include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column render type settings. This is used to determine the data render # type of the column in the table. # @!attribute [rw] field # @return [::String] # Optional. Field key in data. # @!attribute [rw] column_render_type # @return [::Google::Cloud::Chronicle::V1::RenderType] # Optional. Column render type. class ColumnRenderTypeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Settings for tooltip for column header and cell. # @!attribute [rw] field # @return [::String] # Required. Field key in data. # @!attribute [rw] header_tooltip_text # @return [::String] # Optional. Column header tooltip text. # @!attribute [rw] cell_tooltip_text # @return [::String] # Optional. Column cell tooltip text. class ColumnTooltipSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration for table appearance. # @!attribute [rw] enable_text_wrap # @return [::Boolean] # Optional. Whether to show the table. # @!attribute [rw] column_render_type_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnRenderTypeSettings>] # Optional. Column render type settings. # @!attribute [rw] column_tooltip_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnTooltipSettings>] # Optional. Settings for tooltip for column header and cell. class TableConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Google Maps config for a chart if chart type is map. # @!attribute [rw] data_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::DataSettings] # Optional. Data settings for the map. # @!attribute [rw] plot_mode # @return [::Google::Cloud::Chronicle::V1::PlotMode] # Optional. Plot mode for the map. This is used to determine whether to # show points, heatmap or both. # @!attribute [rw] map_position # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::MapPosition] # Optional. Map position settings for the map. # @!attribute [rw] point_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::PointSettings] # Optional. Point settings for the map. class GoogleMapsConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Data settings for the map. # @!attribute [rw] latitude_column # @return [::String] # Optional. Latitude column. # @!attribute [rw] longitude_column # @return [::String] # Optional. Longitude column. # @!attribute [rw] count_column # @return [::String] # Optional. Field to count. class DataSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Map position settings for the map. # @!attribute [rw] fit_data # @return [::Boolean] # Optional. Whether to fit the map to the data. # If true, the map will be resized to fit the data. # If false, langitude and longitude will be used to set the map size. # @!attribute [rw] latitude_value # @return [::Float] # Optional. Latitude of the map. # @!attribute [rw] longitude_value # @return [::Float] # Optional. Longitude of the map. # @!attribute [rw] zoom_scale_value # @return [::Float] # Optional. Scale of the map. class MapPosition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Point settings for the map. # @!attribute [rw] point_size_type # @return [::Google::Cloud::Chronicle::V1::PointSizeType] # Optional. Point size type for the map. This is used to # determine the size of the points on the map. # @!attribute [rw] color # @return [::String] # Optional. Color for the point on the map. class PointSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Conveys what range of values should be rendered in what color. This field # is used when threshold_coloring_enabled is true. # @!attribute [rw] visual_map_type # @return [::Google::Cloud::Chronicle::V1::VisualMapType] # Optional. Contains one of the valid visual map types such as # 'continuous' or 'piecewise'. # @!attribute [rw] pieces # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap::VisualMapPiece>] # Optional. Pieces of the visual map. class VisualMap include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An ECharts visual map of type 'piecewise' contain many pieces. Each # piece has a min, max, and color with which it's rendered. # @!attribute [rw] min # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] max # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] color # @return [::String] # Optional. Color to render the piece in when the value is between min # and max. # @!attribute [rw] label # @return [::String] # Optional. Label used in visual map controller. class VisualMapPiece include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end # Drill down configuration. # @!attribute [rw] left_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Left click drill downs. # @!attribute [rw] right_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Right click drill downs. class DrillDownConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down config. # @!attribute [rw] default_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::DefaultDrillDownSettings] # Default drill down settings. # # Note: The following fields are mutually exclusive: `default_settings`, `custom_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] custom_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings] # Custom drill down settings. # # Note: The following fields are mutually exclusive: `custom_settings`, `default_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] id # @return [::String] # Required. ID of the drill down. # @!attribute [rw] display_name # @return [::String] # Required. Display name of the drill down. class DrillDown include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Default drill down settings. # @!attribute [rw] enabled # @return [::Boolean] # Required. Whether the default drill down is enabled. class DefaultDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom drill down settings. # @!attribute [rw] query # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownQuery] # Drill down query action config. # # Note: The following fields are mutually exclusive: `query`, `filter`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] filter # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter] # Drill down filter action config. # # Note: The following fields are mutually exclusive: `filter`, `query`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] external_link # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownExternalLink] # Drill down external link action config. # # Note: The following fields are mutually exclusive: `external_link`, `query`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] new_tab # @return [::Boolean] # Required. Whether to open the drill down action in a new tab. # @!attribute [rw] left_click_column # @return [::String] # Optional. Table chart column name to associate the custom drill down # action on left click. class CustomDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down query config. # @!attribute [rw] query # @return [::String] # Required. Search query to be executed on drill down. class DrillDownQuery include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Drill down filter config. # @!attribute [rw] dashboard_filters # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter::DrillDownDashboardFilter>] # Required. Dashboard filters to be applied on drill down. class DrillDownFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down dashboard filter config. # @!attribute [rw] dashboard_filter_id # @return [::String] # Required. ID of the dashboard filter. # @!attribute [rw] filter_operator_and_values # @return [::Array<::Google::Cloud::Chronicle::V1::FilterOperatorAndValues>] # Required. Filter operator and field values for the dashboard # filter. class DrillDownDashboardFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Drill down external link config. # @!attribute [rw] link # @return [::String] # Required. External link the drill down action should redirect to. # @!attribute [rw] description # @return [::String] # Optional. Description of the external link. class DrillDownExternalLink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end end end |
#display_name ⇒ ::String
Returns Required. Display name/Title of the dashboardChart visible to users.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 |
# File 'proto_docs/google/cloud/chronicle/v1/dashboard_chart.rb', line 62 class DashboardChart include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Datasource of the chart including the query reference and source name. # @!attribute [rw] dashboard_query # @return [::String] # Reference to dashboard query resource used in the chart. # @!attribute [rw] data_sources # @return [::Array<::Google::Cloud::Chronicle::V1::DataSource>] # Name of the datasource used in the chart. class ChartDatasource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Visualization config for a chart. # https://echarts.apache.org/en/option.html#series # @!attribute [rw] x_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] y_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] series # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series>] # @!attribute [rw] tooltip # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Tooltip] # @!attribute [rw] legends # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Legend>] # @!attribute [rw] column_defs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnDef>] # Column Definition to represent chart as a table. # @!attribute [rw] table_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::TableConfig] # Optional. Configuration for table appearance. # @!attribute [rw] button # @return [::Google::Cloud::Chronicle::V1::Button] # Button config for a chart if tileType is TILE_TYPE_BUTTON. # @!attribute [rw] markdown # @return [::Google::Cloud::Chronicle::V1::Markdown] # Optional. Markdown config for a chart if tileType is TILE_TYPE_MARKDOWN. # @!attribute [rw] series_column # @return [::Array<::String>] # Optional. Selected column for series # @!attribute [rw] grouping_type # @return [::String] # Optional. Selected grouping type for series # @!attribute [rw] google_maps_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig] # Optional. Google Maps config for a chart if type is GOOGLE MAPS. # @!attribute [rw] threshold_coloring_enabled # @return [::Boolean] # Optional. Whether threshold coloring is enabled for the chart. If it's # enabled, the chart will be colored based on the values stored in # VisualMap below. # @!attribute [rw] visual_maps # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap>] # Optional. Visual maps for the chart. class Visualization include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] axis_type # @return [::Google::Cloud::Chronicle::V1::AxisType] # @!attribute [rw] display_name # @return [::String] # @!attribute [rw] min # @return [::Integer] # Minimum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.min # @!attribute [rw] max # @return [::Integer] # Maximum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.max class Axis include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] series_type # @return [::Google::Cloud::Chronicle::V1::SeriesType] # @!attribute [rw] series_name # @return [::String] # user specified series label # @!attribute [rw] show_symbol # @return [::Boolean] # @!attribute [rw] show_background # @return [::Boolean] # @!attribute [rw] stack # @return [::String] # @!attribute [rw] series_stack_strategy # @return [::Google::Cloud::Chronicle::V1::SeriesStackStrategy] # @!attribute [rw] encode # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::Encode] # @!attribute [rw] label # @return [::String] # @!attribute [rw] field # @return [::String] # @!attribute [rw] data_label # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::DataLabel] # Optional. Data label config for a series. # Displays data vaule in the chart # @!attribute [rw] radius # @return [::Array<::String>] # Optional. Used to make a pie chart into a douhnut chart # @!attribute [rw] item_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemStyle] # Optional. Custom styling for chart # @!attribute [rw] series_unique_value # @return [::String] # Optional. Series unique value from the query result # @!attribute [rw] area_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::AreaStyle] # Optional. Custom styling for area chart # @!attribute [rw] item_colors # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemColors] # Optional. Field to be saved for retrieving slice colors for the chart # @!attribute [rw] gauge_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeConfig] # Optional. Field to be saved for retrieving gauge config for gauge chart # @!attribute [rw] metric_trend_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::MetricTrendConfig] # Optional. Fields to capture trend config for metric charts class Series include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] x # @return [::String] # @!attribute [rw] y # @return [::String] # @!attribute [rw] value # @return [::String] # For some type of series that are not in any coordinate system, like # 'pie' # @!attribute [rw] item_name # @return [::String] # This is useful in charts like 'pie', where data item name can be # displayed in legend. class Encode include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Data label config for a series. # @!attribute [rw] show # @return [::Boolean] # Optional. Whether to show data label. class DataLabel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for chart # @!attribute [rw] border_width # @return [::Integer] # Optional. Used to add border width # @!attribute [rw] border_color # @return [::String] # Optional. Used to add border color # @!attribute [rw] color # @return [::String] # Optional. Used to add color class ItemStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for area chart # @!attribute [rw] color # @return [::String] # Optional. Used to add color # @!attribute [rw] origin # @return [::String] # Optional. Used to add origin # @!attribute [rw] shadow_blur # @return [::Integer] # Optional. Used to add shadow blur # @!attribute [rw] shadow_color # @return [::String] # Optional. Used to add shadow color # @!attribute [rw] shadow_offset_x # @return [::Integer] # Optional. Used to add shadow offsetX # @!attribute [rw] shadow_offset_y # @return [::Integer] # Optional. Used to add shadow offsetY # @!attribute [rw] opacity # @return [::Integer] # Optional. Used to add opacity class AreaStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # User selected color and label for the slice of the chart # @!attribute [rw] color # @return [::String] # Optional. User specified color of a pie slice # @!attribute [rw] label # @return [::String] # Optional. User specified label for a pie slice class UserSelectedValues include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Slice containing the key and value for a slice in the chart # @!attribute [rw] key # @return [::String] # Optional. Key for the slice # @!attribute [rw] value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::UserSelectedValues] # Optional. Value for the slice class ChartSliceColor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving slice colors for the chart # @!attribute [rw] colors # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ChartSliceColor>] # Optional. Slice colors array class ItemColors include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] value # @return [::Integer] # Optional. Value for gauge chart # @!attribute [rw] color # @return [::String] # Optional. Color for gauge chart class GaugeValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] base_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Base value for gauge chart # @!attribute [rw] limit_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Limit value for gauge chart # @!attribute [rw] threshold_values # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue>] # Optional. Threshold values for gauge chart class GaugeConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Metric trend config for displaying trend value in Metrics chart # @!attribute [rw] metric_format # @return [::Google::Cloud::Chronicle::V1::MetricFormat] # Optional. Metric chart configuration to display metric trend # @!attribute [rw] show_metric_trend # @return [::Boolean] # Optional. Metric chart configuration to toggle the trend value # display # @!attribute [rw] metric_display_trend # @return [::Google::Cloud::Chronicle::V1::MetricDisplayTrend] # Optional. Metric chart configuration to display the trend value # @!attribute [rw] metric_trend_type # @return [::Google::Cloud::Chronicle::V1::MetricTrendType] # Optional. Metric chart configuration to display trend type whether # regular or inverse class MetricTrendConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] tooltip_trigger # @return [::Google::Cloud::Chronicle::V1::ToolTipTrigger] class Tooltip include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] id # @return [::String] # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] z_level # @return [::Integer] # @!attribute [rw] z # @return [::Integer] # @!attribute [rw] left # @return [::Integer] # @!attribute [rw] top # @return [::Integer] # @!attribute [rw] right # @return [::Integer] # @!attribute [rw] bottom # @return [::Integer] # @!attribute [rw] legend_orient # @return [::Google::Cloud::Chronicle::V1::LegendOrient] # @!attribute [rw] legend_align # @return [::Google::Cloud::Chronicle::V1::LegendAlign] # @!attribute [rw] padding # @return [::Array<::Integer>] class Legend include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column Definition. # @!attribute [rw] field # @return [::String] # Field key in data. # @!attribute [rw] header # @return [::String] # Header name for column. class ColumnDef include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column render type settings. This is used to determine the data render # type of the column in the table. # @!attribute [rw] field # @return [::String] # Optional. Field key in data. # @!attribute [rw] column_render_type # @return [::Google::Cloud::Chronicle::V1::RenderType] # Optional. Column render type. class ColumnRenderTypeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Settings for tooltip for column header and cell. # @!attribute [rw] field # @return [::String] # Required. Field key in data. # @!attribute [rw] header_tooltip_text # @return [::String] # Optional. Column header tooltip text. # @!attribute [rw] cell_tooltip_text # @return [::String] # Optional. Column cell tooltip text. class ColumnTooltipSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration for table appearance. # @!attribute [rw] enable_text_wrap # @return [::Boolean] # Optional. Whether to show the table. # @!attribute [rw] column_render_type_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnRenderTypeSettings>] # Optional. Column render type settings. # @!attribute [rw] column_tooltip_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnTooltipSettings>] # Optional. Settings for tooltip for column header and cell. class TableConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Google Maps config for a chart if chart type is map. # @!attribute [rw] data_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::DataSettings] # Optional. Data settings for the map. # @!attribute [rw] plot_mode # @return [::Google::Cloud::Chronicle::V1::PlotMode] # Optional. Plot mode for the map. This is used to determine whether to # show points, heatmap or both. # @!attribute [rw] map_position # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::MapPosition] # Optional. Map position settings for the map. # @!attribute [rw] point_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::PointSettings] # Optional. Point settings for the map. class GoogleMapsConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Data settings for the map. # @!attribute [rw] latitude_column # @return [::String] # Optional. Latitude column. # @!attribute [rw] longitude_column # @return [::String] # Optional. Longitude column. # @!attribute [rw] count_column # @return [::String] # Optional. Field to count. class DataSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Map position settings for the map. # @!attribute [rw] fit_data # @return [::Boolean] # Optional. Whether to fit the map to the data. # If true, the map will be resized to fit the data. # If false, langitude and longitude will be used to set the map size. # @!attribute [rw] latitude_value # @return [::Float] # Optional. Latitude of the map. # @!attribute [rw] longitude_value # @return [::Float] # Optional. Longitude of the map. # @!attribute [rw] zoom_scale_value # @return [::Float] # Optional. Scale of the map. class MapPosition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Point settings for the map. # @!attribute [rw] point_size_type # @return [::Google::Cloud::Chronicle::V1::PointSizeType] # Optional. Point size type for the map. This is used to # determine the size of the points on the map. # @!attribute [rw] color # @return [::String] # Optional. Color for the point on the map. class PointSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Conveys what range of values should be rendered in what color. This field # is used when threshold_coloring_enabled is true. # @!attribute [rw] visual_map_type # @return [::Google::Cloud::Chronicle::V1::VisualMapType] # Optional. Contains one of the valid visual map types such as # 'continuous' or 'piecewise'. # @!attribute [rw] pieces # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap::VisualMapPiece>] # Optional. Pieces of the visual map. class VisualMap include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An ECharts visual map of type 'piecewise' contain many pieces. Each # piece has a min, max, and color with which it's rendered. # @!attribute [rw] min # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] max # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] color # @return [::String] # Optional. Color to render the piece in when the value is between min # and max. # @!attribute [rw] label # @return [::String] # Optional. Label used in visual map controller. class VisualMapPiece include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end # Drill down configuration. # @!attribute [rw] left_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Left click drill downs. # @!attribute [rw] right_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Right click drill downs. class DrillDownConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down config. # @!attribute [rw] default_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::DefaultDrillDownSettings] # Default drill down settings. # # Note: The following fields are mutually exclusive: `default_settings`, `custom_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] custom_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings] # Custom drill down settings. # # Note: The following fields are mutually exclusive: `custom_settings`, `default_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] id # @return [::String] # Required. ID of the drill down. # @!attribute [rw] display_name # @return [::String] # Required. Display name of the drill down. class DrillDown include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Default drill down settings. # @!attribute [rw] enabled # @return [::Boolean] # Required. Whether the default drill down is enabled. class DefaultDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom drill down settings. # @!attribute [rw] query # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownQuery] # Drill down query action config. # # Note: The following fields are mutually exclusive: `query`, `filter`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] filter # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter] # Drill down filter action config. # # Note: The following fields are mutually exclusive: `filter`, `query`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] external_link # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownExternalLink] # Drill down external link action config. # # Note: The following fields are mutually exclusive: `external_link`, `query`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] new_tab # @return [::Boolean] # Required. Whether to open the drill down action in a new tab. # @!attribute [rw] left_click_column # @return [::String] # Optional. Table chart column name to associate the custom drill down # action on left click. class CustomDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down query config. # @!attribute [rw] query # @return [::String] # Required. Search query to be executed on drill down. class DrillDownQuery include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Drill down filter config. # @!attribute [rw] dashboard_filters # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter::DrillDownDashboardFilter>] # Required. Dashboard filters to be applied on drill down. class DrillDownFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down dashboard filter config. # @!attribute [rw] dashboard_filter_id # @return [::String] # Required. ID of the dashboard filter. # @!attribute [rw] filter_operator_and_values # @return [::Array<::Google::Cloud::Chronicle::V1::FilterOperatorAndValues>] # Required. Filter operator and field values for the dashboard # filter. class DrillDownDashboardFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Drill down external link config. # @!attribute [rw] link # @return [::String] # Required. External link the drill down action should redirect to. # @!attribute [rw] description # @return [::String] # Optional. Description of the external link. class DrillDownExternalLink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end end end |
#drill_down_config ⇒ ::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig
Returns Optional. Drill down configuration.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 |
# File 'proto_docs/google/cloud/chronicle/v1/dashboard_chart.rb', line 62 class DashboardChart include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Datasource of the chart including the query reference and source name. # @!attribute [rw] dashboard_query # @return [::String] # Reference to dashboard query resource used in the chart. # @!attribute [rw] data_sources # @return [::Array<::Google::Cloud::Chronicle::V1::DataSource>] # Name of the datasource used in the chart. class ChartDatasource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Visualization config for a chart. # https://echarts.apache.org/en/option.html#series # @!attribute [rw] x_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] y_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] series # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series>] # @!attribute [rw] tooltip # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Tooltip] # @!attribute [rw] legends # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Legend>] # @!attribute [rw] column_defs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnDef>] # Column Definition to represent chart as a table. # @!attribute [rw] table_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::TableConfig] # Optional. Configuration for table appearance. # @!attribute [rw] button # @return [::Google::Cloud::Chronicle::V1::Button] # Button config for a chart if tileType is TILE_TYPE_BUTTON. # @!attribute [rw] markdown # @return [::Google::Cloud::Chronicle::V1::Markdown] # Optional. Markdown config for a chart if tileType is TILE_TYPE_MARKDOWN. # @!attribute [rw] series_column # @return [::Array<::String>] # Optional. Selected column for series # @!attribute [rw] grouping_type # @return [::String] # Optional. Selected grouping type for series # @!attribute [rw] google_maps_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig] # Optional. Google Maps config for a chart if type is GOOGLE MAPS. # @!attribute [rw] threshold_coloring_enabled # @return [::Boolean] # Optional. Whether threshold coloring is enabled for the chart. If it's # enabled, the chart will be colored based on the values stored in # VisualMap below. # @!attribute [rw] visual_maps # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap>] # Optional. Visual maps for the chart. class Visualization include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] axis_type # @return [::Google::Cloud::Chronicle::V1::AxisType] # @!attribute [rw] display_name # @return [::String] # @!attribute [rw] min # @return [::Integer] # Minimum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.min # @!attribute [rw] max # @return [::Integer] # Maximum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.max class Axis include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] series_type # @return [::Google::Cloud::Chronicle::V1::SeriesType] # @!attribute [rw] series_name # @return [::String] # user specified series label # @!attribute [rw] show_symbol # @return [::Boolean] # @!attribute [rw] show_background # @return [::Boolean] # @!attribute [rw] stack # @return [::String] # @!attribute [rw] series_stack_strategy # @return [::Google::Cloud::Chronicle::V1::SeriesStackStrategy] # @!attribute [rw] encode # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::Encode] # @!attribute [rw] label # @return [::String] # @!attribute [rw] field # @return [::String] # @!attribute [rw] data_label # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::DataLabel] # Optional. Data label config for a series. # Displays data vaule in the chart # @!attribute [rw] radius # @return [::Array<::String>] # Optional. Used to make a pie chart into a douhnut chart # @!attribute [rw] item_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemStyle] # Optional. Custom styling for chart # @!attribute [rw] series_unique_value # @return [::String] # Optional. Series unique value from the query result # @!attribute [rw] area_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::AreaStyle] # Optional. Custom styling for area chart # @!attribute [rw] item_colors # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemColors] # Optional. Field to be saved for retrieving slice colors for the chart # @!attribute [rw] gauge_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeConfig] # Optional. Field to be saved for retrieving gauge config for gauge chart # @!attribute [rw] metric_trend_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::MetricTrendConfig] # Optional. Fields to capture trend config for metric charts class Series include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] x # @return [::String] # @!attribute [rw] y # @return [::String] # @!attribute [rw] value # @return [::String] # For some type of series that are not in any coordinate system, like # 'pie' # @!attribute [rw] item_name # @return [::String] # This is useful in charts like 'pie', where data item name can be # displayed in legend. class Encode include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Data label config for a series. # @!attribute [rw] show # @return [::Boolean] # Optional. Whether to show data label. class DataLabel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for chart # @!attribute [rw] border_width # @return [::Integer] # Optional. Used to add border width # @!attribute [rw] border_color # @return [::String] # Optional. Used to add border color # @!attribute [rw] color # @return [::String] # Optional. Used to add color class ItemStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for area chart # @!attribute [rw] color # @return [::String] # Optional. Used to add color # @!attribute [rw] origin # @return [::String] # Optional. Used to add origin # @!attribute [rw] shadow_blur # @return [::Integer] # Optional. Used to add shadow blur # @!attribute [rw] shadow_color # @return [::String] # Optional. Used to add shadow color # @!attribute [rw] shadow_offset_x # @return [::Integer] # Optional. Used to add shadow offsetX # @!attribute [rw] shadow_offset_y # @return [::Integer] # Optional. Used to add shadow offsetY # @!attribute [rw] opacity # @return [::Integer] # Optional. Used to add opacity class AreaStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # User selected color and label for the slice of the chart # @!attribute [rw] color # @return [::String] # Optional. User specified color of a pie slice # @!attribute [rw] label # @return [::String] # Optional. User specified label for a pie slice class UserSelectedValues include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Slice containing the key and value for a slice in the chart # @!attribute [rw] key # @return [::String] # Optional. Key for the slice # @!attribute [rw] value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::UserSelectedValues] # Optional. Value for the slice class ChartSliceColor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving slice colors for the chart # @!attribute [rw] colors # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ChartSliceColor>] # Optional. Slice colors array class ItemColors include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] value # @return [::Integer] # Optional. Value for gauge chart # @!attribute [rw] color # @return [::String] # Optional. Color for gauge chart class GaugeValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] base_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Base value for gauge chart # @!attribute [rw] limit_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Limit value for gauge chart # @!attribute [rw] threshold_values # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue>] # Optional. Threshold values for gauge chart class GaugeConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Metric trend config for displaying trend value in Metrics chart # @!attribute [rw] metric_format # @return [::Google::Cloud::Chronicle::V1::MetricFormat] # Optional. Metric chart configuration to display metric trend # @!attribute [rw] show_metric_trend # @return [::Boolean] # Optional. Metric chart configuration to toggle the trend value # display # @!attribute [rw] metric_display_trend # @return [::Google::Cloud::Chronicle::V1::MetricDisplayTrend] # Optional. Metric chart configuration to display the trend value # @!attribute [rw] metric_trend_type # @return [::Google::Cloud::Chronicle::V1::MetricTrendType] # Optional. Metric chart configuration to display trend type whether # regular or inverse class MetricTrendConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] tooltip_trigger # @return [::Google::Cloud::Chronicle::V1::ToolTipTrigger] class Tooltip include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] id # @return [::String] # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] z_level # @return [::Integer] # @!attribute [rw] z # @return [::Integer] # @!attribute [rw] left # @return [::Integer] # @!attribute [rw] top # @return [::Integer] # @!attribute [rw] right # @return [::Integer] # @!attribute [rw] bottom # @return [::Integer] # @!attribute [rw] legend_orient # @return [::Google::Cloud::Chronicle::V1::LegendOrient] # @!attribute [rw] legend_align # @return [::Google::Cloud::Chronicle::V1::LegendAlign] # @!attribute [rw] padding # @return [::Array<::Integer>] class Legend include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column Definition. # @!attribute [rw] field # @return [::String] # Field key in data. # @!attribute [rw] header # @return [::String] # Header name for column. class ColumnDef include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column render type settings. This is used to determine the data render # type of the column in the table. # @!attribute [rw] field # @return [::String] # Optional. Field key in data. # @!attribute [rw] column_render_type # @return [::Google::Cloud::Chronicle::V1::RenderType] # Optional. Column render type. class ColumnRenderTypeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Settings for tooltip for column header and cell. # @!attribute [rw] field # @return [::String] # Required. Field key in data. # @!attribute [rw] header_tooltip_text # @return [::String] # Optional. Column header tooltip text. # @!attribute [rw] cell_tooltip_text # @return [::String] # Optional. Column cell tooltip text. class ColumnTooltipSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration for table appearance. # @!attribute [rw] enable_text_wrap # @return [::Boolean] # Optional. Whether to show the table. # @!attribute [rw] column_render_type_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnRenderTypeSettings>] # Optional. Column render type settings. # @!attribute [rw] column_tooltip_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnTooltipSettings>] # Optional. Settings for tooltip for column header and cell. class TableConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Google Maps config for a chart if chart type is map. # @!attribute [rw] data_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::DataSettings] # Optional. Data settings for the map. # @!attribute [rw] plot_mode # @return [::Google::Cloud::Chronicle::V1::PlotMode] # Optional. Plot mode for the map. This is used to determine whether to # show points, heatmap or both. # @!attribute [rw] map_position # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::MapPosition] # Optional. Map position settings for the map. # @!attribute [rw] point_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::PointSettings] # Optional. Point settings for the map. class GoogleMapsConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Data settings for the map. # @!attribute [rw] latitude_column # @return [::String] # Optional. Latitude column. # @!attribute [rw] longitude_column # @return [::String] # Optional. Longitude column. # @!attribute [rw] count_column # @return [::String] # Optional. Field to count. class DataSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Map position settings for the map. # @!attribute [rw] fit_data # @return [::Boolean] # Optional. Whether to fit the map to the data. # If true, the map will be resized to fit the data. # If false, langitude and longitude will be used to set the map size. # @!attribute [rw] latitude_value # @return [::Float] # Optional. Latitude of the map. # @!attribute [rw] longitude_value # @return [::Float] # Optional. Longitude of the map. # @!attribute [rw] zoom_scale_value # @return [::Float] # Optional. Scale of the map. class MapPosition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Point settings for the map. # @!attribute [rw] point_size_type # @return [::Google::Cloud::Chronicle::V1::PointSizeType] # Optional. Point size type for the map. This is used to # determine the size of the points on the map. # @!attribute [rw] color # @return [::String] # Optional. Color for the point on the map. class PointSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Conveys what range of values should be rendered in what color. This field # is used when threshold_coloring_enabled is true. # @!attribute [rw] visual_map_type # @return [::Google::Cloud::Chronicle::V1::VisualMapType] # Optional. Contains one of the valid visual map types such as # 'continuous' or 'piecewise'. # @!attribute [rw] pieces # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap::VisualMapPiece>] # Optional. Pieces of the visual map. class VisualMap include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An ECharts visual map of type 'piecewise' contain many pieces. Each # piece has a min, max, and color with which it's rendered. # @!attribute [rw] min # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] max # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] color # @return [::String] # Optional. Color to render the piece in when the value is between min # and max. # @!attribute [rw] label # @return [::String] # Optional. Label used in visual map controller. class VisualMapPiece include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end # Drill down configuration. # @!attribute [rw] left_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Left click drill downs. # @!attribute [rw] right_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Right click drill downs. class DrillDownConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down config. # @!attribute [rw] default_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::DefaultDrillDownSettings] # Default drill down settings. # # Note: The following fields are mutually exclusive: `default_settings`, `custom_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] custom_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings] # Custom drill down settings. # # Note: The following fields are mutually exclusive: `custom_settings`, `default_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] id # @return [::String] # Required. ID of the drill down. # @!attribute [rw] display_name # @return [::String] # Required. Display name of the drill down. class DrillDown include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Default drill down settings. # @!attribute [rw] enabled # @return [::Boolean] # Required. Whether the default drill down is enabled. class DefaultDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom drill down settings. # @!attribute [rw] query # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownQuery] # Drill down query action config. # # Note: The following fields are mutually exclusive: `query`, `filter`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] filter # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter] # Drill down filter action config. # # Note: The following fields are mutually exclusive: `filter`, `query`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] external_link # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownExternalLink] # Drill down external link action config. # # Note: The following fields are mutually exclusive: `external_link`, `query`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] new_tab # @return [::Boolean] # Required. Whether to open the drill down action in a new tab. # @!attribute [rw] left_click_column # @return [::String] # Optional. Table chart column name to associate the custom drill down # action on left click. class CustomDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down query config. # @!attribute [rw] query # @return [::String] # Required. Search query to be executed on drill down. class DrillDownQuery include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Drill down filter config. # @!attribute [rw] dashboard_filters # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter::DrillDownDashboardFilter>] # Required. Dashboard filters to be applied on drill down. class DrillDownFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down dashboard filter config. # @!attribute [rw] dashboard_filter_id # @return [::String] # Required. ID of the dashboard filter. # @!attribute [rw] filter_operator_and_values # @return [::Array<::Google::Cloud::Chronicle::V1::FilterOperatorAndValues>] # Required. Filter operator and field values for the dashboard # filter. class DrillDownDashboardFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Drill down external link config. # @!attribute [rw] link # @return [::String] # Required. External link the drill down action should redirect to. # @!attribute [rw] description # @return [::String] # Optional. Description of the external link. class DrillDownExternalLink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end end end |
#etag ⇒ ::String
Returns 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.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 |
# File 'proto_docs/google/cloud/chronicle/v1/dashboard_chart.rb', line 62 class DashboardChart include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Datasource of the chart including the query reference and source name. # @!attribute [rw] dashboard_query # @return [::String] # Reference to dashboard query resource used in the chart. # @!attribute [rw] data_sources # @return [::Array<::Google::Cloud::Chronicle::V1::DataSource>] # Name of the datasource used in the chart. class ChartDatasource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Visualization config for a chart. # https://echarts.apache.org/en/option.html#series # @!attribute [rw] x_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] y_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] series # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series>] # @!attribute [rw] tooltip # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Tooltip] # @!attribute [rw] legends # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Legend>] # @!attribute [rw] column_defs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnDef>] # Column Definition to represent chart as a table. # @!attribute [rw] table_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::TableConfig] # Optional. Configuration for table appearance. # @!attribute [rw] button # @return [::Google::Cloud::Chronicle::V1::Button] # Button config for a chart if tileType is TILE_TYPE_BUTTON. # @!attribute [rw] markdown # @return [::Google::Cloud::Chronicle::V1::Markdown] # Optional. Markdown config for a chart if tileType is TILE_TYPE_MARKDOWN. # @!attribute [rw] series_column # @return [::Array<::String>] # Optional. Selected column for series # @!attribute [rw] grouping_type # @return [::String] # Optional. Selected grouping type for series # @!attribute [rw] google_maps_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig] # Optional. Google Maps config for a chart if type is GOOGLE MAPS. # @!attribute [rw] threshold_coloring_enabled # @return [::Boolean] # Optional. Whether threshold coloring is enabled for the chart. If it's # enabled, the chart will be colored based on the values stored in # VisualMap below. # @!attribute [rw] visual_maps # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap>] # Optional. Visual maps for the chart. class Visualization include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] axis_type # @return [::Google::Cloud::Chronicle::V1::AxisType] # @!attribute [rw] display_name # @return [::String] # @!attribute [rw] min # @return [::Integer] # Minimum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.min # @!attribute [rw] max # @return [::Integer] # Maximum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.max class Axis include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] series_type # @return [::Google::Cloud::Chronicle::V1::SeriesType] # @!attribute [rw] series_name # @return [::String] # user specified series label # @!attribute [rw] show_symbol # @return [::Boolean] # @!attribute [rw] show_background # @return [::Boolean] # @!attribute [rw] stack # @return [::String] # @!attribute [rw] series_stack_strategy # @return [::Google::Cloud::Chronicle::V1::SeriesStackStrategy] # @!attribute [rw] encode # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::Encode] # @!attribute [rw] label # @return [::String] # @!attribute [rw] field # @return [::String] # @!attribute [rw] data_label # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::DataLabel] # Optional. Data label config for a series. # Displays data vaule in the chart # @!attribute [rw] radius # @return [::Array<::String>] # Optional. Used to make a pie chart into a douhnut chart # @!attribute [rw] item_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemStyle] # Optional. Custom styling for chart # @!attribute [rw] series_unique_value # @return [::String] # Optional. Series unique value from the query result # @!attribute [rw] area_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::AreaStyle] # Optional. Custom styling for area chart # @!attribute [rw] item_colors # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemColors] # Optional. Field to be saved for retrieving slice colors for the chart # @!attribute [rw] gauge_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeConfig] # Optional. Field to be saved for retrieving gauge config for gauge chart # @!attribute [rw] metric_trend_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::MetricTrendConfig] # Optional. Fields to capture trend config for metric charts class Series include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] x # @return [::String] # @!attribute [rw] y # @return [::String] # @!attribute [rw] value # @return [::String] # For some type of series that are not in any coordinate system, like # 'pie' # @!attribute [rw] item_name # @return [::String] # This is useful in charts like 'pie', where data item name can be # displayed in legend. class Encode include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Data label config for a series. # @!attribute [rw] show # @return [::Boolean] # Optional. Whether to show data label. class DataLabel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for chart # @!attribute [rw] border_width # @return [::Integer] # Optional. Used to add border width # @!attribute [rw] border_color # @return [::String] # Optional. Used to add border color # @!attribute [rw] color # @return [::String] # Optional. Used to add color class ItemStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for area chart # @!attribute [rw] color # @return [::String] # Optional. Used to add color # @!attribute [rw] origin # @return [::String] # Optional. Used to add origin # @!attribute [rw] shadow_blur # @return [::Integer] # Optional. Used to add shadow blur # @!attribute [rw] shadow_color # @return [::String] # Optional. Used to add shadow color # @!attribute [rw] shadow_offset_x # @return [::Integer] # Optional. Used to add shadow offsetX # @!attribute [rw] shadow_offset_y # @return [::Integer] # Optional. Used to add shadow offsetY # @!attribute [rw] opacity # @return [::Integer] # Optional. Used to add opacity class AreaStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # User selected color and label for the slice of the chart # @!attribute [rw] color # @return [::String] # Optional. User specified color of a pie slice # @!attribute [rw] label # @return [::String] # Optional. User specified label for a pie slice class UserSelectedValues include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Slice containing the key and value for a slice in the chart # @!attribute [rw] key # @return [::String] # Optional. Key for the slice # @!attribute [rw] value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::UserSelectedValues] # Optional. Value for the slice class ChartSliceColor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving slice colors for the chart # @!attribute [rw] colors # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ChartSliceColor>] # Optional. Slice colors array class ItemColors include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] value # @return [::Integer] # Optional. Value for gauge chart # @!attribute [rw] color # @return [::String] # Optional. Color for gauge chart class GaugeValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] base_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Base value for gauge chart # @!attribute [rw] limit_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Limit value for gauge chart # @!attribute [rw] threshold_values # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue>] # Optional. Threshold values for gauge chart class GaugeConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Metric trend config for displaying trend value in Metrics chart # @!attribute [rw] metric_format # @return [::Google::Cloud::Chronicle::V1::MetricFormat] # Optional. Metric chart configuration to display metric trend # @!attribute [rw] show_metric_trend # @return [::Boolean] # Optional. Metric chart configuration to toggle the trend value # display # @!attribute [rw] metric_display_trend # @return [::Google::Cloud::Chronicle::V1::MetricDisplayTrend] # Optional. Metric chart configuration to display the trend value # @!attribute [rw] metric_trend_type # @return [::Google::Cloud::Chronicle::V1::MetricTrendType] # Optional. Metric chart configuration to display trend type whether # regular or inverse class MetricTrendConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] tooltip_trigger # @return [::Google::Cloud::Chronicle::V1::ToolTipTrigger] class Tooltip include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] id # @return [::String] # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] z_level # @return [::Integer] # @!attribute [rw] z # @return [::Integer] # @!attribute [rw] left # @return [::Integer] # @!attribute [rw] top # @return [::Integer] # @!attribute [rw] right # @return [::Integer] # @!attribute [rw] bottom # @return [::Integer] # @!attribute [rw] legend_orient # @return [::Google::Cloud::Chronicle::V1::LegendOrient] # @!attribute [rw] legend_align # @return [::Google::Cloud::Chronicle::V1::LegendAlign] # @!attribute [rw] padding # @return [::Array<::Integer>] class Legend include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column Definition. # @!attribute [rw] field # @return [::String] # Field key in data. # @!attribute [rw] header # @return [::String] # Header name for column. class ColumnDef include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column render type settings. This is used to determine the data render # type of the column in the table. # @!attribute [rw] field # @return [::String] # Optional. Field key in data. # @!attribute [rw] column_render_type # @return [::Google::Cloud::Chronicle::V1::RenderType] # Optional. Column render type. class ColumnRenderTypeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Settings for tooltip for column header and cell. # @!attribute [rw] field # @return [::String] # Required. Field key in data. # @!attribute [rw] header_tooltip_text # @return [::String] # Optional. Column header tooltip text. # @!attribute [rw] cell_tooltip_text # @return [::String] # Optional. Column cell tooltip text. class ColumnTooltipSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration for table appearance. # @!attribute [rw] enable_text_wrap # @return [::Boolean] # Optional. Whether to show the table. # @!attribute [rw] column_render_type_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnRenderTypeSettings>] # Optional. Column render type settings. # @!attribute [rw] column_tooltip_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnTooltipSettings>] # Optional. Settings for tooltip for column header and cell. class TableConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Google Maps config for a chart if chart type is map. # @!attribute [rw] data_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::DataSettings] # Optional. Data settings for the map. # @!attribute [rw] plot_mode # @return [::Google::Cloud::Chronicle::V1::PlotMode] # Optional. Plot mode for the map. This is used to determine whether to # show points, heatmap or both. # @!attribute [rw] map_position # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::MapPosition] # Optional. Map position settings for the map. # @!attribute [rw] point_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::PointSettings] # Optional. Point settings for the map. class GoogleMapsConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Data settings for the map. # @!attribute [rw] latitude_column # @return [::String] # Optional. Latitude column. # @!attribute [rw] longitude_column # @return [::String] # Optional. Longitude column. # @!attribute [rw] count_column # @return [::String] # Optional. Field to count. class DataSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Map position settings for the map. # @!attribute [rw] fit_data # @return [::Boolean] # Optional. Whether to fit the map to the data. # If true, the map will be resized to fit the data. # If false, langitude and longitude will be used to set the map size. # @!attribute [rw] latitude_value # @return [::Float] # Optional. Latitude of the map. # @!attribute [rw] longitude_value # @return [::Float] # Optional. Longitude of the map. # @!attribute [rw] zoom_scale_value # @return [::Float] # Optional. Scale of the map. class MapPosition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Point settings for the map. # @!attribute [rw] point_size_type # @return [::Google::Cloud::Chronicle::V1::PointSizeType] # Optional. Point size type for the map. This is used to # determine the size of the points on the map. # @!attribute [rw] color # @return [::String] # Optional. Color for the point on the map. class PointSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Conveys what range of values should be rendered in what color. This field # is used when threshold_coloring_enabled is true. # @!attribute [rw] visual_map_type # @return [::Google::Cloud::Chronicle::V1::VisualMapType] # Optional. Contains one of the valid visual map types such as # 'continuous' or 'piecewise'. # @!attribute [rw] pieces # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap::VisualMapPiece>] # Optional. Pieces of the visual map. class VisualMap include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An ECharts visual map of type 'piecewise' contain many pieces. Each # piece has a min, max, and color with which it's rendered. # @!attribute [rw] min # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] max # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] color # @return [::String] # Optional. Color to render the piece in when the value is between min # and max. # @!attribute [rw] label # @return [::String] # Optional. Label used in visual map controller. class VisualMapPiece include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end # Drill down configuration. # @!attribute [rw] left_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Left click drill downs. # @!attribute [rw] right_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Right click drill downs. class DrillDownConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down config. # @!attribute [rw] default_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::DefaultDrillDownSettings] # Default drill down settings. # # Note: The following fields are mutually exclusive: `default_settings`, `custom_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] custom_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings] # Custom drill down settings. # # Note: The following fields are mutually exclusive: `custom_settings`, `default_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] id # @return [::String] # Required. ID of the drill down. # @!attribute [rw] display_name # @return [::String] # Required. Display name of the drill down. class DrillDown include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Default drill down settings. # @!attribute [rw] enabled # @return [::Boolean] # Required. Whether the default drill down is enabled. class DefaultDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom drill down settings. # @!attribute [rw] query # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownQuery] # Drill down query action config. # # Note: The following fields are mutually exclusive: `query`, `filter`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] filter # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter] # Drill down filter action config. # # Note: The following fields are mutually exclusive: `filter`, `query`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] external_link # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownExternalLink] # Drill down external link action config. # # Note: The following fields are mutually exclusive: `external_link`, `query`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] new_tab # @return [::Boolean] # Required. Whether to open the drill down action in a new tab. # @!attribute [rw] left_click_column # @return [::String] # Optional. Table chart column name to associate the custom drill down # action on left click. class CustomDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down query config. # @!attribute [rw] query # @return [::String] # Required. Search query to be executed on drill down. class DrillDownQuery include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Drill down filter config. # @!attribute [rw] dashboard_filters # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter::DrillDownDashboardFilter>] # Required. Dashboard filters to be applied on drill down. class DrillDownFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down dashboard filter config. # @!attribute [rw] dashboard_filter_id # @return [::String] # Required. ID of the dashboard filter. # @!attribute [rw] filter_operator_and_values # @return [::Array<::Google::Cloud::Chronicle::V1::FilterOperatorAndValues>] # Required. Filter operator and field values for the dashboard # filter. class DrillDownDashboardFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Drill down external link config. # @!attribute [rw] link # @return [::String] # Required. External link the drill down action should redirect to. # @!attribute [rw] description # @return [::String] # Optional. Description of the external link. class DrillDownExternalLink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end end end |
#name ⇒ ::String (readonly)
Returns Output only. Name of the dashboardChart.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 |
# File 'proto_docs/google/cloud/chronicle/v1/dashboard_chart.rb', line 62 class DashboardChart include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Datasource of the chart including the query reference and source name. # @!attribute [rw] dashboard_query # @return [::String] # Reference to dashboard query resource used in the chart. # @!attribute [rw] data_sources # @return [::Array<::Google::Cloud::Chronicle::V1::DataSource>] # Name of the datasource used in the chart. class ChartDatasource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Visualization config for a chart. # https://echarts.apache.org/en/option.html#series # @!attribute [rw] x_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] y_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] series # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series>] # @!attribute [rw] tooltip # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Tooltip] # @!attribute [rw] legends # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Legend>] # @!attribute [rw] column_defs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnDef>] # Column Definition to represent chart as a table. # @!attribute [rw] table_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::TableConfig] # Optional. Configuration for table appearance. # @!attribute [rw] button # @return [::Google::Cloud::Chronicle::V1::Button] # Button config for a chart if tileType is TILE_TYPE_BUTTON. # @!attribute [rw] markdown # @return [::Google::Cloud::Chronicle::V1::Markdown] # Optional. Markdown config for a chart if tileType is TILE_TYPE_MARKDOWN. # @!attribute [rw] series_column # @return [::Array<::String>] # Optional. Selected column for series # @!attribute [rw] grouping_type # @return [::String] # Optional. Selected grouping type for series # @!attribute [rw] google_maps_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig] # Optional. Google Maps config for a chart if type is GOOGLE MAPS. # @!attribute [rw] threshold_coloring_enabled # @return [::Boolean] # Optional. Whether threshold coloring is enabled for the chart. If it's # enabled, the chart will be colored based on the values stored in # VisualMap below. # @!attribute [rw] visual_maps # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap>] # Optional. Visual maps for the chart. class Visualization include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] axis_type # @return [::Google::Cloud::Chronicle::V1::AxisType] # @!attribute [rw] display_name # @return [::String] # @!attribute [rw] min # @return [::Integer] # Minimum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.min # @!attribute [rw] max # @return [::Integer] # Maximum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.max class Axis include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] series_type # @return [::Google::Cloud::Chronicle::V1::SeriesType] # @!attribute [rw] series_name # @return [::String] # user specified series label # @!attribute [rw] show_symbol # @return [::Boolean] # @!attribute [rw] show_background # @return [::Boolean] # @!attribute [rw] stack # @return [::String] # @!attribute [rw] series_stack_strategy # @return [::Google::Cloud::Chronicle::V1::SeriesStackStrategy] # @!attribute [rw] encode # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::Encode] # @!attribute [rw] label # @return [::String] # @!attribute [rw] field # @return [::String] # @!attribute [rw] data_label # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::DataLabel] # Optional. Data label config for a series. # Displays data vaule in the chart # @!attribute [rw] radius # @return [::Array<::String>] # Optional. Used to make a pie chart into a douhnut chart # @!attribute [rw] item_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemStyle] # Optional. Custom styling for chart # @!attribute [rw] series_unique_value # @return [::String] # Optional. Series unique value from the query result # @!attribute [rw] area_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::AreaStyle] # Optional. Custom styling for area chart # @!attribute [rw] item_colors # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemColors] # Optional. Field to be saved for retrieving slice colors for the chart # @!attribute [rw] gauge_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeConfig] # Optional. Field to be saved for retrieving gauge config for gauge chart # @!attribute [rw] metric_trend_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::MetricTrendConfig] # Optional. Fields to capture trend config for metric charts class Series include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] x # @return [::String] # @!attribute [rw] y # @return [::String] # @!attribute [rw] value # @return [::String] # For some type of series that are not in any coordinate system, like # 'pie' # @!attribute [rw] item_name # @return [::String] # This is useful in charts like 'pie', where data item name can be # displayed in legend. class Encode include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Data label config for a series. # @!attribute [rw] show # @return [::Boolean] # Optional. Whether to show data label. class DataLabel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for chart # @!attribute [rw] border_width # @return [::Integer] # Optional. Used to add border width # @!attribute [rw] border_color # @return [::String] # Optional. Used to add border color # @!attribute [rw] color # @return [::String] # Optional. Used to add color class ItemStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for area chart # @!attribute [rw] color # @return [::String] # Optional. Used to add color # @!attribute [rw] origin # @return [::String] # Optional. Used to add origin # @!attribute [rw] shadow_blur # @return [::Integer] # Optional. Used to add shadow blur # @!attribute [rw] shadow_color # @return [::String] # Optional. Used to add shadow color # @!attribute [rw] shadow_offset_x # @return [::Integer] # Optional. Used to add shadow offsetX # @!attribute [rw] shadow_offset_y # @return [::Integer] # Optional. Used to add shadow offsetY # @!attribute [rw] opacity # @return [::Integer] # Optional. Used to add opacity class AreaStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # User selected color and label for the slice of the chart # @!attribute [rw] color # @return [::String] # Optional. User specified color of a pie slice # @!attribute [rw] label # @return [::String] # Optional. User specified label for a pie slice class UserSelectedValues include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Slice containing the key and value for a slice in the chart # @!attribute [rw] key # @return [::String] # Optional. Key for the slice # @!attribute [rw] value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::UserSelectedValues] # Optional. Value for the slice class ChartSliceColor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving slice colors for the chart # @!attribute [rw] colors # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ChartSliceColor>] # Optional. Slice colors array class ItemColors include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] value # @return [::Integer] # Optional. Value for gauge chart # @!attribute [rw] color # @return [::String] # Optional. Color for gauge chart class GaugeValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] base_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Base value for gauge chart # @!attribute [rw] limit_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Limit value for gauge chart # @!attribute [rw] threshold_values # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue>] # Optional. Threshold values for gauge chart class GaugeConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Metric trend config for displaying trend value in Metrics chart # @!attribute [rw] metric_format # @return [::Google::Cloud::Chronicle::V1::MetricFormat] # Optional. Metric chart configuration to display metric trend # @!attribute [rw] show_metric_trend # @return [::Boolean] # Optional. Metric chart configuration to toggle the trend value # display # @!attribute [rw] metric_display_trend # @return [::Google::Cloud::Chronicle::V1::MetricDisplayTrend] # Optional. Metric chart configuration to display the trend value # @!attribute [rw] metric_trend_type # @return [::Google::Cloud::Chronicle::V1::MetricTrendType] # Optional. Metric chart configuration to display trend type whether # regular or inverse class MetricTrendConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] tooltip_trigger # @return [::Google::Cloud::Chronicle::V1::ToolTipTrigger] class Tooltip include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] id # @return [::String] # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] z_level # @return [::Integer] # @!attribute [rw] z # @return [::Integer] # @!attribute [rw] left # @return [::Integer] # @!attribute [rw] top # @return [::Integer] # @!attribute [rw] right # @return [::Integer] # @!attribute [rw] bottom # @return [::Integer] # @!attribute [rw] legend_orient # @return [::Google::Cloud::Chronicle::V1::LegendOrient] # @!attribute [rw] legend_align # @return [::Google::Cloud::Chronicle::V1::LegendAlign] # @!attribute [rw] padding # @return [::Array<::Integer>] class Legend include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column Definition. # @!attribute [rw] field # @return [::String] # Field key in data. # @!attribute [rw] header # @return [::String] # Header name for column. class ColumnDef include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column render type settings. This is used to determine the data render # type of the column in the table. # @!attribute [rw] field # @return [::String] # Optional. Field key in data. # @!attribute [rw] column_render_type # @return [::Google::Cloud::Chronicle::V1::RenderType] # Optional. Column render type. class ColumnRenderTypeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Settings for tooltip for column header and cell. # @!attribute [rw] field # @return [::String] # Required. Field key in data. # @!attribute [rw] header_tooltip_text # @return [::String] # Optional. Column header tooltip text. # @!attribute [rw] cell_tooltip_text # @return [::String] # Optional. Column cell tooltip text. class ColumnTooltipSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration for table appearance. # @!attribute [rw] enable_text_wrap # @return [::Boolean] # Optional. Whether to show the table. # @!attribute [rw] column_render_type_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnRenderTypeSettings>] # Optional. Column render type settings. # @!attribute [rw] column_tooltip_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnTooltipSettings>] # Optional. Settings for tooltip for column header and cell. class TableConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Google Maps config for a chart if chart type is map. # @!attribute [rw] data_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::DataSettings] # Optional. Data settings for the map. # @!attribute [rw] plot_mode # @return [::Google::Cloud::Chronicle::V1::PlotMode] # Optional. Plot mode for the map. This is used to determine whether to # show points, heatmap or both. # @!attribute [rw] map_position # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::MapPosition] # Optional. Map position settings for the map. # @!attribute [rw] point_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::PointSettings] # Optional. Point settings for the map. class GoogleMapsConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Data settings for the map. # @!attribute [rw] latitude_column # @return [::String] # Optional. Latitude column. # @!attribute [rw] longitude_column # @return [::String] # Optional. Longitude column. # @!attribute [rw] count_column # @return [::String] # Optional. Field to count. class DataSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Map position settings for the map. # @!attribute [rw] fit_data # @return [::Boolean] # Optional. Whether to fit the map to the data. # If true, the map will be resized to fit the data. # If false, langitude and longitude will be used to set the map size. # @!attribute [rw] latitude_value # @return [::Float] # Optional. Latitude of the map. # @!attribute [rw] longitude_value # @return [::Float] # Optional. Longitude of the map. # @!attribute [rw] zoom_scale_value # @return [::Float] # Optional. Scale of the map. class MapPosition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Point settings for the map. # @!attribute [rw] point_size_type # @return [::Google::Cloud::Chronicle::V1::PointSizeType] # Optional. Point size type for the map. This is used to # determine the size of the points on the map. # @!attribute [rw] color # @return [::String] # Optional. Color for the point on the map. class PointSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Conveys what range of values should be rendered in what color. This field # is used when threshold_coloring_enabled is true. # @!attribute [rw] visual_map_type # @return [::Google::Cloud::Chronicle::V1::VisualMapType] # Optional. Contains one of the valid visual map types such as # 'continuous' or 'piecewise'. # @!attribute [rw] pieces # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap::VisualMapPiece>] # Optional. Pieces of the visual map. class VisualMap include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An ECharts visual map of type 'piecewise' contain many pieces. Each # piece has a min, max, and color with which it's rendered. # @!attribute [rw] min # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] max # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] color # @return [::String] # Optional. Color to render the piece in when the value is between min # and max. # @!attribute [rw] label # @return [::String] # Optional. Label used in visual map controller. class VisualMapPiece include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end # Drill down configuration. # @!attribute [rw] left_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Left click drill downs. # @!attribute [rw] right_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Right click drill downs. class DrillDownConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down config. # @!attribute [rw] default_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::DefaultDrillDownSettings] # Default drill down settings. # # Note: The following fields are mutually exclusive: `default_settings`, `custom_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] custom_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings] # Custom drill down settings. # # Note: The following fields are mutually exclusive: `custom_settings`, `default_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] id # @return [::String] # Required. ID of the drill down. # @!attribute [rw] display_name # @return [::String] # Required. Display name of the drill down. class DrillDown include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Default drill down settings. # @!attribute [rw] enabled # @return [::Boolean] # Required. Whether the default drill down is enabled. class DefaultDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom drill down settings. # @!attribute [rw] query # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownQuery] # Drill down query action config. # # Note: The following fields are mutually exclusive: `query`, `filter`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] filter # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter] # Drill down filter action config. # # Note: The following fields are mutually exclusive: `filter`, `query`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] external_link # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownExternalLink] # Drill down external link action config. # # Note: The following fields are mutually exclusive: `external_link`, `query`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] new_tab # @return [::Boolean] # Required. Whether to open the drill down action in a new tab. # @!attribute [rw] left_click_column # @return [::String] # Optional. Table chart column name to associate the custom drill down # action on left click. class CustomDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down query config. # @!attribute [rw] query # @return [::String] # Required. Search query to be executed on drill down. class DrillDownQuery include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Drill down filter config. # @!attribute [rw] dashboard_filters # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter::DrillDownDashboardFilter>] # Required. Dashboard filters to be applied on drill down. class DrillDownFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down dashboard filter config. # @!attribute [rw] dashboard_filter_id # @return [::String] # Required. ID of the dashboard filter. # @!attribute [rw] filter_operator_and_values # @return [::Array<::Google::Cloud::Chronicle::V1::FilterOperatorAndValues>] # Required. Filter operator and field values for the dashboard # filter. class DrillDownDashboardFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Drill down external link config. # @!attribute [rw] link # @return [::String] # Required. External link the drill down action should redirect to. # @!attribute [rw] description # @return [::String] # Optional. Description of the external link. class DrillDownExternalLink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end end end |
#native_dashboard ⇒ ::String (readonly)
Returns Output only. NativeDashboard this chart belongs to.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 |
# File 'proto_docs/google/cloud/chronicle/v1/dashboard_chart.rb', line 62 class DashboardChart include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Datasource of the chart including the query reference and source name. # @!attribute [rw] dashboard_query # @return [::String] # Reference to dashboard query resource used in the chart. # @!attribute [rw] data_sources # @return [::Array<::Google::Cloud::Chronicle::V1::DataSource>] # Name of the datasource used in the chart. class ChartDatasource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Visualization config for a chart. # https://echarts.apache.org/en/option.html#series # @!attribute [rw] x_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] y_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] series # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series>] # @!attribute [rw] tooltip # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Tooltip] # @!attribute [rw] legends # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Legend>] # @!attribute [rw] column_defs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnDef>] # Column Definition to represent chart as a table. # @!attribute [rw] table_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::TableConfig] # Optional. Configuration for table appearance. # @!attribute [rw] button # @return [::Google::Cloud::Chronicle::V1::Button] # Button config for a chart if tileType is TILE_TYPE_BUTTON. # @!attribute [rw] markdown # @return [::Google::Cloud::Chronicle::V1::Markdown] # Optional. Markdown config for a chart if tileType is TILE_TYPE_MARKDOWN. # @!attribute [rw] series_column # @return [::Array<::String>] # Optional. Selected column for series # @!attribute [rw] grouping_type # @return [::String] # Optional. Selected grouping type for series # @!attribute [rw] google_maps_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig] # Optional. Google Maps config for a chart if type is GOOGLE MAPS. # @!attribute [rw] threshold_coloring_enabled # @return [::Boolean] # Optional. Whether threshold coloring is enabled for the chart. If it's # enabled, the chart will be colored based on the values stored in # VisualMap below. # @!attribute [rw] visual_maps # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap>] # Optional. Visual maps for the chart. class Visualization include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] axis_type # @return [::Google::Cloud::Chronicle::V1::AxisType] # @!attribute [rw] display_name # @return [::String] # @!attribute [rw] min # @return [::Integer] # Minimum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.min # @!attribute [rw] max # @return [::Integer] # Maximum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.max class Axis include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] series_type # @return [::Google::Cloud::Chronicle::V1::SeriesType] # @!attribute [rw] series_name # @return [::String] # user specified series label # @!attribute [rw] show_symbol # @return [::Boolean] # @!attribute [rw] show_background # @return [::Boolean] # @!attribute [rw] stack # @return [::String] # @!attribute [rw] series_stack_strategy # @return [::Google::Cloud::Chronicle::V1::SeriesStackStrategy] # @!attribute [rw] encode # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::Encode] # @!attribute [rw] label # @return [::String] # @!attribute [rw] field # @return [::String] # @!attribute [rw] data_label # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::DataLabel] # Optional. Data label config for a series. # Displays data vaule in the chart # @!attribute [rw] radius # @return [::Array<::String>] # Optional. Used to make a pie chart into a douhnut chart # @!attribute [rw] item_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemStyle] # Optional. Custom styling for chart # @!attribute [rw] series_unique_value # @return [::String] # Optional. Series unique value from the query result # @!attribute [rw] area_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::AreaStyle] # Optional. Custom styling for area chart # @!attribute [rw] item_colors # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemColors] # Optional. Field to be saved for retrieving slice colors for the chart # @!attribute [rw] gauge_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeConfig] # Optional. Field to be saved for retrieving gauge config for gauge chart # @!attribute [rw] metric_trend_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::MetricTrendConfig] # Optional. Fields to capture trend config for metric charts class Series include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] x # @return [::String] # @!attribute [rw] y # @return [::String] # @!attribute [rw] value # @return [::String] # For some type of series that are not in any coordinate system, like # 'pie' # @!attribute [rw] item_name # @return [::String] # This is useful in charts like 'pie', where data item name can be # displayed in legend. class Encode include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Data label config for a series. # @!attribute [rw] show # @return [::Boolean] # Optional. Whether to show data label. class DataLabel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for chart # @!attribute [rw] border_width # @return [::Integer] # Optional. Used to add border width # @!attribute [rw] border_color # @return [::String] # Optional. Used to add border color # @!attribute [rw] color # @return [::String] # Optional. Used to add color class ItemStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for area chart # @!attribute [rw] color # @return [::String] # Optional. Used to add color # @!attribute [rw] origin # @return [::String] # Optional. Used to add origin # @!attribute [rw] shadow_blur # @return [::Integer] # Optional. Used to add shadow blur # @!attribute [rw] shadow_color # @return [::String] # Optional. Used to add shadow color # @!attribute [rw] shadow_offset_x # @return [::Integer] # Optional. Used to add shadow offsetX # @!attribute [rw] shadow_offset_y # @return [::Integer] # Optional. Used to add shadow offsetY # @!attribute [rw] opacity # @return [::Integer] # Optional. Used to add opacity class AreaStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # User selected color and label for the slice of the chart # @!attribute [rw] color # @return [::String] # Optional. User specified color of a pie slice # @!attribute [rw] label # @return [::String] # Optional. User specified label for a pie slice class UserSelectedValues include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Slice containing the key and value for a slice in the chart # @!attribute [rw] key # @return [::String] # Optional. Key for the slice # @!attribute [rw] value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::UserSelectedValues] # Optional. Value for the slice class ChartSliceColor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving slice colors for the chart # @!attribute [rw] colors # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ChartSliceColor>] # Optional. Slice colors array class ItemColors include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] value # @return [::Integer] # Optional. Value for gauge chart # @!attribute [rw] color # @return [::String] # Optional. Color for gauge chart class GaugeValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] base_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Base value for gauge chart # @!attribute [rw] limit_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Limit value for gauge chart # @!attribute [rw] threshold_values # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue>] # Optional. Threshold values for gauge chart class GaugeConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Metric trend config for displaying trend value in Metrics chart # @!attribute [rw] metric_format # @return [::Google::Cloud::Chronicle::V1::MetricFormat] # Optional. Metric chart configuration to display metric trend # @!attribute [rw] show_metric_trend # @return [::Boolean] # Optional. Metric chart configuration to toggle the trend value # display # @!attribute [rw] metric_display_trend # @return [::Google::Cloud::Chronicle::V1::MetricDisplayTrend] # Optional. Metric chart configuration to display the trend value # @!attribute [rw] metric_trend_type # @return [::Google::Cloud::Chronicle::V1::MetricTrendType] # Optional. Metric chart configuration to display trend type whether # regular or inverse class MetricTrendConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] tooltip_trigger # @return [::Google::Cloud::Chronicle::V1::ToolTipTrigger] class Tooltip include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] id # @return [::String] # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] z_level # @return [::Integer] # @!attribute [rw] z # @return [::Integer] # @!attribute [rw] left # @return [::Integer] # @!attribute [rw] top # @return [::Integer] # @!attribute [rw] right # @return [::Integer] # @!attribute [rw] bottom # @return [::Integer] # @!attribute [rw] legend_orient # @return [::Google::Cloud::Chronicle::V1::LegendOrient] # @!attribute [rw] legend_align # @return [::Google::Cloud::Chronicle::V1::LegendAlign] # @!attribute [rw] padding # @return [::Array<::Integer>] class Legend include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column Definition. # @!attribute [rw] field # @return [::String] # Field key in data. # @!attribute [rw] header # @return [::String] # Header name for column. class ColumnDef include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column render type settings. This is used to determine the data render # type of the column in the table. # @!attribute [rw] field # @return [::String] # Optional. Field key in data. # @!attribute [rw] column_render_type # @return [::Google::Cloud::Chronicle::V1::RenderType] # Optional. Column render type. class ColumnRenderTypeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Settings for tooltip for column header and cell. # @!attribute [rw] field # @return [::String] # Required. Field key in data. # @!attribute [rw] header_tooltip_text # @return [::String] # Optional. Column header tooltip text. # @!attribute [rw] cell_tooltip_text # @return [::String] # Optional. Column cell tooltip text. class ColumnTooltipSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration for table appearance. # @!attribute [rw] enable_text_wrap # @return [::Boolean] # Optional. Whether to show the table. # @!attribute [rw] column_render_type_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnRenderTypeSettings>] # Optional. Column render type settings. # @!attribute [rw] column_tooltip_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnTooltipSettings>] # Optional. Settings for tooltip for column header and cell. class TableConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Google Maps config for a chart if chart type is map. # @!attribute [rw] data_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::DataSettings] # Optional. Data settings for the map. # @!attribute [rw] plot_mode # @return [::Google::Cloud::Chronicle::V1::PlotMode] # Optional. Plot mode for the map. This is used to determine whether to # show points, heatmap or both. # @!attribute [rw] map_position # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::MapPosition] # Optional. Map position settings for the map. # @!attribute [rw] point_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::PointSettings] # Optional. Point settings for the map. class GoogleMapsConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Data settings for the map. # @!attribute [rw] latitude_column # @return [::String] # Optional. Latitude column. # @!attribute [rw] longitude_column # @return [::String] # Optional. Longitude column. # @!attribute [rw] count_column # @return [::String] # Optional. Field to count. class DataSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Map position settings for the map. # @!attribute [rw] fit_data # @return [::Boolean] # Optional. Whether to fit the map to the data. # If true, the map will be resized to fit the data. # If false, langitude and longitude will be used to set the map size. # @!attribute [rw] latitude_value # @return [::Float] # Optional. Latitude of the map. # @!attribute [rw] longitude_value # @return [::Float] # Optional. Longitude of the map. # @!attribute [rw] zoom_scale_value # @return [::Float] # Optional. Scale of the map. class MapPosition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Point settings for the map. # @!attribute [rw] point_size_type # @return [::Google::Cloud::Chronicle::V1::PointSizeType] # Optional. Point size type for the map. This is used to # determine the size of the points on the map. # @!attribute [rw] color # @return [::String] # Optional. Color for the point on the map. class PointSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Conveys what range of values should be rendered in what color. This field # is used when threshold_coloring_enabled is true. # @!attribute [rw] visual_map_type # @return [::Google::Cloud::Chronicle::V1::VisualMapType] # Optional. Contains one of the valid visual map types such as # 'continuous' or 'piecewise'. # @!attribute [rw] pieces # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap::VisualMapPiece>] # Optional. Pieces of the visual map. class VisualMap include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An ECharts visual map of type 'piecewise' contain many pieces. Each # piece has a min, max, and color with which it's rendered. # @!attribute [rw] min # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] max # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] color # @return [::String] # Optional. Color to render the piece in when the value is between min # and max. # @!attribute [rw] label # @return [::String] # Optional. Label used in visual map controller. class VisualMapPiece include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end # Drill down configuration. # @!attribute [rw] left_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Left click drill downs. # @!attribute [rw] right_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Right click drill downs. class DrillDownConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down config. # @!attribute [rw] default_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::DefaultDrillDownSettings] # Default drill down settings. # # Note: The following fields are mutually exclusive: `default_settings`, `custom_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] custom_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings] # Custom drill down settings. # # Note: The following fields are mutually exclusive: `custom_settings`, `default_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] id # @return [::String] # Required. ID of the drill down. # @!attribute [rw] display_name # @return [::String] # Required. Display name of the drill down. class DrillDown include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Default drill down settings. # @!attribute [rw] enabled # @return [::Boolean] # Required. Whether the default drill down is enabled. class DefaultDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom drill down settings. # @!attribute [rw] query # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownQuery] # Drill down query action config. # # Note: The following fields are mutually exclusive: `query`, `filter`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] filter # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter] # Drill down filter action config. # # Note: The following fields are mutually exclusive: `filter`, `query`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] external_link # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownExternalLink] # Drill down external link action config. # # Note: The following fields are mutually exclusive: `external_link`, `query`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] new_tab # @return [::Boolean] # Required. Whether to open the drill down action in a new tab. # @!attribute [rw] left_click_column # @return [::String] # Optional. Table chart column name to associate the custom drill down # action on left click. class CustomDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down query config. # @!attribute [rw] query # @return [::String] # Required. Search query to be executed on drill down. class DrillDownQuery include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Drill down filter config. # @!attribute [rw] dashboard_filters # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter::DrillDownDashboardFilter>] # Required. Dashboard filters to be applied on drill down. class DrillDownFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down dashboard filter config. # @!attribute [rw] dashboard_filter_id # @return [::String] # Required. ID of the dashboard filter. # @!attribute [rw] filter_operator_and_values # @return [::Array<::Google::Cloud::Chronicle::V1::FilterOperatorAndValues>] # Required. Filter operator and field values for the dashboard # filter. class DrillDownDashboardFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Drill down external link config. # @!attribute [rw] link # @return [::String] # Required. External link the drill down action should redirect to. # @!attribute [rw] description # @return [::String] # Optional. Description of the external link. class DrillDownExternalLink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end end end |
#tile_type ⇒ ::Google::Cloud::Chronicle::V1::TileType
Returns Optional. Type of tile i.e., visualization, button or text.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 |
# File 'proto_docs/google/cloud/chronicle/v1/dashboard_chart.rb', line 62 class DashboardChart include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Datasource of the chart including the query reference and source name. # @!attribute [rw] dashboard_query # @return [::String] # Reference to dashboard query resource used in the chart. # @!attribute [rw] data_sources # @return [::Array<::Google::Cloud::Chronicle::V1::DataSource>] # Name of the datasource used in the chart. class ChartDatasource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Visualization config for a chart. # https://echarts.apache.org/en/option.html#series # @!attribute [rw] x_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] y_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] series # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series>] # @!attribute [rw] tooltip # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Tooltip] # @!attribute [rw] legends # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Legend>] # @!attribute [rw] column_defs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnDef>] # Column Definition to represent chart as a table. # @!attribute [rw] table_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::TableConfig] # Optional. Configuration for table appearance. # @!attribute [rw] button # @return [::Google::Cloud::Chronicle::V1::Button] # Button config for a chart if tileType is TILE_TYPE_BUTTON. # @!attribute [rw] markdown # @return [::Google::Cloud::Chronicle::V1::Markdown] # Optional. Markdown config for a chart if tileType is TILE_TYPE_MARKDOWN. # @!attribute [rw] series_column # @return [::Array<::String>] # Optional. Selected column for series # @!attribute [rw] grouping_type # @return [::String] # Optional. Selected grouping type for series # @!attribute [rw] google_maps_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig] # Optional. Google Maps config for a chart if type is GOOGLE MAPS. # @!attribute [rw] threshold_coloring_enabled # @return [::Boolean] # Optional. Whether threshold coloring is enabled for the chart. If it's # enabled, the chart will be colored based on the values stored in # VisualMap below. # @!attribute [rw] visual_maps # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap>] # Optional. Visual maps for the chart. class Visualization include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] axis_type # @return [::Google::Cloud::Chronicle::V1::AxisType] # @!attribute [rw] display_name # @return [::String] # @!attribute [rw] min # @return [::Integer] # Minimum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.min # @!attribute [rw] max # @return [::Integer] # Maximum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.max class Axis include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] series_type # @return [::Google::Cloud::Chronicle::V1::SeriesType] # @!attribute [rw] series_name # @return [::String] # user specified series label # @!attribute [rw] show_symbol # @return [::Boolean] # @!attribute [rw] show_background # @return [::Boolean] # @!attribute [rw] stack # @return [::String] # @!attribute [rw] series_stack_strategy # @return [::Google::Cloud::Chronicle::V1::SeriesStackStrategy] # @!attribute [rw] encode # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::Encode] # @!attribute [rw] label # @return [::String] # @!attribute [rw] field # @return [::String] # @!attribute [rw] data_label # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::DataLabel] # Optional. Data label config for a series. # Displays data vaule in the chart # @!attribute [rw] radius # @return [::Array<::String>] # Optional. Used to make a pie chart into a douhnut chart # @!attribute [rw] item_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemStyle] # Optional. Custom styling for chart # @!attribute [rw] series_unique_value # @return [::String] # Optional. Series unique value from the query result # @!attribute [rw] area_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::AreaStyle] # Optional. Custom styling for area chart # @!attribute [rw] item_colors # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemColors] # Optional. Field to be saved for retrieving slice colors for the chart # @!attribute [rw] gauge_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeConfig] # Optional. Field to be saved for retrieving gauge config for gauge chart # @!attribute [rw] metric_trend_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::MetricTrendConfig] # Optional. Fields to capture trend config for metric charts class Series include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] x # @return [::String] # @!attribute [rw] y # @return [::String] # @!attribute [rw] value # @return [::String] # For some type of series that are not in any coordinate system, like # 'pie' # @!attribute [rw] item_name # @return [::String] # This is useful in charts like 'pie', where data item name can be # displayed in legend. class Encode include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Data label config for a series. # @!attribute [rw] show # @return [::Boolean] # Optional. Whether to show data label. class DataLabel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for chart # @!attribute [rw] border_width # @return [::Integer] # Optional. Used to add border width # @!attribute [rw] border_color # @return [::String] # Optional. Used to add border color # @!attribute [rw] color # @return [::String] # Optional. Used to add color class ItemStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for area chart # @!attribute [rw] color # @return [::String] # Optional. Used to add color # @!attribute [rw] origin # @return [::String] # Optional. Used to add origin # @!attribute [rw] shadow_blur # @return [::Integer] # Optional. Used to add shadow blur # @!attribute [rw] shadow_color # @return [::String] # Optional. Used to add shadow color # @!attribute [rw] shadow_offset_x # @return [::Integer] # Optional. Used to add shadow offsetX # @!attribute [rw] shadow_offset_y # @return [::Integer] # Optional. Used to add shadow offsetY # @!attribute [rw] opacity # @return [::Integer] # Optional. Used to add opacity class AreaStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # User selected color and label for the slice of the chart # @!attribute [rw] color # @return [::String] # Optional. User specified color of a pie slice # @!attribute [rw] label # @return [::String] # Optional. User specified label for a pie slice class UserSelectedValues include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Slice containing the key and value for a slice in the chart # @!attribute [rw] key # @return [::String] # Optional. Key for the slice # @!attribute [rw] value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::UserSelectedValues] # Optional. Value for the slice class ChartSliceColor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving slice colors for the chart # @!attribute [rw] colors # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ChartSliceColor>] # Optional. Slice colors array class ItemColors include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] value # @return [::Integer] # Optional. Value for gauge chart # @!attribute [rw] color # @return [::String] # Optional. Color for gauge chart class GaugeValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] base_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Base value for gauge chart # @!attribute [rw] limit_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Limit value for gauge chart # @!attribute [rw] threshold_values # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue>] # Optional. Threshold values for gauge chart class GaugeConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Metric trend config for displaying trend value in Metrics chart # @!attribute [rw] metric_format # @return [::Google::Cloud::Chronicle::V1::MetricFormat] # Optional. Metric chart configuration to display metric trend # @!attribute [rw] show_metric_trend # @return [::Boolean] # Optional. Metric chart configuration to toggle the trend value # display # @!attribute [rw] metric_display_trend # @return [::Google::Cloud::Chronicle::V1::MetricDisplayTrend] # Optional. Metric chart configuration to display the trend value # @!attribute [rw] metric_trend_type # @return [::Google::Cloud::Chronicle::V1::MetricTrendType] # Optional. Metric chart configuration to display trend type whether # regular or inverse class MetricTrendConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] tooltip_trigger # @return [::Google::Cloud::Chronicle::V1::ToolTipTrigger] class Tooltip include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] id # @return [::String] # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] z_level # @return [::Integer] # @!attribute [rw] z # @return [::Integer] # @!attribute [rw] left # @return [::Integer] # @!attribute [rw] top # @return [::Integer] # @!attribute [rw] right # @return [::Integer] # @!attribute [rw] bottom # @return [::Integer] # @!attribute [rw] legend_orient # @return [::Google::Cloud::Chronicle::V1::LegendOrient] # @!attribute [rw] legend_align # @return [::Google::Cloud::Chronicle::V1::LegendAlign] # @!attribute [rw] padding # @return [::Array<::Integer>] class Legend include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column Definition. # @!attribute [rw] field # @return [::String] # Field key in data. # @!attribute [rw] header # @return [::String] # Header name for column. class ColumnDef include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column render type settings. This is used to determine the data render # type of the column in the table. # @!attribute [rw] field # @return [::String] # Optional. Field key in data. # @!attribute [rw] column_render_type # @return [::Google::Cloud::Chronicle::V1::RenderType] # Optional. Column render type. class ColumnRenderTypeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Settings for tooltip for column header and cell. # @!attribute [rw] field # @return [::String] # Required. Field key in data. # @!attribute [rw] header_tooltip_text # @return [::String] # Optional. Column header tooltip text. # @!attribute [rw] cell_tooltip_text # @return [::String] # Optional. Column cell tooltip text. class ColumnTooltipSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration for table appearance. # @!attribute [rw] enable_text_wrap # @return [::Boolean] # Optional. Whether to show the table. # @!attribute [rw] column_render_type_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnRenderTypeSettings>] # Optional. Column render type settings. # @!attribute [rw] column_tooltip_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnTooltipSettings>] # Optional. Settings for tooltip for column header and cell. class TableConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Google Maps config for a chart if chart type is map. # @!attribute [rw] data_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::DataSettings] # Optional. Data settings for the map. # @!attribute [rw] plot_mode # @return [::Google::Cloud::Chronicle::V1::PlotMode] # Optional. Plot mode for the map. This is used to determine whether to # show points, heatmap or both. # @!attribute [rw] map_position # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::MapPosition] # Optional. Map position settings for the map. # @!attribute [rw] point_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::PointSettings] # Optional. Point settings for the map. class GoogleMapsConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Data settings for the map. # @!attribute [rw] latitude_column # @return [::String] # Optional. Latitude column. # @!attribute [rw] longitude_column # @return [::String] # Optional. Longitude column. # @!attribute [rw] count_column # @return [::String] # Optional. Field to count. class DataSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Map position settings for the map. # @!attribute [rw] fit_data # @return [::Boolean] # Optional. Whether to fit the map to the data. # If true, the map will be resized to fit the data. # If false, langitude and longitude will be used to set the map size. # @!attribute [rw] latitude_value # @return [::Float] # Optional. Latitude of the map. # @!attribute [rw] longitude_value # @return [::Float] # Optional. Longitude of the map. # @!attribute [rw] zoom_scale_value # @return [::Float] # Optional. Scale of the map. class MapPosition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Point settings for the map. # @!attribute [rw] point_size_type # @return [::Google::Cloud::Chronicle::V1::PointSizeType] # Optional. Point size type for the map. This is used to # determine the size of the points on the map. # @!attribute [rw] color # @return [::String] # Optional. Color for the point on the map. class PointSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Conveys what range of values should be rendered in what color. This field # is used when threshold_coloring_enabled is true. # @!attribute [rw] visual_map_type # @return [::Google::Cloud::Chronicle::V1::VisualMapType] # Optional. Contains one of the valid visual map types such as # 'continuous' or 'piecewise'. # @!attribute [rw] pieces # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap::VisualMapPiece>] # Optional. Pieces of the visual map. class VisualMap include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An ECharts visual map of type 'piecewise' contain many pieces. Each # piece has a min, max, and color with which it's rendered. # @!attribute [rw] min # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] max # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] color # @return [::String] # Optional. Color to render the piece in when the value is between min # and max. # @!attribute [rw] label # @return [::String] # Optional. Label used in visual map controller. class VisualMapPiece include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end # Drill down configuration. # @!attribute [rw] left_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Left click drill downs. # @!attribute [rw] right_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Right click drill downs. class DrillDownConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down config. # @!attribute [rw] default_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::DefaultDrillDownSettings] # Default drill down settings. # # Note: The following fields are mutually exclusive: `default_settings`, `custom_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] custom_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings] # Custom drill down settings. # # Note: The following fields are mutually exclusive: `custom_settings`, `default_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] id # @return [::String] # Required. ID of the drill down. # @!attribute [rw] display_name # @return [::String] # Required. Display name of the drill down. class DrillDown include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Default drill down settings. # @!attribute [rw] enabled # @return [::Boolean] # Required. Whether the default drill down is enabled. class DefaultDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom drill down settings. # @!attribute [rw] query # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownQuery] # Drill down query action config. # # Note: The following fields are mutually exclusive: `query`, `filter`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] filter # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter] # Drill down filter action config. # # Note: The following fields are mutually exclusive: `filter`, `query`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] external_link # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownExternalLink] # Drill down external link action config. # # Note: The following fields are mutually exclusive: `external_link`, `query`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] new_tab # @return [::Boolean] # Required. Whether to open the drill down action in a new tab. # @!attribute [rw] left_click_column # @return [::String] # Optional. Table chart column name to associate the custom drill down # action on left click. class CustomDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down query config. # @!attribute [rw] query # @return [::String] # Required. Search query to be executed on drill down. class DrillDownQuery include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Drill down filter config. # @!attribute [rw] dashboard_filters # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter::DrillDownDashboardFilter>] # Required. Dashboard filters to be applied on drill down. class DrillDownFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down dashboard filter config. # @!attribute [rw] dashboard_filter_id # @return [::String] # Required. ID of the dashboard filter. # @!attribute [rw] filter_operator_and_values # @return [::Array<::Google::Cloud::Chronicle::V1::FilterOperatorAndValues>] # Required. Filter operator and field values for the dashboard # filter. class DrillDownDashboardFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Drill down external link config. # @!attribute [rw] link # @return [::String] # Required. External link the drill down action should redirect to. # @!attribute [rw] description # @return [::String] # Optional. Description of the external link. class DrillDownExternalLink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end end end |
#tokens ⇒ ::Array<::String>
Returns 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.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 |
# File 'proto_docs/google/cloud/chronicle/v1/dashboard_chart.rb', line 62 class DashboardChart include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Datasource of the chart including the query reference and source name. # @!attribute [rw] dashboard_query # @return [::String] # Reference to dashboard query resource used in the chart. # @!attribute [rw] data_sources # @return [::Array<::Google::Cloud::Chronicle::V1::DataSource>] # Name of the datasource used in the chart. class ChartDatasource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Visualization config for a chart. # https://echarts.apache.org/en/option.html#series # @!attribute [rw] x_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] y_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] series # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series>] # @!attribute [rw] tooltip # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Tooltip] # @!attribute [rw] legends # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Legend>] # @!attribute [rw] column_defs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnDef>] # Column Definition to represent chart as a table. # @!attribute [rw] table_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::TableConfig] # Optional. Configuration for table appearance. # @!attribute [rw] button # @return [::Google::Cloud::Chronicle::V1::Button] # Button config for a chart if tileType is TILE_TYPE_BUTTON. # @!attribute [rw] markdown # @return [::Google::Cloud::Chronicle::V1::Markdown] # Optional. Markdown config for a chart if tileType is TILE_TYPE_MARKDOWN. # @!attribute [rw] series_column # @return [::Array<::String>] # Optional. Selected column for series # @!attribute [rw] grouping_type # @return [::String] # Optional. Selected grouping type for series # @!attribute [rw] google_maps_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig] # Optional. Google Maps config for a chart if type is GOOGLE MAPS. # @!attribute [rw] threshold_coloring_enabled # @return [::Boolean] # Optional. Whether threshold coloring is enabled for the chart. If it's # enabled, the chart will be colored based on the values stored in # VisualMap below. # @!attribute [rw] visual_maps # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap>] # Optional. Visual maps for the chart. class Visualization include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] axis_type # @return [::Google::Cloud::Chronicle::V1::AxisType] # @!attribute [rw] display_name # @return [::String] # @!attribute [rw] min # @return [::Integer] # Minimum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.min # @!attribute [rw] max # @return [::Integer] # Maximum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.max class Axis include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] series_type # @return [::Google::Cloud::Chronicle::V1::SeriesType] # @!attribute [rw] series_name # @return [::String] # user specified series label # @!attribute [rw] show_symbol # @return [::Boolean] # @!attribute [rw] show_background # @return [::Boolean] # @!attribute [rw] stack # @return [::String] # @!attribute [rw] series_stack_strategy # @return [::Google::Cloud::Chronicle::V1::SeriesStackStrategy] # @!attribute [rw] encode # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::Encode] # @!attribute [rw] label # @return [::String] # @!attribute [rw] field # @return [::String] # @!attribute [rw] data_label # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::DataLabel] # Optional. Data label config for a series. # Displays data vaule in the chart # @!attribute [rw] radius # @return [::Array<::String>] # Optional. Used to make a pie chart into a douhnut chart # @!attribute [rw] item_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemStyle] # Optional. Custom styling for chart # @!attribute [rw] series_unique_value # @return [::String] # Optional. Series unique value from the query result # @!attribute [rw] area_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::AreaStyle] # Optional. Custom styling for area chart # @!attribute [rw] item_colors # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemColors] # Optional. Field to be saved for retrieving slice colors for the chart # @!attribute [rw] gauge_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeConfig] # Optional. Field to be saved for retrieving gauge config for gauge chart # @!attribute [rw] metric_trend_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::MetricTrendConfig] # Optional. Fields to capture trend config for metric charts class Series include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] x # @return [::String] # @!attribute [rw] y # @return [::String] # @!attribute [rw] value # @return [::String] # For some type of series that are not in any coordinate system, like # 'pie' # @!attribute [rw] item_name # @return [::String] # This is useful in charts like 'pie', where data item name can be # displayed in legend. class Encode include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Data label config for a series. # @!attribute [rw] show # @return [::Boolean] # Optional. Whether to show data label. class DataLabel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for chart # @!attribute [rw] border_width # @return [::Integer] # Optional. Used to add border width # @!attribute [rw] border_color # @return [::String] # Optional. Used to add border color # @!attribute [rw] color # @return [::String] # Optional. Used to add color class ItemStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for area chart # @!attribute [rw] color # @return [::String] # Optional. Used to add color # @!attribute [rw] origin # @return [::String] # Optional. Used to add origin # @!attribute [rw] shadow_blur # @return [::Integer] # Optional. Used to add shadow blur # @!attribute [rw] shadow_color # @return [::String] # Optional. Used to add shadow color # @!attribute [rw] shadow_offset_x # @return [::Integer] # Optional. Used to add shadow offsetX # @!attribute [rw] shadow_offset_y # @return [::Integer] # Optional. Used to add shadow offsetY # @!attribute [rw] opacity # @return [::Integer] # Optional. Used to add opacity class AreaStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # User selected color and label for the slice of the chart # @!attribute [rw] color # @return [::String] # Optional. User specified color of a pie slice # @!attribute [rw] label # @return [::String] # Optional. User specified label for a pie slice class UserSelectedValues include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Slice containing the key and value for a slice in the chart # @!attribute [rw] key # @return [::String] # Optional. Key for the slice # @!attribute [rw] value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::UserSelectedValues] # Optional. Value for the slice class ChartSliceColor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving slice colors for the chart # @!attribute [rw] colors # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ChartSliceColor>] # Optional. Slice colors array class ItemColors include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] value # @return [::Integer] # Optional. Value for gauge chart # @!attribute [rw] color # @return [::String] # Optional. Color for gauge chart class GaugeValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] base_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Base value for gauge chart # @!attribute [rw] limit_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Limit value for gauge chart # @!attribute [rw] threshold_values # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue>] # Optional. Threshold values for gauge chart class GaugeConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Metric trend config for displaying trend value in Metrics chart # @!attribute [rw] metric_format # @return [::Google::Cloud::Chronicle::V1::MetricFormat] # Optional. Metric chart configuration to display metric trend # @!attribute [rw] show_metric_trend # @return [::Boolean] # Optional. Metric chart configuration to toggle the trend value # display # @!attribute [rw] metric_display_trend # @return [::Google::Cloud::Chronicle::V1::MetricDisplayTrend] # Optional. Metric chart configuration to display the trend value # @!attribute [rw] metric_trend_type # @return [::Google::Cloud::Chronicle::V1::MetricTrendType] # Optional. Metric chart configuration to display trend type whether # regular or inverse class MetricTrendConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] tooltip_trigger # @return [::Google::Cloud::Chronicle::V1::ToolTipTrigger] class Tooltip include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] id # @return [::String] # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] z_level # @return [::Integer] # @!attribute [rw] z # @return [::Integer] # @!attribute [rw] left # @return [::Integer] # @!attribute [rw] top # @return [::Integer] # @!attribute [rw] right # @return [::Integer] # @!attribute [rw] bottom # @return [::Integer] # @!attribute [rw] legend_orient # @return [::Google::Cloud::Chronicle::V1::LegendOrient] # @!attribute [rw] legend_align # @return [::Google::Cloud::Chronicle::V1::LegendAlign] # @!attribute [rw] padding # @return [::Array<::Integer>] class Legend include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column Definition. # @!attribute [rw] field # @return [::String] # Field key in data. # @!attribute [rw] header # @return [::String] # Header name for column. class ColumnDef include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column render type settings. This is used to determine the data render # type of the column in the table. # @!attribute [rw] field # @return [::String] # Optional. Field key in data. # @!attribute [rw] column_render_type # @return [::Google::Cloud::Chronicle::V1::RenderType] # Optional. Column render type. class ColumnRenderTypeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Settings for tooltip for column header and cell. # @!attribute [rw] field # @return [::String] # Required. Field key in data. # @!attribute [rw] header_tooltip_text # @return [::String] # Optional. Column header tooltip text. # @!attribute [rw] cell_tooltip_text # @return [::String] # Optional. Column cell tooltip text. class ColumnTooltipSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration for table appearance. # @!attribute [rw] enable_text_wrap # @return [::Boolean] # Optional. Whether to show the table. # @!attribute [rw] column_render_type_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnRenderTypeSettings>] # Optional. Column render type settings. # @!attribute [rw] column_tooltip_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnTooltipSettings>] # Optional. Settings for tooltip for column header and cell. class TableConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Google Maps config for a chart if chart type is map. # @!attribute [rw] data_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::DataSettings] # Optional. Data settings for the map. # @!attribute [rw] plot_mode # @return [::Google::Cloud::Chronicle::V1::PlotMode] # Optional. Plot mode for the map. This is used to determine whether to # show points, heatmap or both. # @!attribute [rw] map_position # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::MapPosition] # Optional. Map position settings for the map. # @!attribute [rw] point_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::PointSettings] # Optional. Point settings for the map. class GoogleMapsConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Data settings for the map. # @!attribute [rw] latitude_column # @return [::String] # Optional. Latitude column. # @!attribute [rw] longitude_column # @return [::String] # Optional. Longitude column. # @!attribute [rw] count_column # @return [::String] # Optional. Field to count. class DataSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Map position settings for the map. # @!attribute [rw] fit_data # @return [::Boolean] # Optional. Whether to fit the map to the data. # If true, the map will be resized to fit the data. # If false, langitude and longitude will be used to set the map size. # @!attribute [rw] latitude_value # @return [::Float] # Optional. Latitude of the map. # @!attribute [rw] longitude_value # @return [::Float] # Optional. Longitude of the map. # @!attribute [rw] zoom_scale_value # @return [::Float] # Optional. Scale of the map. class MapPosition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Point settings for the map. # @!attribute [rw] point_size_type # @return [::Google::Cloud::Chronicle::V1::PointSizeType] # Optional. Point size type for the map. This is used to # determine the size of the points on the map. # @!attribute [rw] color # @return [::String] # Optional. Color for the point on the map. class PointSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Conveys what range of values should be rendered in what color. This field # is used when threshold_coloring_enabled is true. # @!attribute [rw] visual_map_type # @return [::Google::Cloud::Chronicle::V1::VisualMapType] # Optional. Contains one of the valid visual map types such as # 'continuous' or 'piecewise'. # @!attribute [rw] pieces # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap::VisualMapPiece>] # Optional. Pieces of the visual map. class VisualMap include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An ECharts visual map of type 'piecewise' contain many pieces. Each # piece has a min, max, and color with which it's rendered. # @!attribute [rw] min # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] max # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] color # @return [::String] # Optional. Color to render the piece in when the value is between min # and max. # @!attribute [rw] label # @return [::String] # Optional. Label used in visual map controller. class VisualMapPiece include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end # Drill down configuration. # @!attribute [rw] left_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Left click drill downs. # @!attribute [rw] right_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Right click drill downs. class DrillDownConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down config. # @!attribute [rw] default_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::DefaultDrillDownSettings] # Default drill down settings. # # Note: The following fields are mutually exclusive: `default_settings`, `custom_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] custom_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings] # Custom drill down settings. # # Note: The following fields are mutually exclusive: `custom_settings`, `default_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] id # @return [::String] # Required. ID of the drill down. # @!attribute [rw] display_name # @return [::String] # Required. Display name of the drill down. class DrillDown include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Default drill down settings. # @!attribute [rw] enabled # @return [::Boolean] # Required. Whether the default drill down is enabled. class DefaultDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom drill down settings. # @!attribute [rw] query # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownQuery] # Drill down query action config. # # Note: The following fields are mutually exclusive: `query`, `filter`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] filter # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter] # Drill down filter action config. # # Note: The following fields are mutually exclusive: `filter`, `query`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] external_link # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownExternalLink] # Drill down external link action config. # # Note: The following fields are mutually exclusive: `external_link`, `query`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] new_tab # @return [::Boolean] # Required. Whether to open the drill down action in a new tab. # @!attribute [rw] left_click_column # @return [::String] # Optional. Table chart column name to associate the custom drill down # action on left click. class CustomDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down query config. # @!attribute [rw] query # @return [::String] # Required. Search query to be executed on drill down. class DrillDownQuery include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Drill down filter config. # @!attribute [rw] dashboard_filters # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter::DrillDownDashboardFilter>] # Required. Dashboard filters to be applied on drill down. class DrillDownFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down dashboard filter config. # @!attribute [rw] dashboard_filter_id # @return [::String] # Required. ID of the dashboard filter. # @!attribute [rw] filter_operator_and_values # @return [::Array<::Google::Cloud::Chronicle::V1::FilterOperatorAndValues>] # Required. Filter operator and field values for the dashboard # filter. class DrillDownDashboardFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Drill down external link config. # @!attribute [rw] link # @return [::String] # Required. External link the drill down action should redirect to. # @!attribute [rw] description # @return [::String] # Optional. Description of the external link. class DrillDownExternalLink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end end end |
#visualization ⇒ ::Google::Cloud::Chronicle::V1::DashboardChart::Visualization
Returns Required. Depending on tile_type one of below fields will be required.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 |
# File 'proto_docs/google/cloud/chronicle/v1/dashboard_chart.rb', line 62 class DashboardChart include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Datasource of the chart including the query reference and source name. # @!attribute [rw] dashboard_query # @return [::String] # Reference to dashboard query resource used in the chart. # @!attribute [rw] data_sources # @return [::Array<::Google::Cloud::Chronicle::V1::DataSource>] # Name of the datasource used in the chart. class ChartDatasource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Visualization config for a chart. # https://echarts.apache.org/en/option.html#series # @!attribute [rw] x_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] y_axes # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>] # @!attribute [rw] series # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series>] # @!attribute [rw] tooltip # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Tooltip] # @!attribute [rw] legends # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Legend>] # @!attribute [rw] column_defs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnDef>] # Column Definition to represent chart as a table. # @!attribute [rw] table_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::TableConfig] # Optional. Configuration for table appearance. # @!attribute [rw] button # @return [::Google::Cloud::Chronicle::V1::Button] # Button config for a chart if tileType is TILE_TYPE_BUTTON. # @!attribute [rw] markdown # @return [::Google::Cloud::Chronicle::V1::Markdown] # Optional. Markdown config for a chart if tileType is TILE_TYPE_MARKDOWN. # @!attribute [rw] series_column # @return [::Array<::String>] # Optional. Selected column for series # @!attribute [rw] grouping_type # @return [::String] # Optional. Selected grouping type for series # @!attribute [rw] google_maps_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig] # Optional. Google Maps config for a chart if type is GOOGLE MAPS. # @!attribute [rw] threshold_coloring_enabled # @return [::Boolean] # Optional. Whether threshold coloring is enabled for the chart. If it's # enabled, the chart will be colored based on the values stored in # VisualMap below. # @!attribute [rw] visual_maps # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap>] # Optional. Visual maps for the chart. class Visualization include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] axis_type # @return [::Google::Cloud::Chronicle::V1::AxisType] # @!attribute [rw] display_name # @return [::String] # @!attribute [rw] min # @return [::Integer] # Minimum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.min # @!attribute [rw] max # @return [::Integer] # Maximum value to be rendered in ECharts as per # https://echarts.apache.org/en/option.html#xAxis.max class Axis include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] series_type # @return [::Google::Cloud::Chronicle::V1::SeriesType] # @!attribute [rw] series_name # @return [::String] # user specified series label # @!attribute [rw] show_symbol # @return [::Boolean] # @!attribute [rw] show_background # @return [::Boolean] # @!attribute [rw] stack # @return [::String] # @!attribute [rw] series_stack_strategy # @return [::Google::Cloud::Chronicle::V1::SeriesStackStrategy] # @!attribute [rw] encode # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::Encode] # @!attribute [rw] label # @return [::String] # @!attribute [rw] field # @return [::String] # @!attribute [rw] data_label # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::DataLabel] # Optional. Data label config for a series. # Displays data vaule in the chart # @!attribute [rw] radius # @return [::Array<::String>] # Optional. Used to make a pie chart into a douhnut chart # @!attribute [rw] item_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemStyle] # Optional. Custom styling for chart # @!attribute [rw] series_unique_value # @return [::String] # Optional. Series unique value from the query result # @!attribute [rw] area_style # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::AreaStyle] # Optional. Custom styling for area chart # @!attribute [rw] item_colors # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemColors] # Optional. Field to be saved for retrieving slice colors for the chart # @!attribute [rw] gauge_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeConfig] # Optional. Field to be saved for retrieving gauge config for gauge chart # @!attribute [rw] metric_trend_config # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::MetricTrendConfig] # Optional. Fields to capture trend config for metric charts class Series include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] x # @return [::String] # @!attribute [rw] y # @return [::String] # @!attribute [rw] value # @return [::String] # For some type of series that are not in any coordinate system, like # 'pie' # @!attribute [rw] item_name # @return [::String] # This is useful in charts like 'pie', where data item name can be # displayed in legend. class Encode include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Data label config for a series. # @!attribute [rw] show # @return [::Boolean] # Optional. Whether to show data label. class DataLabel include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for chart # @!attribute [rw] border_width # @return [::Integer] # Optional. Used to add border width # @!attribute [rw] border_color # @return [::String] # Optional. Used to add border color # @!attribute [rw] color # @return [::String] # Optional. Used to add color class ItemStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom styling for area chart # @!attribute [rw] color # @return [::String] # Optional. Used to add color # @!attribute [rw] origin # @return [::String] # Optional. Used to add origin # @!attribute [rw] shadow_blur # @return [::Integer] # Optional. Used to add shadow blur # @!attribute [rw] shadow_color # @return [::String] # Optional. Used to add shadow color # @!attribute [rw] shadow_offset_x # @return [::Integer] # Optional. Used to add shadow offsetX # @!attribute [rw] shadow_offset_y # @return [::Integer] # Optional. Used to add shadow offsetY # @!attribute [rw] opacity # @return [::Integer] # Optional. Used to add opacity class AreaStyle include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # User selected color and label for the slice of the chart # @!attribute [rw] color # @return [::String] # Optional. User specified color of a pie slice # @!attribute [rw] label # @return [::String] # Optional. User specified label for a pie slice class UserSelectedValues include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Slice containing the key and value for a slice in the chart # @!attribute [rw] key # @return [::String] # Optional. Key for the slice # @!attribute [rw] value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::UserSelectedValues] # Optional. Value for the slice class ChartSliceColor include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving slice colors for the chart # @!attribute [rw] colors # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ChartSliceColor>] # Optional. Slice colors array class ItemColors include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] value # @return [::Integer] # Optional. Value for gauge chart # @!attribute [rw] color # @return [::String] # Optional. Color for gauge chart class GaugeValue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Field to be saved for retrieving value and color for gauge chart # @!attribute [rw] base_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Base value for gauge chart # @!attribute [rw] limit_value # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue] # Optional. Limit value for gauge chart # @!attribute [rw] threshold_values # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue>] # Optional. Threshold values for gauge chart class GaugeConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Metric trend config for displaying trend value in Metrics chart # @!attribute [rw] metric_format # @return [::Google::Cloud::Chronicle::V1::MetricFormat] # Optional. Metric chart configuration to display metric trend # @!attribute [rw] show_metric_trend # @return [::Boolean] # Optional. Metric chart configuration to toggle the trend value # display # @!attribute [rw] metric_display_trend # @return [::Google::Cloud::Chronicle::V1::MetricDisplayTrend] # Optional. Metric chart configuration to display the trend value # @!attribute [rw] metric_trend_type # @return [::Google::Cloud::Chronicle::V1::MetricTrendType] # Optional. Metric chart configuration to display trend type whether # regular or inverse class MetricTrendConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] tooltip_trigger # @return [::Google::Cloud::Chronicle::V1::ToolTipTrigger] class Tooltip include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] id # @return [::String] # @!attribute [rw] show # @return [::Boolean] # @!attribute [rw] z_level # @return [::Integer] # @!attribute [rw] z # @return [::Integer] # @!attribute [rw] left # @return [::Integer] # @!attribute [rw] top # @return [::Integer] # @!attribute [rw] right # @return [::Integer] # @!attribute [rw] bottom # @return [::Integer] # @!attribute [rw] legend_orient # @return [::Google::Cloud::Chronicle::V1::LegendOrient] # @!attribute [rw] legend_align # @return [::Google::Cloud::Chronicle::V1::LegendAlign] # @!attribute [rw] padding # @return [::Array<::Integer>] class Legend include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column Definition. # @!attribute [rw] field # @return [::String] # Field key in data. # @!attribute [rw] header # @return [::String] # Header name for column. class ColumnDef include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Column render type settings. This is used to determine the data render # type of the column in the table. # @!attribute [rw] field # @return [::String] # Optional. Field key in data. # @!attribute [rw] column_render_type # @return [::Google::Cloud::Chronicle::V1::RenderType] # Optional. Column render type. class ColumnRenderTypeSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Settings for tooltip for column header and cell. # @!attribute [rw] field # @return [::String] # Required. Field key in data. # @!attribute [rw] header_tooltip_text # @return [::String] # Optional. Column header tooltip text. # @!attribute [rw] cell_tooltip_text # @return [::String] # Optional. Column cell tooltip text. class ColumnTooltipSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration for table appearance. # @!attribute [rw] enable_text_wrap # @return [::Boolean] # Optional. Whether to show the table. # @!attribute [rw] column_render_type_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnRenderTypeSettings>] # Optional. Column render type settings. # @!attribute [rw] column_tooltip_settings # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnTooltipSettings>] # Optional. Settings for tooltip for column header and cell. class TableConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Google Maps config for a chart if chart type is map. # @!attribute [rw] data_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::DataSettings] # Optional. Data settings for the map. # @!attribute [rw] plot_mode # @return [::Google::Cloud::Chronicle::V1::PlotMode] # Optional. Plot mode for the map. This is used to determine whether to # show points, heatmap or both. # @!attribute [rw] map_position # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::MapPosition] # Optional. Map position settings for the map. # @!attribute [rw] point_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::PointSettings] # Optional. Point settings for the map. class GoogleMapsConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Data settings for the map. # @!attribute [rw] latitude_column # @return [::String] # Optional. Latitude column. # @!attribute [rw] longitude_column # @return [::String] # Optional. Longitude column. # @!attribute [rw] count_column # @return [::String] # Optional. Field to count. class DataSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Map position settings for the map. # @!attribute [rw] fit_data # @return [::Boolean] # Optional. Whether to fit the map to the data. # If true, the map will be resized to fit the data. # If false, langitude and longitude will be used to set the map size. # @!attribute [rw] latitude_value # @return [::Float] # Optional. Latitude of the map. # @!attribute [rw] longitude_value # @return [::Float] # Optional. Longitude of the map. # @!attribute [rw] zoom_scale_value # @return [::Float] # Optional. Scale of the map. class MapPosition include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Point settings for the map. # @!attribute [rw] point_size_type # @return [::Google::Cloud::Chronicle::V1::PointSizeType] # Optional. Point size type for the map. This is used to # determine the size of the points on the map. # @!attribute [rw] color # @return [::String] # Optional. Color for the point on the map. class PointSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Conveys what range of values should be rendered in what color. This field # is used when threshold_coloring_enabled is true. # @!attribute [rw] visual_map_type # @return [::Google::Cloud::Chronicle::V1::VisualMapType] # Optional. Contains one of the valid visual map types such as # 'continuous' or 'piecewise'. # @!attribute [rw] pieces # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap::VisualMapPiece>] # Optional. Pieces of the visual map. class VisualMap include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # An ECharts visual map of type 'piecewise' contain many pieces. Each # piece has a min, max, and color with which it's rendered. # @!attribute [rw] min # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] max # @return [::Integer] # Optional. Minimum value for the piece. # @!attribute [rw] color # @return [::String] # Optional. Color to render the piece in when the value is between min # and max. # @!attribute [rw] label # @return [::String] # Optional. Label used in visual map controller. class VisualMapPiece include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end # Drill down configuration. # @!attribute [rw] left_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Left click drill downs. # @!attribute [rw] right_drill_downs # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>] # Required. Right click drill downs. class DrillDownConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down config. # @!attribute [rw] default_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::DefaultDrillDownSettings] # Default drill down settings. # # Note: The following fields are mutually exclusive: `default_settings`, `custom_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] custom_settings # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings] # Custom drill down settings. # # Note: The following fields are mutually exclusive: `custom_settings`, `default_settings`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] id # @return [::String] # Required. ID of the drill down. # @!attribute [rw] display_name # @return [::String] # Required. Display name of the drill down. class DrillDown include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Default drill down settings. # @!attribute [rw] enabled # @return [::Boolean] # Required. Whether the default drill down is enabled. class DefaultDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Custom drill down settings. # @!attribute [rw] query # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownQuery] # Drill down query action config. # # Note: The following fields are mutually exclusive: `query`, `filter`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] filter # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter] # Drill down filter action config. # # Note: The following fields are mutually exclusive: `filter`, `query`, `external_link`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] external_link # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownExternalLink] # Drill down external link action config. # # Note: The following fields are mutually exclusive: `external_link`, `query`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared. # @!attribute [rw] new_tab # @return [::Boolean] # Required. Whether to open the drill down action in a new tab. # @!attribute [rw] left_click_column # @return [::String] # Optional. Table chart column name to associate the custom drill down # action on left click. class CustomDrillDownSettings include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down query config. # @!attribute [rw] query # @return [::String] # Required. Search query to be executed on drill down. class DrillDownQuery include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Drill down filter config. # @!attribute [rw] dashboard_filters # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter::DrillDownDashboardFilter>] # Required. Dashboard filters to be applied on drill down. class DrillDownFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Drill down dashboard filter config. # @!attribute [rw] dashboard_filter_id # @return [::String] # Required. ID of the dashboard filter. # @!attribute [rw] filter_operator_and_values # @return [::Array<::Google::Cloud::Chronicle::V1::FilterOperatorAndValues>] # Required. Filter operator and field values for the dashboard # filter. class DrillDownDashboardFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Drill down external link config. # @!attribute [rw] link # @return [::String] # Required. External link the drill down action should redirect to. # @!attribute [rw] description # @return [::String] # Optional. Description of the external link. class DrillDownExternalLink include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end end end |