google-cloud-chronicle-v1 0.5.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +4 -4
  3. data/README.md +5 -5
  4. data/lib/google/cloud/chronicle/v1/big_query_export_pb.rb +34 -0
  5. data/lib/google/cloud/chronicle/v1/big_query_export_service/client.rb +684 -0
  6. data/lib/google/cloud/chronicle/v1/big_query_export_service/credentials.rb +49 -0
  7. data/lib/google/cloud/chronicle/v1/big_query_export_service/paths.rb +71 -0
  8. data/lib/google/cloud/chronicle/v1/big_query_export_service/rest/client.rb +620 -0
  9. data/lib/google/cloud/chronicle/v1/big_query_export_service/rest/service_stub.rb +266 -0
  10. data/lib/google/cloud/chronicle/v1/big_query_export_service/rest.rb +52 -0
  11. data/lib/google/cloud/chronicle/v1/big_query_export_service.rb +55 -0
  12. data/lib/google/cloud/chronicle/v1/big_query_export_services_pb.rb +51 -0
  13. data/lib/google/cloud/chronicle/v1/dashboard_chart_pb.rb +83 -0
  14. data/lib/google/cloud/chronicle/v1/dashboard_chart_service/client.rb +586 -0
  15. data/lib/google/cloud/chronicle/v1/dashboard_chart_service/credentials.rb +49 -0
  16. data/lib/google/cloud/chronicle/v1/dashboard_chart_service/paths.rb +73 -0
  17. data/lib/google/cloud/chronicle/v1/dashboard_chart_service/rest/client.rb +529 -0
  18. data/lib/google/cloud/chronicle/v1/dashboard_chart_service/rest/service_stub.rb +203 -0
  19. data/lib/google/cloud/chronicle/v1/dashboard_chart_service/rest.rb +52 -0
  20. data/lib/google/cloud/chronicle/v1/dashboard_chart_service.rb +55 -0
  21. data/lib/google/cloud/chronicle/v1/dashboard_chart_services_pb.rb +47 -0
  22. data/lib/google/cloud/chronicle/v1/dashboard_query_pb.rb +58 -0
  23. data/lib/google/cloud/chronicle/v1/dashboard_query_service/client.rb +591 -0
  24. data/lib/google/cloud/chronicle/v1/dashboard_query_service/credentials.rb +49 -0
  25. data/lib/google/cloud/chronicle/v1/dashboard_query_service/paths.rb +94 -0
  26. data/lib/google/cloud/chronicle/v1/dashboard_query_service/rest/client.rb +534 -0
  27. data/lib/google/cloud/chronicle/v1/dashboard_query_service/rest/service_stub.rb +204 -0
  28. data/lib/google/cloud/chronicle/v1/dashboard_query_service/rest.rb +52 -0
  29. data/lib/google/cloud/chronicle/v1/dashboard_query_service.rb +55 -0
  30. data/lib/google/cloud/chronicle/v1/dashboard_query_services_pb.rb +47 -0
  31. data/lib/google/cloud/chronicle/v1/data_access_control_service/client.rb +2 -0
  32. data/lib/google/cloud/chronicle/v1/data_access_control_service/rest/client.rb +2 -0
  33. data/lib/google/cloud/chronicle/v1/data_table_service/client.rb +2 -0
  34. data/lib/google/cloud/chronicle/v1/data_table_service/rest/client.rb +2 -0
  35. data/lib/google/cloud/chronicle/v1/entity_service/client.rb +2 -0
  36. data/lib/google/cloud/chronicle/v1/entity_service/rest/client.rb +2 -0
  37. data/lib/google/cloud/chronicle/v1/featured_content_metadata_pb.rb +25 -0
  38. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_pb.rb +33 -0
  39. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/client.rb +719 -0
  40. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/credentials.rb +49 -0
  41. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/paths.rb +136 -0
  42. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/rest/client.rb +655 -0
  43. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/rest/service_stub.rb +265 -0
  44. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/rest.rb +53 -0
  45. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service.rb +56 -0
  46. data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_services_pb.rb +50 -0
  47. data/lib/google/cloud/chronicle/v1/instance_service/client.rb +2 -0
  48. data/lib/google/cloud/chronicle/v1/instance_service/rest/client.rb +2 -0
  49. data/lib/google/cloud/chronicle/v1/native_dashboard_pb.rb +61 -0
  50. data/lib/google/cloud/chronicle/v1/native_dashboard_service/client.rb +1613 -0
  51. data/lib/google/cloud/chronicle/v1/native_dashboard_service/credentials.rb +49 -0
  52. data/lib/google/cloud/chronicle/v1/native_dashboard_service/paths.rb +115 -0
  53. data/lib/google/cloud/chronicle/v1/native_dashboard_service/rest/client.rb +1486 -0
  54. data/lib/google/cloud/chronicle/v1/native_dashboard_service/rest/service_stub.rb +822 -0
  55. data/lib/google/cloud/chronicle/v1/native_dashboard_service/rest.rb +52 -0
  56. data/lib/google/cloud/chronicle/v1/native_dashboard_service.rb +55 -0
  57. data/lib/google/cloud/chronicle/v1/native_dashboard_services_pb.rb +67 -0
  58. data/lib/google/cloud/chronicle/v1/reference_list_service/client.rb +2 -0
  59. data/lib/google/cloud/chronicle/v1/reference_list_service/rest/client.rb +2 -0
  60. data/lib/google/cloud/chronicle/v1/rest.rb +6 -1
  61. data/lib/google/cloud/chronicle/v1/rule_service/client.rb +2 -0
  62. data/lib/google/cloud/chronicle/v1/rule_service/operations.rb +2 -0
  63. data/lib/google/cloud/chronicle/v1/rule_service/rest/client.rb +2 -0
  64. data/lib/google/cloud/chronicle/v1/rule_service/rest/operations.rb +2 -0
  65. data/lib/google/cloud/chronicle/v1/version.rb +1 -1
  66. data/lib/google/cloud/chronicle/v1.rb +7 -2
  67. data/proto_docs/google/cloud/chronicle/v1/big_query_export.rb +142 -0
  68. data/proto_docs/google/cloud/chronicle/v1/dashboard_chart.rb +923 -0
  69. data/proto_docs/google/cloud/chronicle/v1/dashboard_query.rb +653 -0
  70. data/proto_docs/google/cloud/chronicle/v1/featured_content_metadata.rb +82 -0
  71. data/proto_docs/google/cloud/chronicle/v1/featured_content_native_dashboard.rb +141 -0
  72. data/proto_docs/google/cloud/chronicle/v1/native_dashboard.rb +502 -0
  73. data/proto_docs/google/type/date.rb +56 -0
  74. metadata +56 -3
@@ -0,0 +1,923 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Chronicle
23
+ module V1
24
+ # DashboardChart resource.
25
+ # @!attribute [r] name
26
+ # @return [::String]
27
+ # Output only. Name of the dashboardChart.
28
+ # @!attribute [rw] display_name
29
+ # @return [::String]
30
+ # Required. Display name/Title of the dashboardChart visible to users.
31
+ # @!attribute [rw] description
32
+ # @return [::String]
33
+ # Optional. Description of the dashboardChart.
34
+ # @!attribute [r] native_dashboard
35
+ # @return [::String]
36
+ # Output only. NativeDashboard this chart belongs to.
37
+ # @!attribute [rw] tile_type
38
+ # @return [::Google::Cloud::Chronicle::V1::TileType]
39
+ # Optional. Type of tile i.e., visualization, button or text.
40
+ # @!attribute [rw] chart_datasource
41
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::ChartDatasource]
42
+ # Optional. Query and datasource used in the chart. Should be empty for
43
+ # Button Tiles.
44
+ # @!attribute [rw] visualization
45
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization]
46
+ # Required. Depending on tile_type one of below fields will be required.
47
+ # @!attribute [rw] etag
48
+ # @return [::String]
49
+ # Optional. This checksum is computed by the server based on the value of
50
+ # other fields, and may be sent on update and delete requests to ensure the
51
+ # client has an up-to-date value before proceeding.
52
+ # @!attribute [rw] drill_down_config
53
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig]
54
+ # Optional. Drill down configuration.
55
+ # @!attribute [rw] tokens
56
+ # @return [::Array<::String>]
57
+ # Optional. List of Advanced Filter tokens used in this chart's query (e.g.,
58
+ # "hostname", "ip"). This allows the UI to identify dependencies without
59
+ # parsing the query text. The tokens are stored without the wrapping '$'
60
+ # characters.
61
+ # The number of tokens are not expected to be more than 10.
62
+ class DashboardChart
63
+ include ::Google::Protobuf::MessageExts
64
+ extend ::Google::Protobuf::MessageExts::ClassMethods
65
+
66
+ # Datasource of the chart including the query reference and source name.
67
+ # @!attribute [rw] dashboard_query
68
+ # @return [::String]
69
+ # Reference to dashboard query resource used in the chart.
70
+ # @!attribute [rw] data_sources
71
+ # @return [::Array<::Google::Cloud::Chronicle::V1::DataSource>]
72
+ # Name of the datasource used in the chart.
73
+ class ChartDatasource
74
+ include ::Google::Protobuf::MessageExts
75
+ extend ::Google::Protobuf::MessageExts::ClassMethods
76
+ end
77
+
78
+ # Visualization config for a chart.
79
+ # https://echarts.apache.org/en/option.html#series
80
+ # @!attribute [rw] x_axes
81
+ # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>]
82
+ # @!attribute [rw] y_axes
83
+ # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Axis>]
84
+ # @!attribute [rw] series
85
+ # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series>]
86
+ # @!attribute [rw] tooltip
87
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Tooltip]
88
+ # @!attribute [rw] legends
89
+ # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Legend>]
90
+ # @!attribute [rw] column_defs
91
+ # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnDef>]
92
+ # Column Definition to represent chart as a table.
93
+ # @!attribute [rw] table_config
94
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::TableConfig]
95
+ # Optional. Configuration for table appearance.
96
+ # @!attribute [rw] button
97
+ # @return [::Google::Cloud::Chronicle::V1::Button]
98
+ # Button config for a chart if tileType is TILE_TYPE_BUTTON.
99
+ # @!attribute [rw] markdown
100
+ # @return [::Google::Cloud::Chronicle::V1::Markdown]
101
+ # Optional. Markdown config for a chart if tileType is TILE_TYPE_MARKDOWN.
102
+ # @!attribute [rw] series_column
103
+ # @return [::Array<::String>]
104
+ # Optional. Selected column for series
105
+ # @!attribute [rw] grouping_type
106
+ # @return [::String]
107
+ # Optional. Selected grouping type for series
108
+ # @!attribute [rw] google_maps_config
109
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig]
110
+ # Optional. Google Maps config for a chart if type is GOOGLE MAPS.
111
+ # @!attribute [rw] threshold_coloring_enabled
112
+ # @return [::Boolean]
113
+ # Optional. Whether threshold coloring is enabled for the chart. If it's
114
+ # enabled, the chart will be colored based on the values stored in
115
+ # VisualMap below.
116
+ # @!attribute [rw] visual_maps
117
+ # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap>]
118
+ # Optional. Visual maps for the chart.
119
+ class Visualization
120
+ include ::Google::Protobuf::MessageExts
121
+ extend ::Google::Protobuf::MessageExts::ClassMethods
122
+
123
+ # @!attribute [rw] axis_type
124
+ # @return [::Google::Cloud::Chronicle::V1::AxisType]
125
+ # @!attribute [rw] display_name
126
+ # @return [::String]
127
+ # @!attribute [rw] min
128
+ # @return [::Integer]
129
+ # Minimum value to be rendered in ECharts as per
130
+ # https://echarts.apache.org/en/option.html#xAxis.min
131
+ # @!attribute [rw] max
132
+ # @return [::Integer]
133
+ # Maximum value to be rendered in ECharts as per
134
+ # https://echarts.apache.org/en/option.html#xAxis.max
135
+ class Axis
136
+ include ::Google::Protobuf::MessageExts
137
+ extend ::Google::Protobuf::MessageExts::ClassMethods
138
+ end
139
+
140
+ # @!attribute [rw] series_type
141
+ # @return [::Google::Cloud::Chronicle::V1::SeriesType]
142
+ # @!attribute [rw] series_name
143
+ # @return [::String]
144
+ # user specified series label
145
+ # @!attribute [rw] show_symbol
146
+ # @return [::Boolean]
147
+ # @!attribute [rw] show_background
148
+ # @return [::Boolean]
149
+ # @!attribute [rw] stack
150
+ # @return [::String]
151
+ # @!attribute [rw] series_stack_strategy
152
+ # @return [::Google::Cloud::Chronicle::V1::SeriesStackStrategy]
153
+ # @!attribute [rw] encode
154
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::Encode]
155
+ # @!attribute [rw] label
156
+ # @return [::String]
157
+ # @!attribute [rw] field
158
+ # @return [::String]
159
+ # @!attribute [rw] data_label
160
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::DataLabel]
161
+ # Optional. Data label config for a series.
162
+ # Displays data vaule in the chart
163
+ # @!attribute [rw] radius
164
+ # @return [::Array<::String>]
165
+ # Optional. Used to make a pie chart into a douhnut chart
166
+ # @!attribute [rw] item_style
167
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemStyle]
168
+ # Optional. Custom styling for chart
169
+ # @!attribute [rw] series_unique_value
170
+ # @return [::String]
171
+ # Optional. Series unique value from the query result
172
+ # @!attribute [rw] area_style
173
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::AreaStyle]
174
+ # Optional. Custom styling for area chart
175
+ # @!attribute [rw] item_colors
176
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ItemColors]
177
+ # Optional. Field to be saved for retrieving slice colors for the chart
178
+ # @!attribute [rw] gauge_config
179
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeConfig]
180
+ # Optional. Field to be saved for retrieving gauge config for gauge chart
181
+ # @!attribute [rw] metric_trend_config
182
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::MetricTrendConfig]
183
+ # Optional. Fields to capture trend config for metric charts
184
+ class Series
185
+ include ::Google::Protobuf::MessageExts
186
+ extend ::Google::Protobuf::MessageExts::ClassMethods
187
+
188
+ # @!attribute [rw] x
189
+ # @return [::String]
190
+ # @!attribute [rw] y
191
+ # @return [::String]
192
+ # @!attribute [rw] value
193
+ # @return [::String]
194
+ # For some type of series that are not in any coordinate system, like
195
+ # 'pie'
196
+ # @!attribute [rw] item_name
197
+ # @return [::String]
198
+ # This is useful in charts like 'pie', where data item name can be
199
+ # displayed in legend.
200
+ class Encode
201
+ include ::Google::Protobuf::MessageExts
202
+ extend ::Google::Protobuf::MessageExts::ClassMethods
203
+ end
204
+
205
+ # Data label config for a series.
206
+ # @!attribute [rw] show
207
+ # @return [::Boolean]
208
+ # Optional. Whether to show data label.
209
+ class DataLabel
210
+ include ::Google::Protobuf::MessageExts
211
+ extend ::Google::Protobuf::MessageExts::ClassMethods
212
+ end
213
+
214
+ # Custom styling for chart
215
+ # @!attribute [rw] border_width
216
+ # @return [::Integer]
217
+ # Optional. Used to add border width
218
+ # @!attribute [rw] border_color
219
+ # @return [::String]
220
+ # Optional. Used to add border color
221
+ # @!attribute [rw] color
222
+ # @return [::String]
223
+ # Optional. Used to add color
224
+ class ItemStyle
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # Custom styling for area chart
230
+ # @!attribute [rw] color
231
+ # @return [::String]
232
+ # Optional. Used to add color
233
+ # @!attribute [rw] origin
234
+ # @return [::String]
235
+ # Optional. Used to add origin
236
+ # @!attribute [rw] shadow_blur
237
+ # @return [::Integer]
238
+ # Optional. Used to add shadow blur
239
+ # @!attribute [rw] shadow_color
240
+ # @return [::String]
241
+ # Optional. Used to add shadow color
242
+ # @!attribute [rw] shadow_offset_x
243
+ # @return [::Integer]
244
+ # Optional. Used to add shadow offsetX
245
+ # @!attribute [rw] shadow_offset_y
246
+ # @return [::Integer]
247
+ # Optional. Used to add shadow offsetY
248
+ # @!attribute [rw] opacity
249
+ # @return [::Integer]
250
+ # Optional. Used to add opacity
251
+ class AreaStyle
252
+ include ::Google::Protobuf::MessageExts
253
+ extend ::Google::Protobuf::MessageExts::ClassMethods
254
+ end
255
+
256
+ # User selected color and label for the slice of the chart
257
+ # @!attribute [rw] color
258
+ # @return [::String]
259
+ # Optional. User specified color of a pie slice
260
+ # @!attribute [rw] label
261
+ # @return [::String]
262
+ # Optional. User specified label for a pie slice
263
+ class UserSelectedValues
264
+ include ::Google::Protobuf::MessageExts
265
+ extend ::Google::Protobuf::MessageExts::ClassMethods
266
+ end
267
+
268
+ # Slice containing the key and value for a slice in the chart
269
+ # @!attribute [rw] key
270
+ # @return [::String]
271
+ # Optional. Key for the slice
272
+ # @!attribute [rw] value
273
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::UserSelectedValues]
274
+ # Optional. Value for the slice
275
+ class ChartSliceColor
276
+ include ::Google::Protobuf::MessageExts
277
+ extend ::Google::Protobuf::MessageExts::ClassMethods
278
+ end
279
+
280
+ # Field to be saved for retrieving slice colors for the chart
281
+ # @!attribute [rw] colors
282
+ # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::ChartSliceColor>]
283
+ # Optional. Slice colors array
284
+ class ItemColors
285
+ include ::Google::Protobuf::MessageExts
286
+ extend ::Google::Protobuf::MessageExts::ClassMethods
287
+ end
288
+
289
+ # Field to be saved for retrieving value and color for gauge chart
290
+ # @!attribute [rw] value
291
+ # @return [::Integer]
292
+ # Optional. Value for gauge chart
293
+ # @!attribute [rw] color
294
+ # @return [::String]
295
+ # Optional. Color for gauge chart
296
+ class GaugeValue
297
+ include ::Google::Protobuf::MessageExts
298
+ extend ::Google::Protobuf::MessageExts::ClassMethods
299
+ end
300
+
301
+ # Field to be saved for retrieving value and color for gauge chart
302
+ # @!attribute [rw] base_value
303
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue]
304
+ # Optional. Base value for gauge chart
305
+ # @!attribute [rw] limit_value
306
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue]
307
+ # Optional. Limit value for gauge chart
308
+ # @!attribute [rw] threshold_values
309
+ # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::Series::GaugeValue>]
310
+ # Optional. Threshold values for gauge chart
311
+ class GaugeConfig
312
+ include ::Google::Protobuf::MessageExts
313
+ extend ::Google::Protobuf::MessageExts::ClassMethods
314
+ end
315
+
316
+ # Metric trend config for displaying trend value in Metrics chart
317
+ # @!attribute [rw] metric_format
318
+ # @return [::Google::Cloud::Chronicle::V1::MetricFormat]
319
+ # Optional. Metric chart configuration to display metric trend
320
+ # @!attribute [rw] show_metric_trend
321
+ # @return [::Boolean]
322
+ # Optional. Metric chart configuration to toggle the trend value
323
+ # display
324
+ # @!attribute [rw] metric_display_trend
325
+ # @return [::Google::Cloud::Chronicle::V1::MetricDisplayTrend]
326
+ # Optional. Metric chart configuration to display the trend value
327
+ # @!attribute [rw] metric_trend_type
328
+ # @return [::Google::Cloud::Chronicle::V1::MetricTrendType]
329
+ # Optional. Metric chart configuration to display trend type whether
330
+ # regular or inverse
331
+ class MetricTrendConfig
332
+ include ::Google::Protobuf::MessageExts
333
+ extend ::Google::Protobuf::MessageExts::ClassMethods
334
+ end
335
+ end
336
+
337
+ # @!attribute [rw] show
338
+ # @return [::Boolean]
339
+ # @!attribute [rw] tooltip_trigger
340
+ # @return [::Google::Cloud::Chronicle::V1::ToolTipTrigger]
341
+ class Tooltip
342
+ include ::Google::Protobuf::MessageExts
343
+ extend ::Google::Protobuf::MessageExts::ClassMethods
344
+ end
345
+
346
+ # @!attribute [rw] id
347
+ # @return [::String]
348
+ # @!attribute [rw] show
349
+ # @return [::Boolean]
350
+ # @!attribute [rw] z_level
351
+ # @return [::Integer]
352
+ # @!attribute [rw] z
353
+ # @return [::Integer]
354
+ # @!attribute [rw] left
355
+ # @return [::Integer]
356
+ # @!attribute [rw] top
357
+ # @return [::Integer]
358
+ # @!attribute [rw] right
359
+ # @return [::Integer]
360
+ # @!attribute [rw] bottom
361
+ # @return [::Integer]
362
+ # @!attribute [rw] legend_orient
363
+ # @return [::Google::Cloud::Chronicle::V1::LegendOrient]
364
+ # @!attribute [rw] legend_align
365
+ # @return [::Google::Cloud::Chronicle::V1::LegendAlign]
366
+ # @!attribute [rw] padding
367
+ # @return [::Array<::Integer>]
368
+ class Legend
369
+ include ::Google::Protobuf::MessageExts
370
+ extend ::Google::Protobuf::MessageExts::ClassMethods
371
+ end
372
+
373
+ # Column Definition.
374
+ # @!attribute [rw] field
375
+ # @return [::String]
376
+ # Field key in data.
377
+ # @!attribute [rw] header
378
+ # @return [::String]
379
+ # Header name for column.
380
+ class ColumnDef
381
+ include ::Google::Protobuf::MessageExts
382
+ extend ::Google::Protobuf::MessageExts::ClassMethods
383
+ end
384
+
385
+ # Column render type settings. This is used to determine the data render
386
+ # type of the column in the table.
387
+ # @!attribute [rw] field
388
+ # @return [::String]
389
+ # Optional. Field key in data.
390
+ # @!attribute [rw] column_render_type
391
+ # @return [::Google::Cloud::Chronicle::V1::RenderType]
392
+ # Optional. Column render type.
393
+ class ColumnRenderTypeSettings
394
+ include ::Google::Protobuf::MessageExts
395
+ extend ::Google::Protobuf::MessageExts::ClassMethods
396
+ end
397
+
398
+ # Settings for tooltip for column header and cell.
399
+ # @!attribute [rw] field
400
+ # @return [::String]
401
+ # Required. Field key in data.
402
+ # @!attribute [rw] header_tooltip_text
403
+ # @return [::String]
404
+ # Optional. Column header tooltip text.
405
+ # @!attribute [rw] cell_tooltip_text
406
+ # @return [::String]
407
+ # Optional. Column cell tooltip text.
408
+ class ColumnTooltipSettings
409
+ include ::Google::Protobuf::MessageExts
410
+ extend ::Google::Protobuf::MessageExts::ClassMethods
411
+ end
412
+
413
+ # Configuration for table appearance.
414
+ # @!attribute [rw] enable_text_wrap
415
+ # @return [::Boolean]
416
+ # Optional. Whether to show the table.
417
+ # @!attribute [rw] column_render_type_settings
418
+ # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnRenderTypeSettings>]
419
+ # Optional. Column render type settings.
420
+ # @!attribute [rw] column_tooltip_settings
421
+ # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::ColumnTooltipSettings>]
422
+ # Optional. Settings for tooltip for column header and cell.
423
+ class TableConfig
424
+ include ::Google::Protobuf::MessageExts
425
+ extend ::Google::Protobuf::MessageExts::ClassMethods
426
+ end
427
+
428
+ # Google Maps config for a chart if chart type is map.
429
+ # @!attribute [rw] data_settings
430
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::DataSettings]
431
+ # Optional. Data settings for the map.
432
+ # @!attribute [rw] plot_mode
433
+ # @return [::Google::Cloud::Chronicle::V1::PlotMode]
434
+ # Optional. Plot mode for the map. This is used to determine whether to
435
+ # show points, heatmap or both.
436
+ # @!attribute [rw] map_position
437
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::MapPosition]
438
+ # Optional. Map position settings for the map.
439
+ # @!attribute [rw] point_settings
440
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::GoogleMapsConfig::PointSettings]
441
+ # Optional. Point settings for the map.
442
+ class GoogleMapsConfig
443
+ include ::Google::Protobuf::MessageExts
444
+ extend ::Google::Protobuf::MessageExts::ClassMethods
445
+
446
+ # Data settings for the map.
447
+ # @!attribute [rw] latitude_column
448
+ # @return [::String]
449
+ # Optional. Latitude column.
450
+ # @!attribute [rw] longitude_column
451
+ # @return [::String]
452
+ # Optional. Longitude column.
453
+ # @!attribute [rw] count_column
454
+ # @return [::String]
455
+ # Optional. Field to count.
456
+ class DataSettings
457
+ include ::Google::Protobuf::MessageExts
458
+ extend ::Google::Protobuf::MessageExts::ClassMethods
459
+ end
460
+
461
+ # Map position settings for the map.
462
+ # @!attribute [rw] fit_data
463
+ # @return [::Boolean]
464
+ # Optional. Whether to fit the map to the data.
465
+ # If true, the map will be resized to fit the data.
466
+ # If false, langitude and longitude will be used to set the map size.
467
+ # @!attribute [rw] latitude_value
468
+ # @return [::Float]
469
+ # Optional. Latitude of the map.
470
+ # @!attribute [rw] longitude_value
471
+ # @return [::Float]
472
+ # Optional. Longitude of the map.
473
+ # @!attribute [rw] zoom_scale_value
474
+ # @return [::Float]
475
+ # Optional. Scale of the map.
476
+ class MapPosition
477
+ include ::Google::Protobuf::MessageExts
478
+ extend ::Google::Protobuf::MessageExts::ClassMethods
479
+ end
480
+
481
+ # Point settings for the map.
482
+ # @!attribute [rw] point_size_type
483
+ # @return [::Google::Cloud::Chronicle::V1::PointSizeType]
484
+ # Optional. Point size type for the map. This is used to
485
+ # determine the size of the points on the map.
486
+ # @!attribute [rw] color
487
+ # @return [::String]
488
+ # Optional. Color for the point on the map.
489
+ class PointSettings
490
+ include ::Google::Protobuf::MessageExts
491
+ extend ::Google::Protobuf::MessageExts::ClassMethods
492
+ end
493
+ end
494
+
495
+ # Conveys what range of values should be rendered in what color. This field
496
+ # is used when threshold_coloring_enabled is true.
497
+ # @!attribute [rw] visual_map_type
498
+ # @return [::Google::Cloud::Chronicle::V1::VisualMapType]
499
+ # Optional. Contains one of the valid visual map types such as
500
+ # 'continuous' or 'piecewise'.
501
+ # @!attribute [rw] pieces
502
+ # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::Visualization::VisualMap::VisualMapPiece>]
503
+ # Optional. Pieces of the visual map.
504
+ class VisualMap
505
+ include ::Google::Protobuf::MessageExts
506
+ extend ::Google::Protobuf::MessageExts::ClassMethods
507
+
508
+ # An ECharts visual map of type 'piecewise' contain many pieces. Each
509
+ # piece has a min, max, and color with which it's rendered.
510
+ # @!attribute [rw] min
511
+ # @return [::Integer]
512
+ # Optional. Minimum value for the piece.
513
+ # @!attribute [rw] max
514
+ # @return [::Integer]
515
+ # Optional. Minimum value for the piece.
516
+ # @!attribute [rw] color
517
+ # @return [::String]
518
+ # Optional. Color to render the piece in when the value is between min
519
+ # and max.
520
+ # @!attribute [rw] label
521
+ # @return [::String]
522
+ # Optional. Label used in visual map controller.
523
+ class VisualMapPiece
524
+ include ::Google::Protobuf::MessageExts
525
+ extend ::Google::Protobuf::MessageExts::ClassMethods
526
+ end
527
+ end
528
+ end
529
+
530
+ # Drill down configuration.
531
+ # @!attribute [rw] left_drill_downs
532
+ # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>]
533
+ # Required. Left click drill downs.
534
+ # @!attribute [rw] right_drill_downs
535
+ # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown>]
536
+ # Required. Right click drill downs.
537
+ class DrillDownConfig
538
+ include ::Google::Protobuf::MessageExts
539
+ extend ::Google::Protobuf::MessageExts::ClassMethods
540
+
541
+ # Drill down config.
542
+ # @!attribute [rw] default_settings
543
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::DefaultDrillDownSettings]
544
+ # Default drill down settings.
545
+ #
546
+ # 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.
547
+ # @!attribute [rw] custom_settings
548
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings]
549
+ # Custom drill down settings.
550
+ #
551
+ # 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.
552
+ # @!attribute [rw] id
553
+ # @return [::String]
554
+ # Required. ID of the drill down.
555
+ # @!attribute [rw] display_name
556
+ # @return [::String]
557
+ # Required. Display name of the drill down.
558
+ class DrillDown
559
+ include ::Google::Protobuf::MessageExts
560
+ extend ::Google::Protobuf::MessageExts::ClassMethods
561
+
562
+ # Default drill down settings.
563
+ # @!attribute [rw] enabled
564
+ # @return [::Boolean]
565
+ # Required. Whether the default drill down is enabled.
566
+ class DefaultDrillDownSettings
567
+ include ::Google::Protobuf::MessageExts
568
+ extend ::Google::Protobuf::MessageExts::ClassMethods
569
+ end
570
+
571
+ # Custom drill down settings.
572
+ # @!attribute [rw] query
573
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownQuery]
574
+ # Drill down query action config.
575
+ #
576
+ # 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.
577
+ # @!attribute [rw] filter
578
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter]
579
+ # Drill down filter action config.
580
+ #
581
+ # 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.
582
+ # @!attribute [rw] external_link
583
+ # @return [::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownExternalLink]
584
+ # Drill down external link action config.
585
+ #
586
+ # 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.
587
+ # @!attribute [rw] new_tab
588
+ # @return [::Boolean]
589
+ # Required. Whether to open the drill down action in a new tab.
590
+ # @!attribute [rw] left_click_column
591
+ # @return [::String]
592
+ # Optional. Table chart column name to associate the custom drill down
593
+ # action on left click.
594
+ class CustomDrillDownSettings
595
+ include ::Google::Protobuf::MessageExts
596
+ extend ::Google::Protobuf::MessageExts::ClassMethods
597
+
598
+ # Drill down query config.
599
+ # @!attribute [rw] query
600
+ # @return [::String]
601
+ # Required. Search query to be executed on drill down.
602
+ class DrillDownQuery
603
+ include ::Google::Protobuf::MessageExts
604
+ extend ::Google::Protobuf::MessageExts::ClassMethods
605
+ end
606
+
607
+ # Drill down filter config.
608
+ # @!attribute [rw] dashboard_filters
609
+ # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart::DrillDownConfig::DrillDown::CustomDrillDownSettings::DrillDownFilter::DrillDownDashboardFilter>]
610
+ # Required. Dashboard filters to be applied on drill down.
611
+ class DrillDownFilter
612
+ include ::Google::Protobuf::MessageExts
613
+ extend ::Google::Protobuf::MessageExts::ClassMethods
614
+
615
+ # Drill down dashboard filter config.
616
+ # @!attribute [rw] dashboard_filter_id
617
+ # @return [::String]
618
+ # Required. ID of the dashboard filter.
619
+ # @!attribute [rw] filter_operator_and_values
620
+ # @return [::Array<::Google::Cloud::Chronicle::V1::FilterOperatorAndValues>]
621
+ # Required. Filter operator and field values for the dashboard
622
+ # filter.
623
+ class DrillDownDashboardFilter
624
+ include ::Google::Protobuf::MessageExts
625
+ extend ::Google::Protobuf::MessageExts::ClassMethods
626
+ end
627
+ end
628
+
629
+ # Drill down external link config.
630
+ # @!attribute [rw] link
631
+ # @return [::String]
632
+ # Required. External link the drill down action should redirect to.
633
+ # @!attribute [rw] description
634
+ # @return [::String]
635
+ # Optional. Description of the external link.
636
+ class DrillDownExternalLink
637
+ include ::Google::Protobuf::MessageExts
638
+ extend ::Google::Protobuf::MessageExts::ClassMethods
639
+ end
640
+ end
641
+ end
642
+ end
643
+ end
644
+
645
+ # Button config for a chart.
646
+ # @!attribute [rw] label
647
+ # @return [::String]
648
+ # @!attribute [rw] hyperlink
649
+ # @return [::String]
650
+ # @!attribute [rw] description
651
+ # @return [::String]
652
+ # @!attribute [rw] new_tab
653
+ # @return [::Boolean]
654
+ # Optional. Whether to open the link in a new tab.
655
+ # @!attribute [rw] properties
656
+ # @return [::Google::Cloud::Chronicle::V1::Button::Properties]
657
+ class Button
658
+ include ::Google::Protobuf::MessageExts
659
+ extend ::Google::Protobuf::MessageExts::ClassMethods
660
+
661
+ # @!attribute [rw] color
662
+ # @return [::String]
663
+ # @!attribute [rw] button_style
664
+ # @return [::Google::Cloud::Chronicle::V1::ButtonStyle]
665
+ class Properties
666
+ include ::Google::Protobuf::MessageExts
667
+ extend ::Google::Protobuf::MessageExts::ClassMethods
668
+ end
669
+ end
670
+
671
+ # Markdown config for a dashboard tile.
672
+ # @!attribute [rw] content
673
+ # @return [::String]
674
+ # Required. Markdown content.
675
+ # @!attribute [rw] properties
676
+ # @return [::Google::Cloud::Chronicle::V1::Markdown::MarkdownProperties]
677
+ # Optional. Properties for the markdown.
678
+ class Markdown
679
+ include ::Google::Protobuf::MessageExts
680
+ extend ::Google::Protobuf::MessageExts::ClassMethods
681
+
682
+ # Properties for the markdown.
683
+ # @!attribute [rw] background_color
684
+ # @return [::String]
685
+ # Optional. Background color of the markdown.
686
+ class MarkdownProperties
687
+ include ::Google::Protobuf::MessageExts
688
+ extend ::Google::Protobuf::MessageExts::ClassMethods
689
+ end
690
+ end
691
+
692
+ # Request message to get a dashboard chart.
693
+ # @!attribute [rw] name
694
+ # @return [::String]
695
+ # Required. The name of the dashboardChart to retrieve.
696
+ # Format:
697
+ # projects/\\{project}/locations/\\{location}/instances/\\{instance}/dashboardCharts/\\{chart}
698
+ class GetDashboardChartRequest
699
+ include ::Google::Protobuf::MessageExts
700
+ extend ::Google::Protobuf::MessageExts::ClassMethods
701
+ end
702
+
703
+ # Request message to get dashboard charts in batch.
704
+ # @!attribute [rw] parent
705
+ # @return [::String]
706
+ # Required. The parent resource shared by all dashboard charts being
707
+ # retrieved. Format:
708
+ # projects/\\{project}/locations/\\{location}/instances/\\{instance} If this is
709
+ # set, the parent of all of the dashboard charts specified in `names` must
710
+ # match this field.
711
+ # @!attribute [rw] names
712
+ # @return [::Array<::String>]
713
+ # Required. The names of the dashboard charts to get.
714
+ class BatchGetDashboardChartsRequest
715
+ include ::Google::Protobuf::MessageExts
716
+ extend ::Google::Protobuf::MessageExts::ClassMethods
717
+ end
718
+
719
+ # Response message for getting dashboard charts in batch.
720
+ # @!attribute [rw] dashboard_charts
721
+ # @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart>]
722
+ # The dashboardCharts from the specified chronicle instance.
723
+ class BatchGetDashboardChartsResponse
724
+ include ::Google::Protobuf::MessageExts
725
+ extend ::Google::Protobuf::MessageExts::ClassMethods
726
+ end
727
+
728
+ # TileType indicates what type of chart tile it is i.e., visualization chart,
729
+ # button or text.
730
+ module TileType
731
+ # Defaults to VISUALIZATION.
732
+ TILE_TYPE_UNSPECIFIED = 0
733
+
734
+ # Visualization i.e., bar charts, pie charts etc.
735
+ TILE_TYPE_VISUALIZATION = 1
736
+
737
+ # Button with hyperlink.
738
+ TILE_TYPE_BUTTON = 2
739
+
740
+ # Markdown tile.
741
+ TILE_TYPE_MARKDOWN = 3
742
+ end
743
+
744
+ # Render type of the data in the chart.
745
+ module RenderType
746
+ # Defaults to Unspecified.
747
+ RENDER_TYPE_UNSPECIFIED = 0
748
+
749
+ # Text render type.
750
+ RENDER_TYPE_TEXT = 1
751
+
752
+ # Icon render type.
753
+ RENDER_TYPE_ICON = 2
754
+
755
+ # Icon and text render type.
756
+ RENDER_TYPE_ICON_AND_TEXT = 3
757
+ end
758
+
759
+ module AxisType
760
+ AXIS_TYPE_UNSPECIFIED = 0
761
+
762
+ VALUE = 1
763
+
764
+ CATEGORY = 2
765
+
766
+ TIME = 3
767
+
768
+ LOG = 4
769
+ end
770
+
771
+ module SeriesType
772
+ SERIES_TYPE_UNSPECIFIED = 0
773
+
774
+ LINE = 1
775
+
776
+ BAR = 2
777
+
778
+ PIE = 3
779
+
780
+ TEXT = 4
781
+
782
+ # Represents map chart type.
783
+ MAP = 5
784
+
785
+ # Represents gauge chart type.
786
+ GAUGE = 6
787
+
788
+ # Represents scatterplot chart type.
789
+ SCATTERPLOT = 7
790
+ end
791
+
792
+ module SeriesStackStrategy
793
+ SERIES_STACK_STRATEGY_UNSPECIFIED = 0
794
+
795
+ SAMESIGN = 1
796
+
797
+ ALL = 2
798
+
799
+ POSITIVE = 3
800
+
801
+ NEGATIVE = 4
802
+ end
803
+
804
+ module ToolTipTrigger
805
+ TOOLTIP_TRIGGER_UNSPECIFIED = 0
806
+
807
+ TOOLTIP_TRIGGER_NONE = 1
808
+
809
+ TOOLTIP_TRIGGER_ITEM = 2
810
+
811
+ TOOLTIP_TRIGGER_AXIS = 3
812
+ end
813
+
814
+ module LegendOrient
815
+ LEGEND_ORIENT_UNSPECIFIED = 0
816
+
817
+ VERTICAL = 1
818
+
819
+ HORIZONTAL = 2
820
+ end
821
+
822
+ module LegendAlign
823
+ LEGEND_ALIGN_UNSPECIFIED = 0
824
+
825
+ AUTO = 1
826
+
827
+ LEFT = 2
828
+
829
+ RIGHT = 3
830
+ end
831
+
832
+ module ButtonStyle
833
+ BUTTON_STYLE_UNSPECIFIED = 0
834
+
835
+ BUTTON_STYLE_FILLED = 1
836
+
837
+ BUTTON_STYLE_OUTLINED = 2
838
+
839
+ BUTTON_STYLE_TRANSPARENT = 3
840
+ end
841
+
842
+ # Plot mode for the map.
843
+ module PlotMode
844
+ # Plot mode is not specified.
845
+ PLOT_MODE_UNSPECIFIED = 0
846
+
847
+ # Plot mode is points.
848
+ PLOT_MODE_POINTS = 1
849
+
850
+ # Plot mode is heatmap.
851
+ PLOT_MODE_HEATMAP = 2
852
+
853
+ # Plot mode is both points and heatmap.
854
+ PLOT_MODE_BOTH = 3
855
+ end
856
+
857
+ # Point size type for the map.
858
+ module PointSizeType
859
+ # Point size is not specified.
860
+ POINT_SIZE_TYPE_UNSPECIFIED = 0
861
+
862
+ # Point size is fixed.
863
+ POINT_SIZE_TYPE_FIXED = 1
864
+
865
+ # Point size is proportional to the size of the data point.
866
+ POINT_SIZE_TYPE_PROPORTIONAL_TO_SIZE = 2
867
+ end
868
+
869
+ # Metric format to be displayed for the metric charts.
870
+ module MetricFormat
871
+ # Metric format is not specified.
872
+ METRIC_FORMAT_UNSPECIFIED = 0
873
+
874
+ # Metric format in number
875
+ METRIC_FORMAT_NUMBER = 1
876
+
877
+ # Metric format in plain text
878
+ METRIC_FORMAT_PLAIN_TEXT = 2
879
+ end
880
+
881
+ # Trend to be displayed for the metric charts as.
882
+ module MetricDisplayTrend
883
+ # Trend is not specified.
884
+ METRIC_DISPLAY_TREND_UNSPECIFIED = 0
885
+
886
+ # Trend data in absolute value
887
+ METRIC_DISPLAY_TREND_ABSOLUTE_VALUE = 2
888
+
889
+ # Trend data in percentage
890
+ METRIC_DISPLAY_TREND_PERCENTAGE = 3
891
+
892
+ # Trend data in both absolute value and percentage
893
+ METRIC_DISPLAY_TREND_ABSOLUTE_VALUE_AND_PERCENTAGE = 4
894
+ end
895
+
896
+ # Trend to be displayed for the metric charts as.
897
+ module MetricTrendType
898
+ # Trend type is not specified.
899
+ METRIC_TREND_TYPE_UNSPECIFIED = 0
900
+
901
+ # The trend type is regular(green for positive delta)
902
+ METRIC_TREND_TYPE_REGULAR = 1
903
+
904
+ # The trend type is inverse(red for positive delta)
905
+ METRIC_TREND_TYPE_INVERSE = 2
906
+ end
907
+
908
+ # Visual map for various charts. More info:
909
+ # https://echarts.apache.org/en/option.html#visualMap
910
+ module VisualMapType
911
+ # Visual map type is not specified
912
+ VISUAL_MAP_TYPE_UNSPECIFIED = 0
913
+
914
+ # Continuous visual map
915
+ CONTINUOUS = 1
916
+
917
+ # Piecewise visual map
918
+ PIECEWISE = 2
919
+ end
920
+ end
921
+ end
922
+ end
923
+ end