google-cloud-dataplex-v1 0.1.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 (40) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +149 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +139 -0
  6. data/lib/google/cloud/dataplex/v1/dataplex_service/client.rb +3133 -0
  7. data/lib/google/cloud/dataplex/v1/dataplex_service/credentials.rb +47 -0
  8. data/lib/google/cloud/dataplex/v1/dataplex_service/operations.rb +767 -0
  9. data/lib/google/cloud/dataplex/v1/dataplex_service/paths.rb +157 -0
  10. data/lib/google/cloud/dataplex/v1/dataplex_service.rb +54 -0
  11. data/lib/google/cloud/dataplex/v1/logs_pb.rb +135 -0
  12. data/lib/google/cloud/dataplex/v1/metadata_pb.rb +214 -0
  13. data/lib/google/cloud/dataplex/v1/metadata_service/client.rb +729 -0
  14. data/lib/google/cloud/dataplex/v1/metadata_service/credentials.rb +47 -0
  15. data/lib/google/cloud/dataplex/v1/metadata_service/paths.rb +102 -0
  16. data/lib/google/cloud/dataplex/v1/metadata_service.rb +50 -0
  17. data/lib/google/cloud/dataplex/v1/metadata_services_pb.rb +52 -0
  18. data/lib/google/cloud/dataplex/v1/resources_pb.rb +298 -0
  19. data/lib/google/cloud/dataplex/v1/service_pb.rb +218 -0
  20. data/lib/google/cloud/dataplex/v1/service_services_pb.rb +102 -0
  21. data/lib/google/cloud/dataplex/v1/tasks_pb.rb +133 -0
  22. data/lib/google/cloud/dataplex/v1/version.rb +28 -0
  23. data/lib/google/cloud/dataplex/v1.rb +39 -0
  24. data/lib/google-cloud-dataplex-v1.rb +21 -0
  25. data/proto_docs/README.md +4 -0
  26. data/proto_docs/google/api/field_behavior.rb +71 -0
  27. data/proto_docs/google/api/resource.rb +222 -0
  28. data/proto_docs/google/cloud/dataplex/v1/logs.rb +308 -0
  29. data/proto_docs/google/cloud/dataplex/v1/metadata.rb +533 -0
  30. data/proto_docs/google/cloud/dataplex/v1/resources.rb +821 -0
  31. data/proto_docs/google/cloud/dataplex/v1/service.rb +601 -0
  32. data/proto_docs/google/cloud/dataplex/v1/tasks.rb +349 -0
  33. data/proto_docs/google/longrunning/operations.rb +164 -0
  34. data/proto_docs/google/protobuf/any.rb +141 -0
  35. data/proto_docs/google/protobuf/duration.rb +98 -0
  36. data/proto_docs/google/protobuf/empty.rb +36 -0
  37. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  38. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  39. data/proto_docs/google/rpc/status.rb +46 -0
  40. metadata +231 -0
@@ -0,0 +1,222 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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 Api
22
+ # A simple descriptor of a resource type.
23
+ #
24
+ # ResourceDescriptor annotates a resource message (either by means of a
25
+ # protobuf annotation or use in the service config), and associates the
26
+ # resource's schema, the resource type, and the pattern of the resource name.
27
+ #
28
+ # Example:
29
+ #
30
+ # message Topic {
31
+ # // Indicates this message defines a resource schema.
32
+ # // Declares the resource type in the format of {service}/{kind}.
33
+ # // For Kubernetes resources, the format is {api group}/{kind}.
34
+ # option (google.api.resource) = {
35
+ # type: "pubsub.googleapis.com/Topic"
36
+ # pattern: "projects/{project}/topics/{topic}"
37
+ # };
38
+ # }
39
+ #
40
+ # The ResourceDescriptor Yaml config will look like:
41
+ #
42
+ # resources:
43
+ # - type: "pubsub.googleapis.com/Topic"
44
+ # pattern: "projects/{project}/topics/{topic}"
45
+ #
46
+ # Sometimes, resources have multiple patterns, typically because they can
47
+ # live under multiple parents.
48
+ #
49
+ # Example:
50
+ #
51
+ # message LogEntry {
52
+ # option (google.api.resource) = {
53
+ # type: "logging.googleapis.com/LogEntry"
54
+ # pattern: "projects/{project}/logs/{log}"
55
+ # pattern: "folders/{folder}/logs/{log}"
56
+ # pattern: "organizations/{organization}/logs/{log}"
57
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
58
+ # };
59
+ # }
60
+ #
61
+ # The ResourceDescriptor Yaml config will look like:
62
+ #
63
+ # resources:
64
+ # - type: 'logging.googleapis.com/LogEntry'
65
+ # pattern: "projects/{project}/logs/{log}"
66
+ # pattern: "folders/{folder}/logs/{log}"
67
+ # pattern: "organizations/{organization}/logs/{log}"
68
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
69
+ # @!attribute [rw] type
70
+ # @return [::String]
71
+ # The resource type. It must be in the format of
72
+ # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
73
+ # singular and must not include version numbers.
74
+ #
75
+ # Example: `storage.googleapis.com/Bucket`
76
+ #
77
+ # The value of the resource_type_kind must follow the regular expression
78
+ # /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
79
+ # should use PascalCase (UpperCamelCase). The maximum number of
80
+ # characters allowed for the `resource_type_kind` is 100.
81
+ # @!attribute [rw] pattern
82
+ # @return [::Array<::String>]
83
+ # Optional. The relative resource name pattern associated with this resource
84
+ # type. The DNS prefix of the full resource name shouldn't be specified here.
85
+ #
86
+ # The path pattern must follow the syntax, which aligns with HTTP binding
87
+ # syntax:
88
+ #
89
+ # Template = Segment { "/" Segment } ;
90
+ # Segment = LITERAL | Variable ;
91
+ # Variable = "{" LITERAL "}" ;
92
+ #
93
+ # Examples:
94
+ #
95
+ # - "projects/\\{project}/topics/\\{topic}"
96
+ # - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
97
+ #
98
+ # The components in braces correspond to the IDs for each resource in the
99
+ # hierarchy. It is expected that, if multiple patterns are provided,
100
+ # the same component name (e.g. "project") refers to IDs of the same
101
+ # type of resource.
102
+ # @!attribute [rw] name_field
103
+ # @return [::String]
104
+ # Optional. The field on the resource that designates the resource name
105
+ # field. If omitted, this is assumed to be "name".
106
+ # @!attribute [rw] history
107
+ # @return [::Google::Api::ResourceDescriptor::History]
108
+ # Optional. The historical or future-looking state of the resource pattern.
109
+ #
110
+ # Example:
111
+ #
112
+ # // The InspectTemplate message originally only supported resource
113
+ # // names with organization, and project was added later.
114
+ # message InspectTemplate {
115
+ # option (google.api.resource) = {
116
+ # type: "dlp.googleapis.com/InspectTemplate"
117
+ # pattern:
118
+ # "organizations/{organization}/inspectTemplates/{inspect_template}"
119
+ # pattern: "projects/{project}/inspectTemplates/{inspect_template}"
120
+ # history: ORIGINALLY_SINGLE_PATTERN
121
+ # };
122
+ # }
123
+ # @!attribute [rw] plural
124
+ # @return [::String]
125
+ # The plural name used in the resource name and permission names, such as
126
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
127
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
128
+ # concept of the `plural` field in k8s CRD spec
129
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
130
+ #
131
+ # Note: The plural form is required even for singleton resources. See
132
+ # https://aip.dev/156
133
+ # @!attribute [rw] singular
134
+ # @return [::String]
135
+ # The same concept of the `singular` field in k8s CRD spec
136
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
137
+ # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
138
+ # @!attribute [rw] style
139
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
140
+ # Style flag(s) for this resource.
141
+ # These indicate that a resource is expected to conform to a given
142
+ # style. See the specific style flags for additional information.
143
+ class ResourceDescriptor
144
+ include ::Google::Protobuf::MessageExts
145
+ extend ::Google::Protobuf::MessageExts::ClassMethods
146
+
147
+ # A description of the historical or future-looking state of the
148
+ # resource pattern.
149
+ module History
150
+ # The "unset" value.
151
+ HISTORY_UNSPECIFIED = 0
152
+
153
+ # The resource originally had one pattern and launched as such, and
154
+ # additional patterns were added later.
155
+ ORIGINALLY_SINGLE_PATTERN = 1
156
+
157
+ # The resource has one pattern, but the API owner expects to add more
158
+ # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
159
+ # that from being necessary once there are multiple patterns.)
160
+ FUTURE_MULTI_PATTERN = 2
161
+ end
162
+
163
+ # A flag representing a specific style that a resource claims to conform to.
164
+ module Style
165
+ # The unspecified value. Do not use.
166
+ STYLE_UNSPECIFIED = 0
167
+
168
+ # This resource is intended to be "declarative-friendly".
169
+ #
170
+ # Declarative-friendly resources must be more strictly consistent, and
171
+ # setting this to true communicates to tools that this resource should
172
+ # adhere to declarative-friendly expectations.
173
+ #
174
+ # Note: This is used by the API linter (linter.aip.dev) to enable
175
+ # additional checks.
176
+ DECLARATIVE_FRIENDLY = 1
177
+ end
178
+ end
179
+
180
+ # Defines a proto annotation that describes a string field that refers to
181
+ # an API resource.
182
+ # @!attribute [rw] type
183
+ # @return [::String]
184
+ # The resource type that the annotated field references.
185
+ #
186
+ # Example:
187
+ #
188
+ # message Subscription {
189
+ # string topic = 2 [(google.api.resource_reference) = {
190
+ # type: "pubsub.googleapis.com/Topic"
191
+ # }];
192
+ # }
193
+ #
194
+ # Occasionally, a field may reference an arbitrary resource. In this case,
195
+ # APIs use the special value * in their resource reference.
196
+ #
197
+ # Example:
198
+ #
199
+ # message GetIamPolicyRequest {
200
+ # string resource = 2 [(google.api.resource_reference) = {
201
+ # type: "*"
202
+ # }];
203
+ # }
204
+ # @!attribute [rw] child_type
205
+ # @return [::String]
206
+ # The resource type of a child collection that the annotated field
207
+ # references. This is useful for annotating the `parent` field that
208
+ # doesn't have a fixed resource type.
209
+ #
210
+ # Example:
211
+ #
212
+ # message ListLogEntriesRequest {
213
+ # string parent = 1 [(google.api.resource_reference) = {
214
+ # child_type: "logging.googleapis.com/LogEntry"
215
+ # };
216
+ # }
217
+ class ResourceReference
218
+ include ::Google::Protobuf::MessageExts
219
+ extend ::Google::Protobuf::MessageExts::ClassMethods
220
+ end
221
+ end
222
+ end
@@ -0,0 +1,308 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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 Dataplex
23
+ module V1
24
+ # The payload associated with Discovery data processing.
25
+ # @!attribute [rw] message
26
+ # @return [::String]
27
+ # The log message.
28
+ # @!attribute [rw] lake_id
29
+ # @return [::String]
30
+ # The id of the associated lake.
31
+ # @!attribute [rw] zone_id
32
+ # @return [::String]
33
+ # The id of the associated zone.
34
+ # @!attribute [rw] asset_id
35
+ # @return [::String]
36
+ # The id of the associated asset.
37
+ # @!attribute [rw] data_location
38
+ # @return [::String]
39
+ # The data location associated with the event.
40
+ # @!attribute [rw] type
41
+ # @return [::Google::Cloud::Dataplex::V1::DiscoveryEvent::EventType]
42
+ # The type of the event being logged.
43
+ # @!attribute [rw] config
44
+ # @return [::Google::Cloud::Dataplex::V1::DiscoveryEvent::ConfigDetails]
45
+ # Details about discovery configuration in effect.
46
+ # @!attribute [rw] entity
47
+ # @return [::Google::Cloud::Dataplex::V1::DiscoveryEvent::EntityDetails]
48
+ # Details about the entity associated with the event.
49
+ # @!attribute [rw] partition
50
+ # @return [::Google::Cloud::Dataplex::V1::DiscoveryEvent::PartitionDetails]
51
+ # Details about the partition associated with the event.
52
+ # @!attribute [rw] action
53
+ # @return [::Google::Cloud::Dataplex::V1::DiscoveryEvent::ActionDetails]
54
+ # Details about the action associated with the event.
55
+ class DiscoveryEvent
56
+ include ::Google::Protobuf::MessageExts
57
+ extend ::Google::Protobuf::MessageExts::ClassMethods
58
+
59
+ # Details about configuration events.
60
+ # @!attribute [rw] parameters
61
+ # @return [::Google::Protobuf::Map{::String => ::String}]
62
+ # A list of discovery configuration parameters in effect.
63
+ # The keys are the field paths within DiscoverySpec.
64
+ # Eg. includePatterns, excludePatterns, csvOptions.disableTypeInference,
65
+ # etc.
66
+ class ConfigDetails
67
+ include ::Google::Protobuf::MessageExts
68
+ extend ::Google::Protobuf::MessageExts::ClassMethods
69
+
70
+ # @!attribute [rw] key
71
+ # @return [::String]
72
+ # @!attribute [rw] value
73
+ # @return [::String]
74
+ class ParametersEntry
75
+ include ::Google::Protobuf::MessageExts
76
+ extend ::Google::Protobuf::MessageExts::ClassMethods
77
+ end
78
+ end
79
+
80
+ # Details about the entity.
81
+ # @!attribute [rw] entity
82
+ # @return [::String]
83
+ # The name of the entity resource.
84
+ # The name is the fully-qualified resource name.
85
+ # @!attribute [rw] type
86
+ # @return [::Google::Cloud::Dataplex::V1::DiscoveryEvent::EntityType]
87
+ # The type of the entity resource.
88
+ class EntityDetails
89
+ include ::Google::Protobuf::MessageExts
90
+ extend ::Google::Protobuf::MessageExts::ClassMethods
91
+ end
92
+
93
+ # Details about the partition.
94
+ # @!attribute [rw] partition
95
+ # @return [::String]
96
+ # The name to the partition resource.
97
+ # The name is the fully-qualified resource name.
98
+ # @!attribute [rw] entity
99
+ # @return [::String]
100
+ # The name to the containing entity resource.
101
+ # The name is the fully-qualified resource name.
102
+ # @!attribute [rw] type
103
+ # @return [::Google::Cloud::Dataplex::V1::DiscoveryEvent::EntityType]
104
+ # The type of the containing entity resource.
105
+ class PartitionDetails
106
+ include ::Google::Protobuf::MessageExts
107
+ extend ::Google::Protobuf::MessageExts::ClassMethods
108
+ end
109
+
110
+ # Details about the action.
111
+ # @!attribute [rw] type
112
+ # @return [::String]
113
+ # The type of action.
114
+ # Eg. IncompatibleDataSchema, InvalidDataFormat
115
+ class ActionDetails
116
+ include ::Google::Protobuf::MessageExts
117
+ extend ::Google::Protobuf::MessageExts::ClassMethods
118
+ end
119
+
120
+ # The type of the event.
121
+ module EventType
122
+ # An unspecified event type.
123
+ EVENT_TYPE_UNSPECIFIED = 0
124
+
125
+ # An event representing discovery configuration in effect.
126
+ CONFIG = 1
127
+
128
+ # An event representing a metadata entity being created.
129
+ ENTITY_CREATED = 2
130
+
131
+ # An event representing a metadata entity being updated.
132
+ ENTITY_UPDATED = 3
133
+
134
+ # An event representing a metadata entity being deleted.
135
+ ENTITY_DELETED = 4
136
+
137
+ # An event representing a partition being created.
138
+ PARTITION_CREATED = 5
139
+
140
+ # An event representing a partition being updated.
141
+ PARTITION_UPDATED = 6
142
+
143
+ # An event representing a partition being deleted.
144
+ PARTITION_DELETED = 7
145
+ end
146
+
147
+ # The type of the entity.
148
+ module EntityType
149
+ # An unspecified event type.
150
+ ENTITY_TYPE_UNSPECIFIED = 0
151
+
152
+ # Entities representing structured data.
153
+ TABLE = 1
154
+
155
+ # Entities representing unstructured data.
156
+ FILESET = 2
157
+ end
158
+ end
159
+
160
+ # The payload associated with Job logs that contains events describing jobs
161
+ # that have run within a Lake.
162
+ # @!attribute [rw] message
163
+ # @return [::String]
164
+ # The log message.
165
+ # @!attribute [rw] job_id
166
+ # @return [::String]
167
+ # The unique id identifying the job.
168
+ # @!attribute [rw] start_time
169
+ # @return [::Google::Protobuf::Timestamp]
170
+ # The time when the job started running.
171
+ # @!attribute [rw] end_time
172
+ # @return [::Google::Protobuf::Timestamp]
173
+ # The time when the job ended running.
174
+ # @!attribute [rw] state
175
+ # @return [::Google::Cloud::Dataplex::V1::JobEvent::State]
176
+ # The job state on completion.
177
+ # @!attribute [rw] retries
178
+ # @return [::Integer]
179
+ # The number of retries.
180
+ # @!attribute [rw] type
181
+ # @return [::Google::Cloud::Dataplex::V1::JobEvent::Type]
182
+ # The type of the job.
183
+ # @!attribute [rw] service
184
+ # @return [::Google::Cloud::Dataplex::V1::JobEvent::Service]
185
+ # The service used to execute the job.
186
+ # @!attribute [rw] service_job
187
+ # @return [::String]
188
+ # The reference to the job within the service.
189
+ class JobEvent
190
+ include ::Google::Protobuf::MessageExts
191
+ extend ::Google::Protobuf::MessageExts::ClassMethods
192
+
193
+ # The type of the job.
194
+ module Type
195
+ # Unspecified job type.
196
+ TYPE_UNSPECIFIED = 0
197
+
198
+ # Spark jobs.
199
+ SPARK = 1
200
+
201
+ # Notebook jobs.
202
+ NOTEBOOK = 2
203
+ end
204
+
205
+ # The completion status of the job.
206
+ module State
207
+ # Unspecified job state.
208
+ STATE_UNSPECIFIED = 0
209
+
210
+ # Job successfully completed.
211
+ SUCCEEDED = 1
212
+
213
+ # Job was unsuccessful.
214
+ FAILED = 2
215
+
216
+ # Job was cancelled by the user.
217
+ CANCELLED = 3
218
+
219
+ # Job was cancelled or aborted via the service executing the job.
220
+ ABORTED = 4
221
+ end
222
+
223
+ # The service used to execute the job.
224
+ module Service
225
+ # Unspecified service.
226
+ SERVICE_UNSPECIFIED = 0
227
+
228
+ # Cloud Dataproc.
229
+ DATAPROC = 1
230
+ end
231
+ end
232
+
233
+ # These messages contain information about sessions within an environment.
234
+ # The monitored resource is 'Environment'.
235
+ # @!attribute [rw] message
236
+ # @return [::String]
237
+ # The log message.
238
+ # @!attribute [rw] user_id
239
+ # @return [::String]
240
+ # The information about the user that created the session.
241
+ # @!attribute [rw] session_id
242
+ # @return [::String]
243
+ # Unique identifier for the session.
244
+ # @!attribute [rw] type
245
+ # @return [::Google::Cloud::Dataplex::V1::SessionEvent::EventType]
246
+ # The type of the event.
247
+ # @!attribute [rw] query
248
+ # @return [::Google::Cloud::Dataplex::V1::SessionEvent::QueryDetail]
249
+ # The execution details of the query.
250
+ class SessionEvent
251
+ include ::Google::Protobuf::MessageExts
252
+ extend ::Google::Protobuf::MessageExts::ClassMethods
253
+
254
+ # Execution details of the query.
255
+ # @!attribute [rw] query_id
256
+ # @return [::String]
257
+ # The unique Query id identifying the query.
258
+ # @!attribute [rw] query_text
259
+ # @return [::String]
260
+ # The query text executed.
261
+ # @!attribute [rw] engine
262
+ # @return [::Google::Cloud::Dataplex::V1::SessionEvent::QueryDetail::Engine]
263
+ # Query Execution engine.
264
+ # @!attribute [rw] duration
265
+ # @return [::Google::Protobuf::Duration]
266
+ # Time taken for execution of the query.
267
+ # @!attribute [rw] result_size_bytes
268
+ # @return [::Integer]
269
+ # The size of results the query produced.
270
+ # @!attribute [rw] data_processed_bytes
271
+ # @return [::Integer]
272
+ # The data processed by the query.
273
+ class QueryDetail
274
+ include ::Google::Protobuf::MessageExts
275
+ extend ::Google::Protobuf::MessageExts::ClassMethods
276
+
277
+ # Query Execution engine.
278
+ module Engine
279
+ # An unspecified Engine type.
280
+ ENGINE_UNSPECIFIED = 0
281
+
282
+ # Spark-sql engine is specified in Query.
283
+ SPARK_SQL = 1
284
+
285
+ # BigQuery engine is specified in Query.
286
+ BIGQUERY = 2
287
+ end
288
+ end
289
+
290
+ # The type of the event.
291
+ module EventType
292
+ # An unspecified event type.
293
+ EVENT_TYPE_UNSPECIFIED = 0
294
+
295
+ # Event for start of a session.
296
+ START = 1
297
+
298
+ # Event for stop of a session.
299
+ STOP = 2
300
+
301
+ # Query events in the session.
302
+ QUERY = 3
303
+ end
304
+ end
305
+ end
306
+ end
307
+ end
308
+ end