google-cloud-data_catalog-v1beta1 0.a → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (65) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +149 -0
  4. data/README.md +144 -8
  5. data/lib/google/cloud/data_catalog/v1beta1/data_catalog/client.rb +3303 -0
  6. data/lib/google/cloud/data_catalog/v1beta1/data_catalog/credentials.rb +47 -0
  7. data/lib/google/cloud/data_catalog/v1beta1/data_catalog/paths.rb +176 -0
  8. data/lib/google/cloud/data_catalog/v1beta1/data_catalog/rest/client.rb +3093 -0
  9. data/lib/google/cloud/data_catalog/v1beta1/data_catalog/rest/service_stub.rb +1782 -0
  10. data/lib/google/cloud/data_catalog/v1beta1/data_catalog/rest.rb +53 -0
  11. data/lib/google/cloud/data_catalog/v1beta1/data_catalog.rb +56 -0
  12. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager/client.rb +1590 -0
  13. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager/credentials.rb +47 -0
  14. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager/paths.rb +90 -0
  15. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager/rest/client.rb +1470 -0
  16. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager/rest/service_stub.rb +846 -0
  17. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager/rest.rb +53 -0
  18. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager.rb +56 -0
  19. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/client.rb +522 -0
  20. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/credentials.rb +47 -0
  21. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/paths.rb +69 -0
  22. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/rest/client.rb +479 -0
  23. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/rest/service_stub.rb +167 -0
  24. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization/rest.rb +53 -0
  25. data/lib/google/cloud/data_catalog/v1beta1/policy_tag_manager_serialization.rb +56 -0
  26. data/lib/google/cloud/data_catalog/v1beta1/rest.rb +39 -0
  27. data/lib/google/cloud/data_catalog/v1beta1/version.rb +7 -2
  28. data/lib/google/cloud/data_catalog/v1beta1.rb +47 -0
  29. data/lib/google/cloud/datacatalog/v1beta1/common_pb.rb +43 -0
  30. data/lib/google/cloud/datacatalog/v1beta1/datacatalog_pb.rb +99 -0
  31. data/lib/google/cloud/datacatalog/v1beta1/datacatalog_services_pb.rb +229 -0
  32. data/lib/google/cloud/datacatalog/v1beta1/gcs_fileset_spec_pb.rb +47 -0
  33. data/lib/google/cloud/datacatalog/v1beta1/policytagmanager_pb.rb +70 -0
  34. data/lib/google/cloud/datacatalog/v1beta1/policytagmanager_services_pb.rb +73 -0
  35. data/lib/google/cloud/datacatalog/v1beta1/policytagmanagerserialization_pb.rb +55 -0
  36. data/lib/google/cloud/datacatalog/v1beta1/policytagmanagerserialization_services_pb.rb +55 -0
  37. data/lib/google/cloud/datacatalog/v1beta1/schema_pb.rb +45 -0
  38. data/lib/google/cloud/datacatalog/v1beta1/search_pb.rb +47 -0
  39. data/lib/google/cloud/datacatalog/v1beta1/table_spec_pb.rb +49 -0
  40. data/lib/google/cloud/datacatalog/v1beta1/tags_pb.rb +55 -0
  41. data/lib/google/cloud/datacatalog/v1beta1/timestamps_pb.rb +46 -0
  42. data/lib/google/cloud/datacatalog/v1beta1/usage_pb.rb +46 -0
  43. data/lib/google-cloud-data_catalog-v1beta1.rb +21 -0
  44. data/proto_docs/README.md +4 -0
  45. data/proto_docs/google/api/client.rb +381 -0
  46. data/proto_docs/google/api/field_behavior.rb +85 -0
  47. data/proto_docs/google/api/launch_stage.rb +71 -0
  48. data/proto_docs/google/api/resource.rb +222 -0
  49. data/proto_docs/google/cloud/datacatalog/v1beta1/common.rb +52 -0
  50. data/proto_docs/google/cloud/datacatalog/v1beta1/datacatalog.rb +830 -0
  51. data/proto_docs/google/cloud/datacatalog/v1beta1/gcs_fileset_spec.rb +81 -0
  52. data/proto_docs/google/cloud/datacatalog/v1beta1/policytagmanager.rb +300 -0
  53. data/proto_docs/google/cloud/datacatalog/v1beta1/policytagmanagerserialization.rb +131 -0
  54. data/proto_docs/google/cloud/datacatalog/v1beta1/schema.rb +61 -0
  55. data/proto_docs/google/cloud/datacatalog/v1beta1/search.rb +75 -0
  56. data/proto_docs/google/cloud/datacatalog/v1beta1/table_spec.rb +102 -0
  57. data/proto_docs/google/cloud/datacatalog/v1beta1/tags.rb +242 -0
  58. data/proto_docs/google/cloud/datacatalog/v1beta1/timestamps.rb +42 -0
  59. data/proto_docs/google/cloud/datacatalog/v1beta1/usage.rb +74 -0
  60. data/proto_docs/google/protobuf/duration.rb +98 -0
  61. data/proto_docs/google/protobuf/empty.rb +34 -0
  62. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  63. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  64. data/proto_docs/google/type/expr.rb +75 -0
  65. metadata +242 -13
@@ -0,0 +1,102 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 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 DataCatalog
23
+ module V1beta1
24
+ # Describes a BigQuery table.
25
+ # @!attribute [r] table_source_type
26
+ # @return [::Google::Cloud::DataCatalog::V1beta1::TableSourceType]
27
+ # Output only. The table source type.
28
+ # @!attribute [rw] view_spec
29
+ # @return [::Google::Cloud::DataCatalog::V1beta1::ViewSpec]
30
+ # Table view specification. This field should only be populated if
31
+ # `table_source_type` is `BIGQUERY_VIEW`.
32
+ # @!attribute [rw] table_spec
33
+ # @return [::Google::Cloud::DataCatalog::V1beta1::TableSpec]
34
+ # Spec of a BigQuery table. This field should only be populated if
35
+ # `table_source_type` is `BIGQUERY_TABLE`.
36
+ class BigQueryTableSpec
37
+ include ::Google::Protobuf::MessageExts
38
+ extend ::Google::Protobuf::MessageExts::ClassMethods
39
+ end
40
+
41
+ # Table view specification.
42
+ # @!attribute [r] view_query
43
+ # @return [::String]
44
+ # Output only. The query that defines the table view.
45
+ class ViewSpec
46
+ include ::Google::Protobuf::MessageExts
47
+ extend ::Google::Protobuf::MessageExts::ClassMethods
48
+ end
49
+
50
+ # Normal BigQuery table spec.
51
+ # @!attribute [r] grouped_entry
52
+ # @return [::String]
53
+ # Output only. If the table is a dated shard, i.e., with name pattern
54
+ # `[prefix]YYYYMMDD`, `grouped_entry` is the Data Catalog resource name of
55
+ # the date sharded grouped entry, for example,
56
+ # `projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}`.
57
+ # Otherwise, `grouped_entry` is empty.
58
+ class TableSpec
59
+ include ::Google::Protobuf::MessageExts
60
+ extend ::Google::Protobuf::MessageExts::ClassMethods
61
+ end
62
+
63
+ # Spec for a group of BigQuery tables with name pattern `[prefix]YYYYMMDD`.
64
+ # Context:
65
+ # https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding
66
+ # @!attribute [r] dataset
67
+ # @return [::String]
68
+ # Output only. The Data Catalog resource name of the dataset entry the
69
+ # current table belongs to, for example,
70
+ # `projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}`.
71
+ # @!attribute [r] table_prefix
72
+ # @return [::String]
73
+ # Output only. The table name prefix of the shards. The name of any given
74
+ # shard is
75
+ # `[table_prefix]YYYYMMDD`, for example, for shard `MyTable20180101`, the
76
+ # `table_prefix` is `MyTable`.
77
+ # @!attribute [r] shard_count
78
+ # @return [::Integer]
79
+ # Output only. Total number of shards.
80
+ class BigQueryDateShardedSpec
81
+ include ::Google::Protobuf::MessageExts
82
+ extend ::Google::Protobuf::MessageExts::ClassMethods
83
+ end
84
+
85
+ # Table source type.
86
+ module TableSourceType
87
+ # Default unknown type.
88
+ TABLE_SOURCE_TYPE_UNSPECIFIED = 0
89
+
90
+ # Table view.
91
+ BIGQUERY_VIEW = 2
92
+
93
+ # BigQuery native table.
94
+ BIGQUERY_TABLE = 5
95
+
96
+ # BigQuery materialized view.
97
+ BIGQUERY_MATERIALIZED_VIEW = 7
98
+ end
99
+ end
100
+ end
101
+ end
102
+ end
@@ -0,0 +1,242 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 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 DataCatalog
23
+ module V1beta1
24
+ # Tags are used to attach custom metadata to Data Catalog resources. Tags
25
+ # conform to the specifications within their tag template.
26
+ #
27
+ # See [Data Catalog
28
+ # IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information
29
+ # on the permissions needed to create or view tags.
30
+ # @!attribute [rw] name
31
+ # @return [::String]
32
+ # The resource name of the tag in URL format. Example:
33
+ #
34
+ # * projects/\\{project_id}/locations/\\{location}/entrygroups/\\{entry_group_id}/entries/\\{entry_id}/tags/\\{tag_id}
35
+ #
36
+ # where `tag_id` is a system-generated identifier.
37
+ # Note that this Tag may not actually be stored in the location in this name.
38
+ # @!attribute [rw] template
39
+ # @return [::String]
40
+ # Required. The resource name of the tag template that this tag uses.
41
+ # Example:
42
+ #
43
+ # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
44
+ #
45
+ # This field cannot be modified after creation.
46
+ # @!attribute [r] template_display_name
47
+ # @return [::String]
48
+ # Output only. The display name of the tag template.
49
+ # @!attribute [rw] column
50
+ # @return [::String]
51
+ # Resources like Entry can have schemas associated with them. This scope
52
+ # allows users to attach tags to an individual column based on that schema.
53
+ #
54
+ # For attaching a tag to a nested column, use `.` to separate the column
55
+ # names. Example:
56
+ #
57
+ # * `outer_column.inner_column`
58
+ # @!attribute [rw] fields
59
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1beta1::TagField}]
60
+ # Required. This maps the ID of a tag field to the value of and additional
61
+ # information about that field. Valid field IDs are defined by the tag's
62
+ # template. A tag must have at least 1 field and at most 500 fields.
63
+ class Tag
64
+ include ::Google::Protobuf::MessageExts
65
+ extend ::Google::Protobuf::MessageExts::ClassMethods
66
+
67
+ # @!attribute [rw] key
68
+ # @return [::String]
69
+ # @!attribute [rw] value
70
+ # @return [::Google::Cloud::DataCatalog::V1beta1::TagField]
71
+ class FieldsEntry
72
+ include ::Google::Protobuf::MessageExts
73
+ extend ::Google::Protobuf::MessageExts::ClassMethods
74
+ end
75
+ end
76
+
77
+ # Contains the value and supporting information for a field within
78
+ # a {::Google::Cloud::DataCatalog::V1beta1::Tag Tag}.
79
+ # @!attribute [r] display_name
80
+ # @return [::String]
81
+ # Output only. The display name of this field.
82
+ # @!attribute [rw] double_value
83
+ # @return [::Float]
84
+ # Holds the value for a tag field with double type.
85
+ # @!attribute [rw] string_value
86
+ # @return [::String]
87
+ # Holds the value for a tag field with string type.
88
+ # @!attribute [rw] bool_value
89
+ # @return [::Boolean]
90
+ # Holds the value for a tag field with boolean type.
91
+ # @!attribute [rw] timestamp_value
92
+ # @return [::Google::Protobuf::Timestamp]
93
+ # Holds the value for a tag field with timestamp type.
94
+ # @!attribute [rw] enum_value
95
+ # @return [::Google::Cloud::DataCatalog::V1beta1::TagField::EnumValue]
96
+ # Holds the value for a tag field with enum type. This value must be
97
+ # one of the allowed values in the definition of this enum.
98
+ # @!attribute [r] order
99
+ # @return [::Integer]
100
+ # Output only. The order of this field with respect to other fields in this
101
+ # tag. It can be set in
102
+ # {::Google::Cloud::DataCatalog::V1beta1::TagTemplateField#order Tag}. For
103
+ # example, a higher value can indicate a more important field. The value can
104
+ # be negative. Multiple fields can have the same order, and field orders
105
+ # within a tag do not have to be sequential.
106
+ class TagField
107
+ include ::Google::Protobuf::MessageExts
108
+ extend ::Google::Protobuf::MessageExts::ClassMethods
109
+
110
+ # Holds an enum value.
111
+ # @!attribute [rw] display_name
112
+ # @return [::String]
113
+ # The display name of the enum value.
114
+ class EnumValue
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+ end
119
+
120
+ # A tag template defines a tag, which can have one or more typed fields.
121
+ # The template is used to create and attach the tag to Google Cloud resources.
122
+ # [Tag template
123
+ # roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles)
124
+ # provide permissions to create, edit, and use the template. See, for example,
125
+ # the [TagTemplate
126
+ # User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role,
127
+ # which includes permission to use the tag template to tag resources.
128
+ # @!attribute [rw] name
129
+ # @return [::String]
130
+ # The resource name of the tag template in URL format. Example:
131
+ #
132
+ # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template_id}
133
+ #
134
+ # Note that this TagTemplate and its child resources may not actually be
135
+ # stored in the location in this name.
136
+ # @!attribute [rw] display_name
137
+ # @return [::String]
138
+ # The display name for this template. Defaults to an empty string.
139
+ # @!attribute [rw] fields
140
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1beta1::TagTemplateField}]
141
+ # Required. Map of tag template field IDs to the settings for the field.
142
+ # This map is an exhaustive list of the allowed fields. This map must contain
143
+ # at least one field and at most 500 fields.
144
+ #
145
+ # The keys to this map are tag template field IDs. Field IDs can contain
146
+ # letters (both uppercase and lowercase), numbers (0-9) and underscores (_).
147
+ # Field IDs must be at least 1 character long and at most
148
+ # 64 characters long. Field IDs must start with a letter or underscore.
149
+ class TagTemplate
150
+ include ::Google::Protobuf::MessageExts
151
+ extend ::Google::Protobuf::MessageExts::ClassMethods
152
+
153
+ # @!attribute [rw] key
154
+ # @return [::String]
155
+ # @!attribute [rw] value
156
+ # @return [::Google::Cloud::DataCatalog::V1beta1::TagTemplateField]
157
+ class FieldsEntry
158
+ include ::Google::Protobuf::MessageExts
159
+ extend ::Google::Protobuf::MessageExts::ClassMethods
160
+ end
161
+ end
162
+
163
+ # The template for an individual field within a tag template.
164
+ # @!attribute [r] name
165
+ # @return [::String]
166
+ # Output only. The resource name of the tag template field in URL format.
167
+ # Example:
168
+ #
169
+ # * projects/\\{project_id}/locations/\\{location}/tagTemplates/\\{tag_template}/fields/\\{field}
170
+ #
171
+ # Note that this TagTemplateField may not actually be stored in the location
172
+ # in this name.
173
+ # @!attribute [rw] display_name
174
+ # @return [::String]
175
+ # The display name for this field. Defaults to an empty string.
176
+ # @!attribute [rw] type
177
+ # @return [::Google::Cloud::DataCatalog::V1beta1::FieldType]
178
+ # Required. The type of value this tag field can contain.
179
+ # @!attribute [rw] is_required
180
+ # @return [::Boolean]
181
+ # Whether this is a required field. Defaults to false.
182
+ # @!attribute [rw] description
183
+ # @return [::String]
184
+ # The description for this field. Defaults to an empty string.
185
+ # @!attribute [rw] order
186
+ # @return [::Integer]
187
+ # The order of this field with respect to other fields in this tag
188
+ # template. A higher value indicates a more important field. The value can
189
+ # be negative. Multiple fields can have the same order, and field orders
190
+ # within a tag do not have to be sequential.
191
+ class TagTemplateField
192
+ include ::Google::Protobuf::MessageExts
193
+ extend ::Google::Protobuf::MessageExts::ClassMethods
194
+ end
195
+
196
+ # @!attribute [rw] primitive_type
197
+ # @return [::Google::Cloud::DataCatalog::V1beta1::FieldType::PrimitiveType]
198
+ # Represents primitive types - string, bool etc.
199
+ # @!attribute [rw] enum_type
200
+ # @return [::Google::Cloud::DataCatalog::V1beta1::FieldType::EnumType]
201
+ # Represents an enum type.
202
+ class FieldType
203
+ include ::Google::Protobuf::MessageExts
204
+ extend ::Google::Protobuf::MessageExts::ClassMethods
205
+
206
+ # @!attribute [rw] allowed_values
207
+ # @return [::Array<::Google::Cloud::DataCatalog::V1beta1::FieldType::EnumType::EnumValue>]
208
+ class EnumType
209
+ include ::Google::Protobuf::MessageExts
210
+ extend ::Google::Protobuf::MessageExts::ClassMethods
211
+
212
+ # @!attribute [rw] display_name
213
+ # @return [::String]
214
+ # Required. The display name of the enum value. Must not be an empty
215
+ # string.
216
+ class EnumValue
217
+ include ::Google::Protobuf::MessageExts
218
+ extend ::Google::Protobuf::MessageExts::ClassMethods
219
+ end
220
+ end
221
+
222
+ module PrimitiveType
223
+ # This is the default invalid value for a type.
224
+ PRIMITIVE_TYPE_UNSPECIFIED = 0
225
+
226
+ # A double precision number.
227
+ DOUBLE = 1
228
+
229
+ # An UTF-8 string.
230
+ STRING = 2
231
+
232
+ # A boolean value.
233
+ BOOL = 3
234
+
235
+ # A timestamp.
236
+ TIMESTAMP = 4
237
+ end
238
+ end
239
+ end
240
+ end
241
+ end
242
+ end
@@ -0,0 +1,42 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 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 DataCatalog
23
+ module V1beta1
24
+ # Timestamps about this resource according to a particular system.
25
+ # @!attribute [rw] create_time
26
+ # @return [::Google::Protobuf::Timestamp]
27
+ # The creation time of the resource within the given system.
28
+ # @!attribute [rw] update_time
29
+ # @return [::Google::Protobuf::Timestamp]
30
+ # The last-modified time of the resource within the given system.
31
+ # @!attribute [r] expire_time
32
+ # @return [::Google::Protobuf::Timestamp]
33
+ # Output only. The expiration time of the resource within the given system.
34
+ # Currently only apllicable to BigQuery resources.
35
+ class SystemTimestamps
36
+ include ::Google::Protobuf::MessageExts
37
+ extend ::Google::Protobuf::MessageExts::ClassMethods
38
+ end
39
+ end
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,74 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 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 DataCatalog
23
+ module V1beta1
24
+ # Detailed counts on the entry's usage.
25
+ # Caveats:
26
+ # - Only BigQuery tables have usage stats
27
+ # - The usage stats only include BigQuery query jobs
28
+ # - The usage stats might be underestimated, e.g. wildcard table references
29
+ # are not yet counted in usage computation
30
+ # https://cloud.google.com/bigquery/docs/querying-wildcard-tables
31
+ # @!attribute [rw] total_completions
32
+ # @return [::Float]
33
+ # The number of times that the underlying entry was successfully used.
34
+ # @!attribute [rw] total_failures
35
+ # @return [::Float]
36
+ # The number of times that the underlying entry was attempted to be used
37
+ # but failed.
38
+ # @!attribute [rw] total_cancellations
39
+ # @return [::Float]
40
+ # The number of times that the underlying entry was attempted to be used
41
+ # but was cancelled by the user.
42
+ # @!attribute [rw] total_execution_time_for_completions_millis
43
+ # @return [::Float]
44
+ # Total time spent (in milliseconds) during uses the resulted in completions.
45
+ class UsageStats
46
+ include ::Google::Protobuf::MessageExts
47
+ extend ::Google::Protobuf::MessageExts::ClassMethods
48
+ end
49
+
50
+ # The set of all usage signals that we store in Data Catalog.
51
+ # @!attribute [rw] update_time
52
+ # @return [::Google::Protobuf::Timestamp]
53
+ # The timestamp of the end of the usage statistics duration.
54
+ # @!attribute [rw] usage_within_time_range
55
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DataCatalog::V1beta1::UsageStats}]
56
+ # Usage statistics over each of the pre-defined time ranges, supported
57
+ # strings for time ranges are \\{"24H", "7D", "30D"}.
58
+ class UsageSignal
59
+ include ::Google::Protobuf::MessageExts
60
+ extend ::Google::Protobuf::MessageExts::ClassMethods
61
+
62
+ # @!attribute [rw] key
63
+ # @return [::String]
64
+ # @!attribute [rw] value
65
+ # @return [::Google::Cloud::DataCatalog::V1beta1::UsageStats]
66
+ class UsageWithinTimeRangeEntry
67
+ include ::Google::Protobuf::MessageExts
68
+ extend ::Google::Protobuf::MessageExts::ClassMethods
69
+ end
70
+ end
71
+ end
72
+ end
73
+ end
74
+ end
@@ -0,0 +1,98 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 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 Protobuf
22
+ # A Duration represents a signed, fixed-length span of time represented
23
+ # as a count of seconds and fractions of seconds at nanosecond
24
+ # resolution. It is independent of any calendar and concepts like "day"
25
+ # or "month". It is related to Timestamp in that the difference between
26
+ # two Timestamp values is a Duration and it can be added or subtracted
27
+ # from a Timestamp. Range is approximately +-10,000 years.
28
+ #
29
+ # # Examples
30
+ #
31
+ # Example 1: Compute Duration from two Timestamps in pseudo code.
32
+ #
33
+ # Timestamp start = ...;
34
+ # Timestamp end = ...;
35
+ # Duration duration = ...;
36
+ #
37
+ # duration.seconds = end.seconds - start.seconds;
38
+ # duration.nanos = end.nanos - start.nanos;
39
+ #
40
+ # if (duration.seconds < 0 && duration.nanos > 0) {
41
+ # duration.seconds += 1;
42
+ # duration.nanos -= 1000000000;
43
+ # } else if (duration.seconds > 0 && duration.nanos < 0) {
44
+ # duration.seconds -= 1;
45
+ # duration.nanos += 1000000000;
46
+ # }
47
+ #
48
+ # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
49
+ #
50
+ # Timestamp start = ...;
51
+ # Duration duration = ...;
52
+ # Timestamp end = ...;
53
+ #
54
+ # end.seconds = start.seconds + duration.seconds;
55
+ # end.nanos = start.nanos + duration.nanos;
56
+ #
57
+ # if (end.nanos < 0) {
58
+ # end.seconds -= 1;
59
+ # end.nanos += 1000000000;
60
+ # } else if (end.nanos >= 1000000000) {
61
+ # end.seconds += 1;
62
+ # end.nanos -= 1000000000;
63
+ # }
64
+ #
65
+ # Example 3: Compute Duration from datetime.timedelta in Python.
66
+ #
67
+ # td = datetime.timedelta(days=3, minutes=10)
68
+ # duration = Duration()
69
+ # duration.FromTimedelta(td)
70
+ #
71
+ # # JSON Mapping
72
+ #
73
+ # In JSON format, the Duration type is encoded as a string rather than an
74
+ # object, where the string ends in the suffix "s" (indicating seconds) and
75
+ # is preceded by the number of seconds, with nanoseconds expressed as
76
+ # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
77
+ # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
78
+ # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
79
+ # microsecond should be expressed in JSON format as "3.000001s".
80
+ # @!attribute [rw] seconds
81
+ # @return [::Integer]
82
+ # Signed seconds of the span of time. Must be from -315,576,000,000
83
+ # to +315,576,000,000 inclusive. Note: these bounds are computed from:
84
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
85
+ # @!attribute [rw] nanos
86
+ # @return [::Integer]
87
+ # Signed fractions of a second at nanosecond resolution of the span
88
+ # of time. Durations less than one second are represented with a 0
89
+ # `seconds` field and a positive or negative `nanos` field. For durations
90
+ # of one second or more, a non-zero value for the `nanos` field must be
91
+ # of the same sign as the `seconds` field. Must be from -999,999,999
92
+ # to +999,999,999 inclusive.
93
+ class Duration
94
+ include ::Google::Protobuf::MessageExts
95
+ extend ::Google::Protobuf::MessageExts::ClassMethods
96
+ end
97
+ end
98
+ end
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 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 Protobuf
22
+ # A generic empty message that you can re-use to avoid defining duplicated
23
+ # empty messages in your APIs. A typical example is to use it as the request
24
+ # or the response type of an API method. For instance:
25
+ #
26
+ # service Foo {
27
+ # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
28
+ # }
29
+ class Empty
30
+ include ::Google::Protobuf::MessageExts
31
+ extend ::Google::Protobuf::MessageExts::ClassMethods
32
+ end
33
+ end
34
+ end