google-cloud-chronicle-v1 0.4.0 → 0.6.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.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +4 -4
- data/README.md +6 -6
- data/lib/google/cloud/chronicle/v1/big_query_export_pb.rb +34 -0
- data/lib/google/cloud/chronicle/v1/big_query_export_service/client.rb +682 -0
- data/lib/google/cloud/chronicle/v1/big_query_export_service/credentials.rb +49 -0
- data/lib/google/cloud/chronicle/v1/big_query_export_service/paths.rb +71 -0
- data/lib/google/cloud/chronicle/v1/big_query_export_service/rest/client.rb +618 -0
- data/lib/google/cloud/chronicle/v1/big_query_export_service/rest/service_stub.rb +266 -0
- data/lib/google/cloud/chronicle/v1/big_query_export_service/rest.rb +52 -0
- data/lib/google/cloud/chronicle/v1/big_query_export_service.rb +55 -0
- data/lib/google/cloud/chronicle/v1/big_query_export_services_pb.rb +51 -0
- data/lib/google/cloud/chronicle/v1/dashboard_chart_pb.rb +83 -0
- data/lib/google/cloud/chronicle/v1/dashboard_chart_service/client.rb +584 -0
- data/lib/google/cloud/chronicle/v1/dashboard_chart_service/credentials.rb +49 -0
- data/lib/google/cloud/chronicle/v1/dashboard_chart_service/paths.rb +73 -0
- data/lib/google/cloud/chronicle/v1/dashboard_chart_service/rest/client.rb +527 -0
- data/lib/google/cloud/chronicle/v1/dashboard_chart_service/rest/service_stub.rb +203 -0
- data/lib/google/cloud/chronicle/v1/dashboard_chart_service/rest.rb +52 -0
- data/lib/google/cloud/chronicle/v1/dashboard_chart_service.rb +55 -0
- data/lib/google/cloud/chronicle/v1/dashboard_chart_services_pb.rb +47 -0
- data/lib/google/cloud/chronicle/v1/dashboard_query_pb.rb +58 -0
- data/lib/google/cloud/chronicle/v1/dashboard_query_service/client.rb +589 -0
- data/lib/google/cloud/chronicle/v1/dashboard_query_service/credentials.rb +49 -0
- data/lib/google/cloud/chronicle/v1/dashboard_query_service/paths.rb +94 -0
- data/lib/google/cloud/chronicle/v1/dashboard_query_service/rest/client.rb +532 -0
- data/lib/google/cloud/chronicle/v1/dashboard_query_service/rest/service_stub.rb +204 -0
- data/lib/google/cloud/chronicle/v1/dashboard_query_service/rest.rb +52 -0
- data/lib/google/cloud/chronicle/v1/dashboard_query_service.rb +55 -0
- data/lib/google/cloud/chronicle/v1/dashboard_query_services_pb.rb +47 -0
- data/lib/google/cloud/chronicle/v1/data_table_pb.rb +57 -0
- data/lib/google/cloud/chronicle/v1/data_table_service/client.rb +1915 -0
- data/lib/google/cloud/chronicle/v1/data_table_service/credentials.rb +49 -0
- data/lib/google/cloud/chronicle/v1/data_table_service/paths.rb +138 -0
- data/lib/google/cloud/chronicle/v1/data_table_service/rest/client.rb +1767 -0
- data/lib/google/cloud/chronicle/v1/data_table_service/rest/service_stub.rb +1004 -0
- data/lib/google/cloud/chronicle/v1/data_table_service/rest.rb +52 -0
- data/lib/google/cloud/chronicle/v1/data_table_service.rb +55 -0
- data/lib/google/cloud/chronicle/v1/data_table_services_pb.rb +73 -0
- data/lib/google/cloud/chronicle/v1/featured_content_metadata_pb.rb +25 -0
- data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_pb.rb +33 -0
- data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/client.rb +717 -0
- data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/credentials.rb +49 -0
- data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/paths.rb +136 -0
- data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/rest/client.rb +653 -0
- data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/rest/service_stub.rb +265 -0
- data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service/rest.rb +53 -0
- data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_service.rb +56 -0
- data/lib/google/cloud/chronicle/v1/featured_content_native_dashboard_services_pb.rb +50 -0
- data/lib/google/cloud/chronicle/v1/native_dashboard_pb.rb +61 -0
- data/lib/google/cloud/chronicle/v1/native_dashboard_service/client.rb +1611 -0
- data/lib/google/cloud/chronicle/v1/native_dashboard_service/credentials.rb +49 -0
- data/lib/google/cloud/chronicle/v1/native_dashboard_service/paths.rb +115 -0
- data/lib/google/cloud/chronicle/v1/native_dashboard_service/rest/client.rb +1484 -0
- data/lib/google/cloud/chronicle/v1/native_dashboard_service/rest/service_stub.rb +822 -0
- data/lib/google/cloud/chronicle/v1/native_dashboard_service/rest.rb +52 -0
- data/lib/google/cloud/chronicle/v1/native_dashboard_service.rb +55 -0
- data/lib/google/cloud/chronicle/v1/native_dashboard_services_pb.rb +67 -0
- data/lib/google/cloud/chronicle/v1/rest.rb +7 -1
- data/lib/google/cloud/chronicle/v1/version.rb +1 -1
- data/lib/google/cloud/chronicle/v1.rb +8 -2
- data/proto_docs/google/api/client.rb +149 -29
- data/proto_docs/google/cloud/chronicle/v1/big_query_export.rb +142 -0
- data/proto_docs/google/cloud/chronicle/v1/dashboard_chart.rb +923 -0
- data/proto_docs/google/cloud/chronicle/v1/dashboard_query.rb +653 -0
- data/proto_docs/google/cloud/chronicle/v1/data_table.rb +512 -0
- data/proto_docs/google/cloud/chronicle/v1/featured_content_metadata.rb +82 -0
- data/proto_docs/google/cloud/chronicle/v1/featured_content_native_dashboard.rb +141 -0
- data/proto_docs/google/cloud/chronicle/v1/native_dashboard.rb +502 -0
- data/proto_docs/google/type/date.rb +56 -0
- metadata +71 -9
|
@@ -0,0 +1,141 @@
|
|
|
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
|
+
# FeaturedContentNativeDashboard resource.
|
|
25
|
+
# @!attribute [rw] name
|
|
26
|
+
# @return [::String]
|
|
27
|
+
# Identifier. The resource name of the FeaturedContentNativeDashboard.
|
|
28
|
+
# Format:
|
|
29
|
+
# projects/\\{project}/locations/\\{location}/instances/\\{instance}/contentHub/featuredContentNativeDashboards/\\{featured_content_native_dashboard}
|
|
30
|
+
# @!attribute [r] content_metadata
|
|
31
|
+
# @return [::Google::Cloud::Chronicle::V1::FeaturedContentMetadata]
|
|
32
|
+
# Output only. Metadata about the FeaturedContentNativeDashboard.
|
|
33
|
+
# @!attribute [rw] dashboard_content
|
|
34
|
+
# @return [::Google::Cloud::Chronicle::V1::NativeDashboardWithChartsAndQueries]
|
|
35
|
+
# Optional. The dashboard content.
|
|
36
|
+
class FeaturedContentNativeDashboard
|
|
37
|
+
include ::Google::Protobuf::MessageExts
|
|
38
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
# Request message to get a FeaturedContentNativeDashboard.
|
|
42
|
+
# @!attribute [rw] name
|
|
43
|
+
# @return [::String]
|
|
44
|
+
# Required. The resource name of the FeaturedContentNativeDashboard to
|
|
45
|
+
# retrieve. Format:
|
|
46
|
+
# projects/\\{project}/locations/\\{location}/instances/\\{instance}/contentHub/featuredContentNativeDashboards/\\{featured_content_native_dashboard}
|
|
47
|
+
class GetFeaturedContentNativeDashboardRequest
|
|
48
|
+
include ::Google::Protobuf::MessageExts
|
|
49
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
# Request message to list FeaturedContentNativeDashboards.
|
|
53
|
+
# @!attribute [rw] parent
|
|
54
|
+
# @return [::String]
|
|
55
|
+
# Required. The parent, which owns this collection of
|
|
56
|
+
# FeaturedContentNativeDashboards. Format:
|
|
57
|
+
# projects/\\{project}/locations/\\{location}/instances/\\{instance}/contentHub
|
|
58
|
+
# @!attribute [rw] page_size
|
|
59
|
+
# @return [::Integer]
|
|
60
|
+
# Optional. The maximum number of FeaturedContentNativeDashboards to return.
|
|
61
|
+
# The service may return fewer than this value. If unspecified, at most 100
|
|
62
|
+
# FeaturedContentNativeDashboards will be returned. The maximum value is 100;
|
|
63
|
+
# values above 100 will be coerced to 100.
|
|
64
|
+
# @!attribute [rw] page_token
|
|
65
|
+
# @return [::String]
|
|
66
|
+
# Optional. A page token, received from a previous
|
|
67
|
+
# `ListFeaturedContentNativeDashboards` call. Provide this to retrieve the
|
|
68
|
+
# subsequent page.
|
|
69
|
+
#
|
|
70
|
+
# When paginating, all other parameters provided to
|
|
71
|
+
# `ListFeaturedContentNativeDashboards` must match the call that provided the
|
|
72
|
+
# page token.
|
|
73
|
+
# @!attribute [rw] filter
|
|
74
|
+
# @return [::String]
|
|
75
|
+
# Optional. The filter to apply to list the FeaturedContentNativeDashboards.
|
|
76
|
+
#
|
|
77
|
+
# The filter syntax follows Google Cloud syntax: https://google.aip.dev/160.
|
|
78
|
+
#
|
|
79
|
+
# Supported fields for filtering:
|
|
80
|
+
#
|
|
81
|
+
# * `name`: The resource name of the featured content.
|
|
82
|
+
# * `content_metadata.description`: The description of the featured
|
|
83
|
+
# content.
|
|
84
|
+
#
|
|
85
|
+
# When a literal value is provided without a field, it will perform a
|
|
86
|
+
# substring search across both `name` and `content_metadata.description`.
|
|
87
|
+
#
|
|
88
|
+
# Examples:
|
|
89
|
+
#
|
|
90
|
+
# * `"test"`: Matches featured content where either the name or description
|
|
91
|
+
# contains "test" as a substring.
|
|
92
|
+
# * `name="test"`: Matches featured content where the name contains "test".
|
|
93
|
+
# * `content_metadata.description="test"`: Matches featured content where
|
|
94
|
+
# the description contains "test".
|
|
95
|
+
class ListFeaturedContentNativeDashboardsRequest
|
|
96
|
+
include ::Google::Protobuf::MessageExts
|
|
97
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
# Response message for listing FeaturedContentNativeDashboards.
|
|
101
|
+
# @!attribute [rw] featured_content_native_dashboards
|
|
102
|
+
# @return [::Array<::Google::Cloud::Chronicle::V1::FeaturedContentNativeDashboard>]
|
|
103
|
+
# The list of FeaturedContentNativeDashboards.
|
|
104
|
+
# Ordered by name by default.
|
|
105
|
+
# @!attribute [rw] next_page_token
|
|
106
|
+
# @return [::String]
|
|
107
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
|
108
|
+
# If this field is omitted, there are no subsequent pages.
|
|
109
|
+
class ListFeaturedContentNativeDashboardsResponse
|
|
110
|
+
include ::Google::Protobuf::MessageExts
|
|
111
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
# Request message to install a FeaturedContentNativeDashboard.
|
|
115
|
+
# @!attribute [rw] name
|
|
116
|
+
# @return [::String]
|
|
117
|
+
# Required. The resource name of the FeaturedContentNativeDashboard to
|
|
118
|
+
# install. Format:
|
|
119
|
+
# projects/\\{project}/locations/\\{location}/instances/\\{instance}/contentHub/featuredContentNativeDashboards/\\{featured_content_native_dashboard}
|
|
120
|
+
# @!attribute [rw] featured_content_native_dashboard
|
|
121
|
+
# @return [::Google::Cloud::Chronicle::V1::FeaturedContentNativeDashboard]
|
|
122
|
+
# Optional. The FeaturedContentNativeDashboard to install.
|
|
123
|
+
class InstallFeaturedContentNativeDashboardRequest
|
|
124
|
+
include ::Google::Protobuf::MessageExts
|
|
125
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
# Response message for installing a FeaturedContentNativeDashboard.
|
|
129
|
+
# @!attribute [rw] native_dashboard
|
|
130
|
+
# @return [::String]
|
|
131
|
+
# Optional. The resource name of the NativeDashboard created.
|
|
132
|
+
# Format:
|
|
133
|
+
# projects/\\{project}/locations/\\{location}/instances/\\{instance}/nativeDashboards/\\{native_dashboard_id}
|
|
134
|
+
class InstallFeaturedContentNativeDashboardResponse
|
|
135
|
+
include ::Google::Protobuf::MessageExts
|
|
136
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
137
|
+
end
|
|
138
|
+
end
|
|
139
|
+
end
|
|
140
|
+
end
|
|
141
|
+
end
|
|
@@ -0,0 +1,502 @@
|
|
|
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
|
+
# Request message to export list of dashboard.
|
|
25
|
+
# @!attribute [rw] parent
|
|
26
|
+
# @return [::String]
|
|
27
|
+
# Required. The parent resource that the dashboards to be exported belong to.
|
|
28
|
+
# Format: projects/\\{project}/locations/\\{location}/instances/\\{instance}
|
|
29
|
+
# @!attribute [rw] names
|
|
30
|
+
# @return [::Array<::String>]
|
|
31
|
+
# Required. The resource names of the dashboards to export.
|
|
32
|
+
class ExportNativeDashboardsRequest
|
|
33
|
+
include ::Google::Protobuf::MessageExts
|
|
34
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# Response message for exporting a dashboard.
|
|
38
|
+
# @!attribute [rw] inline_destination
|
|
39
|
+
# @return [::Google::Cloud::Chronicle::V1::InlineDestination]
|
|
40
|
+
# The data for the exported dashboards included directly in the response.
|
|
41
|
+
class ExportNativeDashboardsResponse
|
|
42
|
+
include ::Google::Protobuf::MessageExts
|
|
43
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# InlineDestination for exporting a dashboard.
|
|
47
|
+
# @!attribute [rw] dashboards
|
|
48
|
+
# @return [::Array<::Google::Cloud::Chronicle::V1::NativeDashboardWithChartsAndQueries>]
|
|
49
|
+
# Dashboards with charts and queries.
|
|
50
|
+
class InlineDestination
|
|
51
|
+
include ::Google::Protobuf::MessageExts
|
|
52
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# NativeDashboardWithChartsAndQueries for exporting a dashboard.
|
|
56
|
+
# @!attribute [rw] dashboard
|
|
57
|
+
# @return [::Google::Cloud::Chronicle::V1::NativeDashboard]
|
|
58
|
+
# Optional. Native dashboard.
|
|
59
|
+
# @!attribute [rw] dashboard_charts
|
|
60
|
+
# @return [::Array<::Google::Cloud::Chronicle::V1::DashboardChart>]
|
|
61
|
+
# Optional. Charts in the dashboard.
|
|
62
|
+
# @!attribute [rw] dashboard_queries
|
|
63
|
+
# @return [::Array<::Google::Cloud::Chronicle::V1::DashboardQuery>]
|
|
64
|
+
# Optional. Queries in the dashboard.
|
|
65
|
+
class NativeDashboardWithChartsAndQueries
|
|
66
|
+
include ::Google::Protobuf::MessageExts
|
|
67
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
# Request message to import dashboards.
|
|
71
|
+
# @!attribute [rw] parent
|
|
72
|
+
# @return [::String]
|
|
73
|
+
# Required. The parent resource where this dashboard will be created.
|
|
74
|
+
# Format: projects/\\{project}/locations/\\{location}/instances/\\{instance}
|
|
75
|
+
# @!attribute [rw] source
|
|
76
|
+
# @return [::Google::Cloud::Chronicle::V1::ImportNativeDashboardsInlineSource]
|
|
77
|
+
# Required. The data will imported from this proto.
|
|
78
|
+
class ImportNativeDashboardsRequest
|
|
79
|
+
include ::Google::Protobuf::MessageExts
|
|
80
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# Inline source for importing dashboards.
|
|
84
|
+
# @!attribute [rw] dashboards
|
|
85
|
+
# @return [::Array<::Google::Cloud::Chronicle::V1::NativeDashboardWithChartsAndQueries>]
|
|
86
|
+
# Required. Dashboards with charts and queries.
|
|
87
|
+
class ImportNativeDashboardsInlineSource
|
|
88
|
+
include ::Google::Protobuf::MessageExts
|
|
89
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
# Response message for importing dashboards.
|
|
93
|
+
# @!attribute [r] results
|
|
94
|
+
# @return [::Array<::Google::Cloud::Chronicle::V1::ImportExportStatus>]
|
|
95
|
+
# Output only. Represents the status of an import operation for multiple
|
|
96
|
+
# dashboards. Each dashboard's import status is tracked. A status of OK
|
|
97
|
+
# indicates the dashboard was ready for import. Otherwise, an appropriate
|
|
98
|
+
# error code and message are provided. Importantly, the import process is
|
|
99
|
+
# all-or-nothing: if even one dashboard fails to import, the entire import
|
|
100
|
+
# operation is aborted, and none of the dashboards are imported. The order of
|
|
101
|
+
# the statuses will be the same as in the import request.
|
|
102
|
+
class ImportNativeDashboardsResponse
|
|
103
|
+
include ::Google::Protobuf::MessageExts
|
|
104
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
# ImportExportStatus is a wrapper for dashboard name and status.
|
|
108
|
+
# @!attribute [rw] dashboard
|
|
109
|
+
# @return [::String]
|
|
110
|
+
# The resource name of the dashboard if it was supplied in the request.
|
|
111
|
+
# @!attribute [r] status
|
|
112
|
+
# @return [::Google::Rpc::Status]
|
|
113
|
+
# Output only. Status of the import/export operation.
|
|
114
|
+
class ImportExportStatus
|
|
115
|
+
include ::Google::Protobuf::MessageExts
|
|
116
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
# NativeDashboard resource.
|
|
120
|
+
# @!attribute [r] name
|
|
121
|
+
# @return [::String]
|
|
122
|
+
# Output only. Name of the dashboard.
|
|
123
|
+
# @!attribute [rw] display_name
|
|
124
|
+
# @return [::String]
|
|
125
|
+
# Required. Dashboard display name/title visible to users.
|
|
126
|
+
# @!attribute [rw] description
|
|
127
|
+
# @return [::String]
|
|
128
|
+
# Optional. Description of the dashboard.
|
|
129
|
+
# @!attribute [rw] definition
|
|
130
|
+
# @return [::Google::Cloud::Chronicle::V1::DashboardDefinition]
|
|
131
|
+
# Optional. Definition of the dashboard like metadata, visualization and
|
|
132
|
+
# datasource configuration etc.
|
|
133
|
+
# @!attribute [r] type
|
|
134
|
+
# @return [::Google::Cloud::Chronicle::V1::DashboardType]
|
|
135
|
+
# Output only. Whether it's an out of the box or custom created dashboard.
|
|
136
|
+
# @!attribute [r] create_time
|
|
137
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
138
|
+
# Output only. Creation time of dashboard.
|
|
139
|
+
# @!attribute [r] update_time
|
|
140
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
141
|
+
# Output only. Time the dashboard was last edited.
|
|
142
|
+
# @!attribute [r] create_user_id
|
|
143
|
+
# @return [::String]
|
|
144
|
+
# Output only. User who created the dashboard.
|
|
145
|
+
# @!attribute [r] update_user_id
|
|
146
|
+
# @return [::String]
|
|
147
|
+
# Output only. User who last edited the dashboard.
|
|
148
|
+
# @!attribute [r] dashboard_user_data
|
|
149
|
+
# @return [::Google::Cloud::Chronicle::V1::DashboardUserData]
|
|
150
|
+
# Output only. User Preferences for a dashboard
|
|
151
|
+
# @!attribute [rw] etag
|
|
152
|
+
# @return [::String]
|
|
153
|
+
# Optional. This checksum is computed by the server based on the value of
|
|
154
|
+
# other fields, and may be sent on update and delete requests to ensure the
|
|
155
|
+
# client has an up-to-date value before proceeding.
|
|
156
|
+
# @!attribute [r] access
|
|
157
|
+
# @return [::Google::Cloud::Chronicle::V1::DashboardAccess]
|
|
158
|
+
# Output only. Access of the dashboard
|
|
159
|
+
class NativeDashboard
|
|
160
|
+
include ::Google::Protobuf::MessageExts
|
|
161
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
# Request message to create a dashboard.
|
|
165
|
+
# @!attribute [rw] parent
|
|
166
|
+
# @return [::String]
|
|
167
|
+
# Required. The parent resource where this dashboard will be created.
|
|
168
|
+
# Format: projects/\\{project}/locations/\\{location}/instances/\\{instance}
|
|
169
|
+
# @!attribute [rw] native_dashboard
|
|
170
|
+
# @return [::Google::Cloud::Chronicle::V1::NativeDashboard]
|
|
171
|
+
# Required. The dashboard to create.
|
|
172
|
+
class CreateNativeDashboardRequest
|
|
173
|
+
include ::Google::Protobuf::MessageExts
|
|
174
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
# Request message to get a dashboard.
|
|
178
|
+
# @!attribute [rw] name
|
|
179
|
+
# @return [::String]
|
|
180
|
+
# Required. The dashboard name to fetch.
|
|
181
|
+
# Format:
|
|
182
|
+
# projects/\\{project}/locations/\\{location}/instances/\\{instance}/nativeDashboards/\\{dashboard}
|
|
183
|
+
# @!attribute [rw] view
|
|
184
|
+
# @return [::Google::Cloud::Chronicle::V1::NativeDashboardView]
|
|
185
|
+
# Optional. View indicates the scope of fields to populate when returning the
|
|
186
|
+
# dashboard resource. If unspecified, defaults to the basic view.
|
|
187
|
+
class GetNativeDashboardRequest
|
|
188
|
+
include ::Google::Protobuf::MessageExts
|
|
189
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
# Request message to list dashboards.
|
|
193
|
+
# @!attribute [rw] parent
|
|
194
|
+
# @return [::String]
|
|
195
|
+
# Required. The parent owning this dashboard collection.
|
|
196
|
+
# Format: projects/\\{project}/locations/\\{location}/instances/\\{instance}
|
|
197
|
+
# @!attribute [rw] page_size
|
|
198
|
+
# @return [::Integer]
|
|
199
|
+
# Optional. The maximum number of dashboards to return. The service may
|
|
200
|
+
# return fewer than this value.
|
|
201
|
+
# @!attribute [rw] page_token
|
|
202
|
+
# @return [::String]
|
|
203
|
+
# Optional. A page token, received from a previous `ListDashboards` call.
|
|
204
|
+
# Provide this to retrieve the subsequent page.
|
|
205
|
+
#
|
|
206
|
+
# When paginating, all other parameters provided to `ListDashboards` must
|
|
207
|
+
# match the call that provided the page token.
|
|
208
|
+
# @!attribute [rw] view
|
|
209
|
+
# @return [::Google::Cloud::Chronicle::V1::NativeDashboardView]
|
|
210
|
+
# Optional. View indicates the scope of fields to populate when returning the
|
|
211
|
+
# dashboard resource. If unspecified, defaults to the basic view.
|
|
212
|
+
class ListNativeDashboardsRequest
|
|
213
|
+
include ::Google::Protobuf::MessageExts
|
|
214
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
215
|
+
end
|
|
216
|
+
|
|
217
|
+
# Response message for listing dashboards.
|
|
218
|
+
# @!attribute [rw] native_dashboards
|
|
219
|
+
# @return [::Array<::Google::Cloud::Chronicle::V1::NativeDashboard>]
|
|
220
|
+
# The dashboards from the specified chronicle instance.
|
|
221
|
+
# @!attribute [rw] next_page_token
|
|
222
|
+
# @return [::String]
|
|
223
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
|
224
|
+
# If this field is omitted, there are no subsequent pages.
|
|
225
|
+
class ListNativeDashboardsResponse
|
|
226
|
+
include ::Google::Protobuf::MessageExts
|
|
227
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
# Request message to update a dashboard.
|
|
231
|
+
# @!attribute [rw] native_dashboard
|
|
232
|
+
# @return [::Google::Cloud::Chronicle::V1::NativeDashboard]
|
|
233
|
+
# Required. The dashboard to update.
|
|
234
|
+
#
|
|
235
|
+
# The dashboard's `name` field is used to identify the dashboard to update.
|
|
236
|
+
# Format:
|
|
237
|
+
# projects/\\{project}/locations/\\{location}/instances/\\{instance}/nativeDashboards/\\{dashboard}
|
|
238
|
+
# @!attribute [rw] update_mask
|
|
239
|
+
# @return [::Google::Protobuf::FieldMask]
|
|
240
|
+
# Required. LINT.IfChange(update_mask_values)
|
|
241
|
+
# The list of fields to update.
|
|
242
|
+
# Supported paths are -
|
|
243
|
+
# display_name
|
|
244
|
+
# description
|
|
245
|
+
# definition.filters
|
|
246
|
+
# definition.charts
|
|
247
|
+
# type
|
|
248
|
+
# access
|
|
249
|
+
# dashboard_user_data.is_pinned
|
|
250
|
+
class UpdateNativeDashboardRequest
|
|
251
|
+
include ::Google::Protobuf::MessageExts
|
|
252
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
253
|
+
end
|
|
254
|
+
|
|
255
|
+
# Request message to duplicate a dashboard.
|
|
256
|
+
# @!attribute [rw] name
|
|
257
|
+
# @return [::String]
|
|
258
|
+
# Required. The dashboard name to duplicate.
|
|
259
|
+
# Format:
|
|
260
|
+
# projects/\\{project}/locations/\\{location}/instances/\\{instance}/nativeDashboards/\\{dashboard}
|
|
261
|
+
# @!attribute [rw] native_dashboard
|
|
262
|
+
# @return [::Google::Cloud::Chronicle::V1::NativeDashboard]
|
|
263
|
+
# Required. Any fields that need modification can be passed through this like
|
|
264
|
+
# name, description etc.
|
|
265
|
+
class DuplicateNativeDashboardRequest
|
|
266
|
+
include ::Google::Protobuf::MessageExts
|
|
267
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
268
|
+
end
|
|
269
|
+
|
|
270
|
+
# Request message to delete a dashboard.
|
|
271
|
+
# @!attribute [rw] name
|
|
272
|
+
# @return [::String]
|
|
273
|
+
# Required. The dashboard name to delete.
|
|
274
|
+
# Format:
|
|
275
|
+
# projects/\\{project}/locations/\\{location}/instances/\\{instance}/nativeDashboards/\\{dashboard}
|
|
276
|
+
class DeleteNativeDashboardRequest
|
|
277
|
+
include ::Google::Protobuf::MessageExts
|
|
278
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
279
|
+
end
|
|
280
|
+
|
|
281
|
+
# Request message to add chart in a dashboard.
|
|
282
|
+
# @!attribute [rw] name
|
|
283
|
+
# @return [::String]
|
|
284
|
+
# Required. The dashboard name to add chart in.
|
|
285
|
+
# Format:
|
|
286
|
+
# projects/\\{project}/locations/\\{location}/instances/\\{instance}/nativeDashboards/\\{dashboard}
|
|
287
|
+
# @!attribute [rw] dashboard_query
|
|
288
|
+
# @return [::Google::Cloud::Chronicle::V1::DashboardQuery]
|
|
289
|
+
# Optional. Query used to create the chart.
|
|
290
|
+
# @!attribute [rw] dashboard_chart
|
|
291
|
+
# @return [::Google::Cloud::Chronicle::V1::DashboardChart]
|
|
292
|
+
# Required. Chart to be added to the dashboard.
|
|
293
|
+
# @!attribute [rw] chart_layout
|
|
294
|
+
# @return [::Google::Cloud::Chronicle::V1::DashboardDefinition::ChartConfig::ChartLayout]
|
|
295
|
+
# Required. ChartLayout for newly added chart.
|
|
296
|
+
class AddChartRequest
|
|
297
|
+
include ::Google::Protobuf::MessageExts
|
|
298
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
299
|
+
end
|
|
300
|
+
|
|
301
|
+
# Response message for adding chart in a dashboard.
|
|
302
|
+
# @!attribute [rw] native_dashboard
|
|
303
|
+
# @return [::Google::Cloud::Chronicle::V1::NativeDashboard]
|
|
304
|
+
# Dashboard with chart added in definition.
|
|
305
|
+
# @!attribute [rw] dashboard_chart
|
|
306
|
+
# @return [::Google::Cloud::Chronicle::V1::DashboardChart]
|
|
307
|
+
# Created chart resource.
|
|
308
|
+
class AddChartResponse
|
|
309
|
+
include ::Google::Protobuf::MessageExts
|
|
310
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
311
|
+
end
|
|
312
|
+
|
|
313
|
+
# Request message to edit chart in a dashboard.
|
|
314
|
+
# @!attribute [rw] name
|
|
315
|
+
# @return [::String]
|
|
316
|
+
# Required. The dashboard name to edit chart in.
|
|
317
|
+
# Format:
|
|
318
|
+
# projects/\\{project}/locations/\\{location}/instances/\\{instance}/nativeDashboards/\\{dashboard}
|
|
319
|
+
# @!attribute [rw] dashboard_query
|
|
320
|
+
# @return [::Google::Cloud::Chronicle::V1::DashboardQuery]
|
|
321
|
+
# Optional. Query for the edited chart.
|
|
322
|
+
# @!attribute [rw] dashboard_chart
|
|
323
|
+
# @return [::Google::Cloud::Chronicle::V1::DashboardChart]
|
|
324
|
+
# Optional. Edited chart.
|
|
325
|
+
# @!attribute [rw] edit_mask
|
|
326
|
+
# @return [::Google::Protobuf::FieldMask]
|
|
327
|
+
# Required. The list of fields to edit for chart and query.
|
|
328
|
+
# Supported paths in chart are -
|
|
329
|
+
# dashboard_chart.display_name
|
|
330
|
+
# dashboard_chart.description
|
|
331
|
+
# dashboard_chart.chart_datasource.data_sources
|
|
332
|
+
# dashboard_chart.visualization
|
|
333
|
+
# dashboard_chart.visualization.button
|
|
334
|
+
# dashboard_chart.visualization.markdown
|
|
335
|
+
# dashboard_chart.drill_down_config
|
|
336
|
+
# Supported paths in query are -
|
|
337
|
+
# dashboard_query.query
|
|
338
|
+
# dashboard_query.input
|
|
339
|
+
# @!attribute [rw] language_features
|
|
340
|
+
# @return [::Array<::Google::Cloud::Chronicle::V1::LanguageFeature>]
|
|
341
|
+
# Optional. Language Features present in the query.
|
|
342
|
+
class EditChartRequest
|
|
343
|
+
include ::Google::Protobuf::MessageExts
|
|
344
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
345
|
+
end
|
|
346
|
+
|
|
347
|
+
# Response message for editing chart in a dashboard.
|
|
348
|
+
# @!attribute [rw] native_dashboard
|
|
349
|
+
# @return [::Google::Cloud::Chronicle::V1::NativeDashboard]
|
|
350
|
+
# Edited dashboard.
|
|
351
|
+
# @!attribute [rw] dashboard_chart
|
|
352
|
+
# @return [::Google::Cloud::Chronicle::V1::DashboardChart]
|
|
353
|
+
# Edited chart resource.
|
|
354
|
+
class EditChartResponse
|
|
355
|
+
include ::Google::Protobuf::MessageExts
|
|
356
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
357
|
+
end
|
|
358
|
+
|
|
359
|
+
# Request message to remove chart from a dashboard.
|
|
360
|
+
# @!attribute [rw] name
|
|
361
|
+
# @return [::String]
|
|
362
|
+
# Required. The dashboard name to remove chart from.
|
|
363
|
+
# Format:
|
|
364
|
+
# projects/\\{project}/locations/\\{location}/instances/\\{instance}/nativeDashboards/\\{dashboard}
|
|
365
|
+
# @!attribute [rw] dashboard_chart
|
|
366
|
+
# @return [::String]
|
|
367
|
+
# Required. The dashboard chart name to remove.
|
|
368
|
+
class RemoveChartRequest
|
|
369
|
+
include ::Google::Protobuf::MessageExts
|
|
370
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
371
|
+
end
|
|
372
|
+
|
|
373
|
+
# Request message to duplicate chart in a dashboard.
|
|
374
|
+
# @!attribute [rw] name
|
|
375
|
+
# @return [::String]
|
|
376
|
+
# Required. The dashboard name that involves chart duplication.
|
|
377
|
+
# Format:
|
|
378
|
+
# projects/\\{project}/locations/\\{location}/instances/\\{instance}/nativeDashboards/\\{dashboard}
|
|
379
|
+
# @!attribute [rw] dashboard_chart
|
|
380
|
+
# @return [::String]
|
|
381
|
+
# Required. The dashboard chart name to duplicate.
|
|
382
|
+
class DuplicateChartRequest
|
|
383
|
+
include ::Google::Protobuf::MessageExts
|
|
384
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
385
|
+
end
|
|
386
|
+
|
|
387
|
+
# Response message for duplicating chart in a dashboard.
|
|
388
|
+
# @!attribute [rw] native_dashboard
|
|
389
|
+
# @return [::Google::Cloud::Chronicle::V1::NativeDashboard]
|
|
390
|
+
# Dashboard with chart added in definition.
|
|
391
|
+
# @!attribute [rw] dashboard_chart
|
|
392
|
+
# @return [::Google::Cloud::Chronicle::V1::DashboardChart]
|
|
393
|
+
# Duplicated chart resource.
|
|
394
|
+
class DuplicateChartResponse
|
|
395
|
+
include ::Google::Protobuf::MessageExts
|
|
396
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
397
|
+
end
|
|
398
|
+
|
|
399
|
+
# User Data for Native Dashboard
|
|
400
|
+
# @!attribute [rw] last_viewed_time
|
|
401
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
402
|
+
# time when this dashboard is last viewed
|
|
403
|
+
# @!attribute [rw] is_pinned
|
|
404
|
+
# @return [::Boolean]
|
|
405
|
+
# is dashboard pinned by user
|
|
406
|
+
class DashboardUserData
|
|
407
|
+
include ::Google::Protobuf::MessageExts
|
|
408
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
409
|
+
end
|
|
410
|
+
|
|
411
|
+
# Definition of the dashboard including filters, layout, charts'
|
|
412
|
+
# configurations.
|
|
413
|
+
# @!attribute [rw] filters
|
|
414
|
+
# @return [::Array<::Google::Cloud::Chronicle::V1::DashboardFilter>]
|
|
415
|
+
# Filters for the dashboard.
|
|
416
|
+
# @!attribute [rw] fingerprint
|
|
417
|
+
# @return [::String]
|
|
418
|
+
# Fingerprint of the dashboard definition.
|
|
419
|
+
# @!attribute [rw] charts
|
|
420
|
+
# @return [::Array<::Google::Cloud::Chronicle::V1::DashboardDefinition::ChartConfig>]
|
|
421
|
+
# Charts in the dashboard.
|
|
422
|
+
class DashboardDefinition
|
|
423
|
+
include ::Google::Protobuf::MessageExts
|
|
424
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
425
|
+
|
|
426
|
+
# Configuration of the chart including chart reference, layout and filters.
|
|
427
|
+
# @!attribute [r] dashboard_chart
|
|
428
|
+
# @return [::String]
|
|
429
|
+
# @!attribute [rw] chart_layout
|
|
430
|
+
# @return [::Google::Cloud::Chronicle::V1::DashboardDefinition::ChartConfig::ChartLayout]
|
|
431
|
+
# @!attribute [rw] filters_ids
|
|
432
|
+
# @return [::Array<::String>]
|
|
433
|
+
# Dashboard filters applied to the chart.
|
|
434
|
+
class ChartConfig
|
|
435
|
+
include ::Google::Protobuf::MessageExts
|
|
436
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
437
|
+
|
|
438
|
+
# Layout of the chart.
|
|
439
|
+
# @!attribute [rw] start_x
|
|
440
|
+
# @return [::Integer]
|
|
441
|
+
# @!attribute [rw] span_x
|
|
442
|
+
# @return [::Integer]
|
|
443
|
+
# @!attribute [rw] start_y
|
|
444
|
+
# @return [::Integer]
|
|
445
|
+
# @!attribute [rw] span_y
|
|
446
|
+
# @return [::Integer]
|
|
447
|
+
class ChartLayout
|
|
448
|
+
include ::Google::Protobuf::MessageExts
|
|
449
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
450
|
+
end
|
|
451
|
+
end
|
|
452
|
+
end
|
|
453
|
+
|
|
454
|
+
# Type of the dashboard.
|
|
455
|
+
module DashboardType
|
|
456
|
+
# Default unspecified.
|
|
457
|
+
DASHBOARD_TYPE_UNSPECIFIED = 0
|
|
458
|
+
|
|
459
|
+
# Out of the box curated dashboards provided by Chronicle.
|
|
460
|
+
CURATED = 1
|
|
461
|
+
|
|
462
|
+
# Private dashboards created by users/customers.
|
|
463
|
+
PRIVATE = 2
|
|
464
|
+
|
|
465
|
+
# Public dashboards created by users/customers.
|
|
466
|
+
PUBLIC = 3
|
|
467
|
+
|
|
468
|
+
# Custom dashboards
|
|
469
|
+
CUSTOM = 4
|
|
470
|
+
|
|
471
|
+
# Marketplace dashboards
|
|
472
|
+
MARKETPLACE = 5
|
|
473
|
+
end
|
|
474
|
+
|
|
475
|
+
# AccessType of the dashboard.
|
|
476
|
+
module DashboardAccess
|
|
477
|
+
# Default unspecified.
|
|
478
|
+
DASHBOARD_ACCESS_UNSPECIFIED = 0
|
|
479
|
+
|
|
480
|
+
# Private dashboards created by users/customers.
|
|
481
|
+
DASHBOARD_PRIVATE = 1
|
|
482
|
+
|
|
483
|
+
# Public dashboards created by users/customers.
|
|
484
|
+
DASHBOARD_PUBLIC = 2
|
|
485
|
+
end
|
|
486
|
+
|
|
487
|
+
# NativeDashboardView indicates the scope of fields to populate when returning
|
|
488
|
+
# the dashboard resource.
|
|
489
|
+
module NativeDashboardView
|
|
490
|
+
# Defaults to basic.
|
|
491
|
+
NATIVE_DASHBOARD_VIEW_UNSPECIFIED = 0
|
|
492
|
+
|
|
493
|
+
# Include basic metadata about the dashboard without full definition.
|
|
494
|
+
NATIVE_DASHBOARD_VIEW_BASIC = 1
|
|
495
|
+
|
|
496
|
+
# Include everything.
|
|
497
|
+
NATIVE_DASHBOARD_VIEW_FULL = 2
|
|
498
|
+
end
|
|
499
|
+
end
|
|
500
|
+
end
|
|
501
|
+
end
|
|
502
|
+
end
|