google-apis-dataplex_v1 0.58.0 → 0.60.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.
@@ -51,6 +51,127 @@ module Google
51
51
  @batch_path = 'batch'
52
52
  end
53
53
 
54
+ # Gets the access control policy for a resource. Returns an empty policy if the
55
+ # resource exists and does not have a policy set.
56
+ # @param [String] resource
57
+ # REQUIRED: The resource for which the policy is being requested. See Resource
58
+ # names (https://cloud.google.com/apis/design/resource_names) for the
59
+ # appropriate value for this field.
60
+ # @param [Fixnum] options_requested_policy_version
61
+ # Optional. The maximum policy version that will be used to format the policy.
62
+ # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
63
+ # rejected.Requests for policies with any conditional role bindings must specify
64
+ # version 3. Policies with no conditional role bindings may specify any valid
65
+ # value or leave the field unset.The policy in the response might use the policy
66
+ # version that you specified, or it might use a lower policy version. For
67
+ # example, if you specify version 3, but the policy has no conditional role
68
+ # bindings, the response uses version 1.To learn which resources support
69
+ # conditions in their IAM policies, see the IAM documentation (https://cloud.
70
+ # google.com/iam/help/conditions/resource-policies).
71
+ # @param [String] fields
72
+ # Selector specifying which fields to include in a partial response.
73
+ # @param [String] quota_user
74
+ # Available to use for quota purposes for server-side applications. Can be any
75
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
76
+ # @param [Google::Apis::RequestOptions] options
77
+ # Request-specific options
78
+ #
79
+ # @yield [result, err] Result & error if block supplied
80
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
81
+ # @yieldparam err [StandardError] error object if request failed
82
+ #
83
+ # @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
84
+ #
85
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
86
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
87
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
88
+ def get_organization_location_encryption_config_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
89
+ command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
90
+ command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
91
+ command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
92
+ command.params['resource'] = resource unless resource.nil?
93
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
94
+ command.query['fields'] = fields unless fields.nil?
95
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
96
+ execute_or_queue_command(command, &block)
97
+ end
98
+
99
+ # Sets the access control policy on the specified resource. Replaces any
100
+ # existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
101
+ # errors.
102
+ # @param [String] resource
103
+ # REQUIRED: The resource for which the policy is being specified. See Resource
104
+ # names (https://cloud.google.com/apis/design/resource_names) for the
105
+ # appropriate value for this field.
106
+ # @param [Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object
107
+ # @param [String] fields
108
+ # Selector specifying which fields to include in a partial response.
109
+ # @param [String] quota_user
110
+ # Available to use for quota purposes for server-side applications. Can be any
111
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
112
+ # @param [Google::Apis::RequestOptions] options
113
+ # Request-specific options
114
+ #
115
+ # @yield [result, err] Result & error if block supplied
116
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
117
+ # @yieldparam err [StandardError] error object if request failed
118
+ #
119
+ # @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
120
+ #
121
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
122
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
123
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
124
+ def set_organization_location_encryption_config_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
125
+ command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
126
+ command.request_representation = Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest::Representation
127
+ command.request_object = google_iam_v1_set_iam_policy_request_object
128
+ command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
129
+ command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
130
+ command.params['resource'] = resource unless resource.nil?
131
+ command.query['fields'] = fields unless fields.nil?
132
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
133
+ execute_or_queue_command(command, &block)
134
+ end
135
+
136
+ # Returns permissions that a caller has on the specified resource. If the
137
+ # resource does not exist, this will return an empty set of permissions, not a
138
+ # NOT_FOUND error.Note: This operation is designed to be used for building
139
+ # permission-aware UIs and command-line tools, not for authorization checking.
140
+ # This operation may "fail open" without warning.
141
+ # @param [String] resource
142
+ # REQUIRED: The resource for which the policy detail is being requested. See
143
+ # Resource names (https://cloud.google.com/apis/design/resource_names) for the
144
+ # appropriate value for this field.
145
+ # @param [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsRequest] google_iam_v1_test_iam_permissions_request_object
146
+ # @param [String] fields
147
+ # Selector specifying which fields to include in a partial response.
148
+ # @param [String] quota_user
149
+ # Available to use for quota purposes for server-side applications. Can be any
150
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
151
+ # @param [Google::Apis::RequestOptions] options
152
+ # Request-specific options
153
+ #
154
+ # @yield [result, err] Result & error if block supplied
155
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse] parsed result object
156
+ # @yieldparam err [StandardError] error object if request failed
157
+ #
158
+ # @return [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse]
159
+ #
160
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
161
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
162
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
163
+ def test_organization_location_encryption_config_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
164
+ command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
165
+ command.request_representation = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsRequest::Representation
166
+ command.request_object = google_iam_v1_test_iam_permissions_request_object
167
+ command.response_representation = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse::Representation
168
+ command.response_class = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse
169
+ command.params['resource'] = resource unless resource.nil?
170
+ command.query['fields'] = fields unless fields.nil?
171
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
172
+ execute_or_queue_command(command, &block)
173
+ end
174
+
54
175
  # Gets information about a location.
55
176
  # @param [String] name
56
177
  # Resource name for the location.
@@ -124,21 +245,21 @@ module Google
124
245
  execute_or_queue_command(command, &block)
125
246
  end
126
247
 
127
- # Looks up a single entry.
248
+ # Looks up a single Entry by name using the permission on the source system.
128
249
  # @param [String] name
129
250
  # Required. The project to which the request should be attributed in the
130
251
  # following form: projects/`project`/locations/`location`.
131
252
  # @param [Array<String>, String] aspect_types
132
- # Optional. Limits the aspects returned to the provided aspect types. Only works
133
- # if the CUSTOM view is selected.
253
+ # Optional. Limits the aspects returned to the provided aspect types. It only
254
+ # works for CUSTOM view.
134
255
  # @param [String] entry
135
256
  # Required. The resource name of the Entry: projects/`project`/locations/`
136
257
  # location`/entryGroups/`entry_group`/entries/`entry`.
137
258
  # @param [Array<String>, String] paths
138
259
  # Optional. Limits the aspects returned to those associated with the provided
139
- # paths within the Entry. Only works if the CUSTOM view is selected.
260
+ # paths within the Entry. It only works for CUSTOM view.
140
261
  # @param [String] view
141
- # Optional. View for controlling which parts of an entry are to be returned.
262
+ # Optional. View to control which parts of an entry the service should return.
142
263
  # @param [String] fields
143
264
  # Selector specifying which fields to include in a partial response.
144
265
  # @param [String] quota_user
@@ -170,20 +291,24 @@ module Google
170
291
  execute_or_queue_command(command, &block)
171
292
  end
172
293
 
173
- # Searches for entries matching given query and scope.
294
+ # Searches for Entries matching the given query and scope.
174
295
  # @param [String] name
175
296
  # Required. The project to which the request should be attributed in the
176
297
  # following form: projects/`project`/locations/`location`.
177
298
  # @param [String] order_by
178
- # Optional. Ordering of the results. Supported options to be added later.
299
+ # Optional. Specifies the ordering of results.
179
300
  # @param [Fixnum] page_size
180
- # Optional. Pagination.
301
+ # Optional. Number of results in the search page. If <=0, then defaults to 10.
302
+ # Max limit for page_size is 1000. Throws an invalid argument for page_size >
303
+ # 1000.
181
304
  # @param [String] page_token
305
+ # Optional. Page token received from a previous SearchEntries call. Provide this
306
+ # to retrieve the subsequent page.
182
307
  # @param [String] query
183
308
  # Required. The query against which entries in scope should be matched.
184
309
  # @param [String] scope
185
- # Optional. The scope under which the search should be operating. Should either
186
- # be organizations/ or projects/. If left unspecified, it will default to the
310
+ # Optional. The scope under which the search should be operating. It must either
311
+ # be organizations/ or projects/. If it is unspecified, it defaults to the
187
312
  # organization where the project provided in name is located.
188
313
  # @param [String] fields
189
314
  # Selector specifying which fields to include in a partial response.
@@ -217,17 +342,17 @@ module Google
217
342
  execute_or_queue_command(command, &block)
218
343
  end
219
344
 
220
- # Creates an AspectType
345
+ # Creates an AspectType.
221
346
  # @param [String] parent
222
347
  # Required. The resource name of the AspectType, of the form: projects/`
223
- # project_number`/locations/`location_id` where location_id refers to a GCP
224
- # region.
348
+ # project_number`/locations/`location_id` where location_id refers to a Google
349
+ # Cloud region.
225
350
  # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1AspectType] google_cloud_dataplex_v1_aspect_type_object
226
351
  # @param [String] aspect_type_id
227
352
  # Required. AspectType identifier.
228
353
  # @param [Boolean] validate_only
229
- # Optional. Only validate the request, but do not perform mutations. The default
230
- # is false.
354
+ # Optional. The service validates the request without performing any mutations.
355
+ # The default is false.
231
356
  # @param [String] fields
232
357
  # Selector specifying which fields to include in a partial response.
233
358
  # @param [String] quota_user
@@ -259,13 +384,13 @@ module Google
259
384
  execute_or_queue_command(command, &block)
260
385
  end
261
386
 
262
- # Deletes a AspectType resource.
387
+ # Deletes an AspectType.
263
388
  # @param [String] name
264
389
  # Required. The resource name of the AspectType: projects/`project_number`/
265
390
  # locations/`location_id`/aspectTypes/`aspect_type_id`.
266
391
  # @param [String] etag
267
392
  # Optional. If the client provided etag value does not match the current etag
268
- # value, the DeleteAspectTypeRequest method returns an ABORTED error response
393
+ # value, the DeleteAspectTypeRequest method returns an ABORTED error response.
269
394
  # @param [String] fields
270
395
  # Selector specifying which fields to include in a partial response.
271
396
  # @param [String] quota_user
@@ -294,7 +419,7 @@ module Google
294
419
  execute_or_queue_command(command, &block)
295
420
  end
296
421
 
297
- # Retrieves a AspectType resource.
422
+ # Gets an AspectType.
298
423
  # @param [String] name
299
424
  # Required. The resource name of the AspectType: projects/`project_number`/
300
425
  # locations/`location_id`/aspectTypes/`aspect_type_id`.
@@ -373,23 +498,25 @@ module Google
373
498
  # Lists AspectType resources in a project and location.
374
499
  # @param [String] parent
375
500
  # Required. The resource name of the AspectType location, of the form: projects/`
376
- # project_number`/locations/`location_id` where location_id refers to a GCP
377
- # region.
501
+ # project_number`/locations/`location_id` where location_id refers to a Google
502
+ # Cloud region.
378
503
  # @param [String] filter
379
- # Optional. Filter request. Filters are case-sensitive. The following formats
380
- # are supported:labels.key1 = "value1" labels:key1 name = "value" These
381
- # restrictions can be coinjoined with AND, OR and NOT conjunctions.
504
+ # Optional. Filter request. Filters are case-sensitive. The service supports the
505
+ # following formats: labels.key1 = "value1" labels:key1 name = "value"These
506
+ # restrictions can be conjoined with AND, OR, and NOT conjunctions.
382
507
  # @param [String] order_by
383
- # Optional. Order by fields (name or create_time) for the result. If not
384
- # specified, the ordering is undefined.
508
+ # Optional. Orders the result by name or create_time fields. If not specified,
509
+ # the ordering is undefined.
385
510
  # @param [Fixnum] page_size
386
511
  # Optional. Maximum number of AspectTypes to return. The service may return
387
- # fewer than this value. If unspecified, at most 10 AspectTypes will be returned.
388
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
512
+ # fewer than this value. If unspecified, the service returns at most 10
513
+ # AspectTypes. The maximum value is 1000; values above 1000 will be coerced to
514
+ # 1000.
389
515
  # @param [String] page_token
390
516
  # Optional. Page token received from a previous ListAspectTypes call. Provide
391
517
  # this to retrieve the subsequent page. When paginating, all other parameters
392
- # provided to ListAspectTypes must match the call that provided the page token.
518
+ # you provide to ListAspectTypes must match the call that provided the page
519
+ # token.
393
520
  # @param [String] fields
394
521
  # Selector specifying which fields to include in a partial response.
395
522
  # @param [String] quota_user
@@ -421,7 +548,7 @@ module Google
421
548
  execute_or_queue_command(command, &block)
422
549
  end
423
550
 
424
- # Updates a AspectType resource.
551
+ # Updates an AspectType.
425
552
  # @param [String] name
426
553
  # Output only. The relative resource name of the AspectType, of the form:
427
554
  # projects/`project_number`/locations/`location_id`/aspectTypes/`aspect_type_id`.
@@ -2035,7 +2162,7 @@ module Google
2035
2162
  execute_or_queue_command(command, &block)
2036
2163
  end
2037
2164
 
2038
- # Creates an EntryGroup
2165
+ # Creates an EntryGroup.
2039
2166
  # @param [String] parent
2040
2167
  # Required. The resource name of the entryGroup, of the form: projects/`
2041
2168
  # project_number`/locations/`location_id` where location_id refers to a GCP
@@ -2044,8 +2171,8 @@ module Google
2044
2171
  # @param [String] entry_group_id
2045
2172
  # Required. EntryGroup identifier.
2046
2173
  # @param [Boolean] validate_only
2047
- # Optional. Only validate the request, but do not perform mutations. The default
2048
- # is false.
2174
+ # Optional. The service validates the request without performing any mutations.
2175
+ # The default is false.
2049
2176
  # @param [String] fields
2050
2177
  # Selector specifying which fields to include in a partial response.
2051
2178
  # @param [String] quota_user
@@ -2077,13 +2204,13 @@ module Google
2077
2204
  execute_or_queue_command(command, &block)
2078
2205
  end
2079
2206
 
2080
- # Deletes a EntryGroup resource.
2207
+ # Deletes an EntryGroup.
2081
2208
  # @param [String] name
2082
2209
  # Required. The resource name of the EntryGroup: projects/`project_number`/
2083
2210
  # locations/`location_id`/entryGroups/`entry_group_id`.
2084
2211
  # @param [String] etag
2085
2212
  # Optional. If the client provided etag value does not match the current etag
2086
- # value, the DeleteEntryGroupRequest method returns an ABORTED error response
2213
+ # value, the DeleteEntryGroupRequest method returns an ABORTED error response.
2087
2214
  # @param [String] fields
2088
2215
  # Selector specifying which fields to include in a partial response.
2089
2216
  # @param [String] quota_user
@@ -2112,7 +2239,7 @@ module Google
2112
2239
  execute_or_queue_command(command, &block)
2113
2240
  end
2114
2241
 
2115
- # Retrieves a EntryGroup resource.
2242
+ # Gets an EntryGroup.
2116
2243
  # @param [String] name
2117
2244
  # Required. The resource name of the EntryGroup: projects/`project_number`/
2118
2245
  # locations/`location_id`/entryGroups/`entry_group_id`.
@@ -2191,20 +2318,22 @@ module Google
2191
2318
  # Lists EntryGroup resources in a project and location.
2192
2319
  # @param [String] parent
2193
2320
  # Required. The resource name of the entryGroup location, of the form: projects/`
2194
- # project_number`/locations/`location_id` where location_id refers to a GCP
2195
- # region.
2321
+ # project_number`/locations/`location_id` where location_id refers to a Google
2322
+ # Cloud region.
2196
2323
  # @param [String] filter
2197
2324
  # Optional. Filter request.
2198
2325
  # @param [String] order_by
2199
2326
  # Optional. Order by fields for the result.
2200
2327
  # @param [Fixnum] page_size
2201
2328
  # Optional. Maximum number of EntryGroups to return. The service may return
2202
- # fewer than this value. If unspecified, at most 10 EntryGroups will be returned.
2203
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
2329
+ # fewer than this value. If unspecified, the service returns at most 10
2330
+ # EntryGroups. The maximum value is 1000; values above 1000 will be coerced to
2331
+ # 1000.
2204
2332
  # @param [String] page_token
2205
2333
  # Optional. Page token received from a previous ListEntryGroups call. Provide
2206
2334
  # this to retrieve the subsequent page. When paginating, all other parameters
2207
- # provided to ListEntryGroups must match the call that provided the page token.
2335
+ # you provide to ListEntryGroups must match the call that provided the page
2336
+ # token.
2208
2337
  # @param [String] fields
2209
2338
  # Selector specifying which fields to include in a partial response.
2210
2339
  # @param [String] quota_user
@@ -2236,16 +2365,17 @@ module Google
2236
2365
  execute_or_queue_command(command, &block)
2237
2366
  end
2238
2367
 
2239
- # Updates a EntryGroup resource.
2368
+ # Updates an EntryGroup.
2240
2369
  # @param [String] name
2241
- # Output only. The relative resource name of the EntryGroup, of the form:
2242
- # projects/`project_number`/locations/`location_id`/entryGroups/`entry_group_id`.
2370
+ # Output only. The relative resource name of the EntryGroup, in the format
2371
+ # projects/`project_id_or_number`/locations/`location_id`/entryGroups/`
2372
+ # entry_group_id`.
2243
2373
  # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryGroup] google_cloud_dataplex_v1_entry_group_object
2244
2374
  # @param [String] update_mask
2245
2375
  # Required. Mask of fields to update.
2246
2376
  # @param [Boolean] validate_only
2247
- # Optional. Only validate the request, but do not perform mutations. The default
2248
- # is false.
2377
+ # Optional. The service validates the request, without performing any mutations.
2378
+ # The default is false.
2249
2379
  # @param [String] fields
2250
2380
  # Selector specifying which fields to include in a partial response.
2251
2381
  # @param [String] quota_user
@@ -2360,17 +2490,17 @@ module Google
2360
2490
  # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Entry] google_cloud_dataplex_v1_entry_object
2361
2491
  # @param [String] entry_id
2362
2492
  # Required. Entry identifier. It has to be unique within an Entry Group.Entries
2363
- # corresponding to Google Cloud resources use Entry ID format based on Full
2364
- # Resource Names (https://cloud.google.com/apis/design/resource_names#
2365
- # full_resource_name). The format is a Full Resource Name of the resource
2366
- # without the prefix double slashes in the API Service Name part of Full
2367
- # Resource Name. This allows retrieval of entries using their associated
2368
- # resource name.For example if the Full Resource Name of a resource is //library.
2369
- # googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is
2370
- # library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to
2371
- # follow the same convention for entries corresponding to resources from other
2372
- # providers or systems than Google Cloud.The maximum size of the field is 4000
2373
- # characters.
2493
+ # corresponding to Google Cloud resources use an Entry ID format based on full
2494
+ # resource names (https://cloud.google.com/apis/design/resource_names#
2495
+ # full_resource_name). The format is a full resource name of the resource
2496
+ # without the prefix double slashes in the API service name part of the full
2497
+ # resource name. This allows retrieval of entries using their associated
2498
+ # resource name.For example, if the full resource name of a resource is //
2499
+ # library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id
2500
+ # is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to
2501
+ # follow the same convention for entries corresponding to resources from
2502
+ # providers or systems other than Google Cloud.The maximum size of the field is
2503
+ # 4000 characters.
2374
2504
  # @param [String] fields
2375
2505
  # Selector specifying which fields to include in a partial response.
2376
2506
  # @param [String] quota_user
@@ -2432,18 +2562,18 @@ module Google
2432
2562
  execute_or_queue_command(command, &block)
2433
2563
  end
2434
2564
 
2435
- # Gets a single entry.
2565
+ # Gets an Entry.
2436
2566
  # @param [String] name
2437
2567
  # Required. The resource name of the Entry: projects/`project`/locations/`
2438
2568
  # location`/entryGroups/`entry_group`/entries/`entry`.
2439
2569
  # @param [Array<String>, String] aspect_types
2440
- # Optional. Limits the aspects returned to the provided aspect types. Only works
2441
- # if the CUSTOM view is selected.
2570
+ # Optional. Limits the aspects returned to the provided aspect types. It only
2571
+ # works for CUSTOM view.
2442
2572
  # @param [Array<String>, String] paths
2443
2573
  # Optional. Limits the aspects returned to those associated with the provided
2444
- # paths within the Entry. Only works if the CUSTOM view is selected.
2574
+ # paths within the Entry. It only works for CUSTOM view.
2445
2575
  # @param [String] view
2446
- # Optional. View for controlling which parts of an entry are to be returned.
2576
+ # Optional. View to control which parts of an entry the service should return.
2447
2577
  # @param [String] fields
2448
2578
  # Selector specifying which fields to include in a partial response.
2449
2579
  # @param [String] quota_user
@@ -2474,24 +2604,29 @@ module Google
2474
2604
  execute_or_queue_command(command, &block)
2475
2605
  end
2476
2606
 
2477
- # Lists entries within an entry group.
2607
+ # Lists Entries within an EntryGroup.
2478
2608
  # @param [String] parent
2479
2609
  # Required. The resource name of the parent Entry Group: projects/`project`/
2480
2610
  # locations/`location`/entryGroups/`entry_group`.
2481
2611
  # @param [String] filter
2482
- # Optional. A filter on the entries to return. Filters are case-sensitive. The
2483
- # request can be filtered by the following fields: entry_type, entry_source.
2484
- # display_name. The comparison operators are =, !=, <, >, <=, >= (strings are
2485
- # compared according to lexical order) The logical operators AND, OR, NOT can be
2486
- # used in the filter. Wildcard "*" can be used, but for entry_type the full
2487
- # project id or number needs to be provided. Example filter expressions: "
2612
+ # Optional. A filter on the entries to return. Filters are case-sensitive. You
2613
+ # can filter the request by the following fields: entry_type entry_source.
2614
+ # display_nameThe comparison operators are =, !=, <, >, <=, >=. The service
2615
+ # compares strings according to lexical order.You can use the logical operators
2616
+ # AND, OR, NOT in the filter.You can use Wildcard "*", but for entry_type you
2617
+ # need to provide the full project id or number.Example filter expressions: "
2488
2618
  # entry_source.display_name=AnExampleDisplayName" "entry_type=projects/example-
2489
2619
  # project/locations/global/entryTypes/example-entry_type" "entry_type=projects/
2490
2620
  # example-project/locations/us/entryTypes/a* OR entry_type=projects/another-
2491
2621
  # project/locations/*" "NOT entry_source.display_name=AnotherExampleDisplayName"
2492
2622
  # @param [Fixnum] page_size
2623
+ # Optional. Number of items to return per page. If there are remaining results,
2624
+ # the service returns a next_page_token. If unspecified, the service returns at
2625
+ # most 10 Entries. The maximum value is 100; values above 100 will be coerced to
2626
+ # 100.
2493
2627
  # @param [String] page_token
2494
- # Optional. The pagination token returned by a previous request.
2628
+ # Optional. Page token received from a previous ListEntries call. Provide this
2629
+ # to retrieve the subsequent page.
2495
2630
  # @param [String] fields
2496
2631
  # Selector specifying which fields to include in a partial response.
2497
2632
  # @param [String] quota_user
@@ -2524,26 +2659,30 @@ module Google
2524
2659
 
2525
2660
  # Updates an Entry.
2526
2661
  # @param [String] name
2527
- # Identifier. The relative resource name of the Entry, of the form: projects/`
2528
- # project`/locations/`location`/entryGroups/`entry_group`/entries/`entry`.
2662
+ # Identifier. The relative resource name of the entry, in the format projects/`
2663
+ # project_id_or_number`/locations/`location_id`/entryGroups/`entry_group_id`/
2664
+ # entries/`entry_id`.
2529
2665
  # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1Entry] google_cloud_dataplex_v1_entry_object
2530
2666
  # @param [Boolean] allow_missing
2531
- # Optional. If set to true and the entry does not exist, it will be created.
2667
+ # Optional. If set to true and the entry doesn't exist, the service will create
2668
+ # it.
2532
2669
  # @param [Array<String>, String] aspect_keys
2533
- # Optional. The map keys of the Aspects which should be modified. Supports the
2534
- # following syntaxes: * - matches aspect on given type and empty path * @path -
2535
- # matches aspect on given type and specified path * * - matches aspects on given
2536
- # type for all paths * *@path - matches aspects of all types on the given
2537
- # pathExisting aspects matching the syntax will not be removed unless
2538
- # delete_missing_aspects is set to true.If this field is left empty, it will be
2539
- # treated as specifying exactly those Aspects present in the request.
2670
+ # Optional. The map keys of the Aspects which the service should modify. It
2671
+ # supports the following syntaxes: - matches an aspect of the given type and
2672
+ # empty path. @path - matches an aspect of the given type and specified path. * -
2673
+ # matches aspects of the given type for all paths. *@path - matches aspects of
2674
+ # all types on the given path.The service will not remove existing aspects
2675
+ # matching the syntax unless delete_missing_aspects is set to true.If this field
2676
+ # is left empty, the service treats it as specifying exactly those Aspects
2677
+ # present in the request.
2540
2678
  # @param [Boolean] delete_missing_aspects
2541
- # Optional. If set to true and the aspect_keys specify aspect ranges, any
2542
- # existing aspects from that range not provided in the request will be deleted.
2679
+ # Optional. If set to true and the aspect_keys specify aspect ranges, the
2680
+ # service deletes any existing aspects from that range that weren't provided in
2681
+ # the request.
2543
2682
  # @param [String] update_mask
2544
2683
  # Optional. Mask of fields to update. To update Aspects, the update_mask must
2545
- # contain the value "aspects".If the update_mask is empty, all modifiable fields
2546
- # present in the request will be updated.
2684
+ # contain the value "aspects".If the update_mask is empty, the service will
2685
+ # update all modifiable fields present in the request.
2547
2686
  # @param [String] fields
2548
2687
  # Selector specifying which fields to include in a partial response.
2549
2688
  # @param [String] quota_user
@@ -2577,17 +2716,17 @@ module Google
2577
2716
  execute_or_queue_command(command, &block)
2578
2717
  end
2579
2718
 
2580
- # Creates an EntryType
2719
+ # Creates an EntryType.
2581
2720
  # @param [String] parent
2582
2721
  # Required. The resource name of the EntryType, of the form: projects/`
2583
- # project_number`/locations/`location_id` where location_id refers to a GCP
2584
- # region.
2722
+ # project_number`/locations/`location_id` where location_id refers to a Google
2723
+ # Cloud region.
2585
2724
  # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1EntryType] google_cloud_dataplex_v1_entry_type_object
2586
2725
  # @param [String] entry_type_id
2587
2726
  # Required. EntryType identifier.
2588
2727
  # @param [Boolean] validate_only
2589
- # Optional. Only validate the request, but do not perform mutations. The default
2590
- # is false.
2728
+ # Optional. The service validates the request without performing any mutations.
2729
+ # The default is false.
2591
2730
  # @param [String] fields
2592
2731
  # Selector specifying which fields to include in a partial response.
2593
2732
  # @param [String] quota_user
@@ -2619,13 +2758,13 @@ module Google
2619
2758
  execute_or_queue_command(command, &block)
2620
2759
  end
2621
2760
 
2622
- # Deletes a EntryType resource.
2761
+ # Deletes an EntryType.
2623
2762
  # @param [String] name
2624
2763
  # Required. The resource name of the EntryType: projects/`project_number`/
2625
2764
  # locations/`location_id`/entryTypes/`entry_type_id`.
2626
2765
  # @param [String] etag
2627
2766
  # Optional. If the client provided etag value does not match the current etag
2628
- # value, the DeleteEntryTypeRequest method returns an ABORTED error response
2767
+ # value, the DeleteEntryTypeRequest method returns an ABORTED error response.
2629
2768
  # @param [String] fields
2630
2769
  # Selector specifying which fields to include in a partial response.
2631
2770
  # @param [String] quota_user
@@ -2654,7 +2793,7 @@ module Google
2654
2793
  execute_or_queue_command(command, &block)
2655
2794
  end
2656
2795
 
2657
- # Retrieves a EntryType resource.
2796
+ # Gets an EntryType.
2658
2797
  # @param [String] name
2659
2798
  # Required. The resource name of the EntryType: projects/`project_number`/
2660
2799
  # locations/`location_id`/entryTypes/`entry_type_id`.
@@ -2733,23 +2872,24 @@ module Google
2733
2872
  # Lists EntryType resources in a project and location.
2734
2873
  # @param [String] parent
2735
2874
  # Required. The resource name of the EntryType location, of the form: projects/`
2736
- # project_number`/locations/`location_id` where location_id refers to a GCP
2737
- # region.
2875
+ # project_number`/locations/`location_id` where location_id refers to a Google
2876
+ # Cloud region.
2738
2877
  # @param [String] filter
2739
- # Optional. Filter request. Filters are case-sensitive. The following formats
2740
- # are supported:labels.key1 = "value1" labels:key1 name = "value" These
2741
- # restrictions can be coinjoined with AND, OR and NOT conjunctions.
2878
+ # Optional. Filter request. Filters are case-sensitive. The service supports the
2879
+ # following formats: labels.key1 = "value1" labels:key1 name = "value"These
2880
+ # restrictions can be conjoined with AND, OR, and NOT conjunctions.
2742
2881
  # @param [String] order_by
2743
- # Optional. Order by fields (name or create_time) for the result. If not
2744
- # specified, the ordering is undefined.
2882
+ # Optional. Orders the result by name or create_time fields. If not specified,
2883
+ # the ordering is undefined.
2745
2884
  # @param [Fixnum] page_size
2746
2885
  # Optional. Maximum number of EntryTypes to return. The service may return fewer
2747
- # than this value. If unspecified, at most 10 EntryTypes will be returned. The
2748
- # maximum value is 1000; values above 1000 will be coerced to 1000.
2886
+ # than this value. If unspecified, the service returns at most 10 EntryTypes.
2887
+ # The maximum value is 1000; values above 1000 will be coerced to 1000.
2749
2888
  # @param [String] page_token
2750
2889
  # Optional. Page token received from a previous ListEntryTypes call. Provide
2751
2890
  # this to retrieve the subsequent page. When paginating, all other parameters
2752
- # provided to ListEntryTypes must match the call that provided the page token.
2891
+ # you provided to ListEntryTypes must match the call that provided the page
2892
+ # token.
2753
2893
  # @param [String] fields
2754
2894
  # Selector specifying which fields to include in a partial response.
2755
2895
  # @param [String] quota_user
@@ -2781,7 +2921,7 @@ module Google
2781
2921
  execute_or_queue_command(command, &block)
2782
2922
  end
2783
2923
 
2784
- # Updates a EntryType resource.
2924
+ # Updates an EntryType.
2785
2925
  # @param [String] name
2786
2926
  # Output only. The relative resource name of the EntryType, of the form:
2787
2927
  # projects/`project_number`/locations/`location_id`/entryTypes/`entry_type_id`.
@@ -2789,8 +2929,8 @@ module Google
2789
2929
  # @param [String] update_mask
2790
2930
  # Required. Mask of fields to update.
2791
2931
  # @param [Boolean] validate_only
2792
- # Optional. Only validate the request, but do not perform mutations. The default
2793
- # is false.
2932
+ # Optional. The service validates the request without performing any mutations.
2933
+ # The default is false.
2794
2934
  # @param [String] fields
2795
2935
  # Selector specifying which fields to include in a partial response.
2796
2936
  # @param [String] quota_user
@@ -2898,6 +3038,127 @@ module Google
2898
3038
  execute_or_queue_command(command, &block)
2899
3039
  end
2900
3040
 
3041
+ # Gets the access control policy for a resource. Returns an empty policy if the
3042
+ # resource exists and does not have a policy set.
3043
+ # @param [String] resource
3044
+ # REQUIRED: The resource for which the policy is being requested. See Resource
3045
+ # names (https://cloud.google.com/apis/design/resource_names) for the
3046
+ # appropriate value for this field.
3047
+ # @param [Fixnum] options_requested_policy_version
3048
+ # Optional. The maximum policy version that will be used to format the policy.
3049
+ # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
3050
+ # rejected.Requests for policies with any conditional role bindings must specify
3051
+ # version 3. Policies with no conditional role bindings may specify any valid
3052
+ # value or leave the field unset.The policy in the response might use the policy
3053
+ # version that you specified, or it might use a lower policy version. For
3054
+ # example, if you specify version 3, but the policy has no conditional role
3055
+ # bindings, the response uses version 1.To learn which resources support
3056
+ # conditions in their IAM policies, see the IAM documentation (https://cloud.
3057
+ # google.com/iam/help/conditions/resource-policies).
3058
+ # @param [String] fields
3059
+ # Selector specifying which fields to include in a partial response.
3060
+ # @param [String] quota_user
3061
+ # Available to use for quota purposes for server-side applications. Can be any
3062
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3063
+ # @param [Google::Apis::RequestOptions] options
3064
+ # Request-specific options
3065
+ #
3066
+ # @yield [result, err] Result & error if block supplied
3067
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
3068
+ # @yieldparam err [StandardError] error object if request failed
3069
+ #
3070
+ # @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
3071
+ #
3072
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3073
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3074
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3075
+ def get_project_location_glossary_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
3076
+ command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
3077
+ command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
3078
+ command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
3079
+ command.params['resource'] = resource unless resource.nil?
3080
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
3081
+ command.query['fields'] = fields unless fields.nil?
3082
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3083
+ execute_or_queue_command(command, &block)
3084
+ end
3085
+
3086
+ # Sets the access control policy on the specified resource. Replaces any
3087
+ # existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
3088
+ # errors.
3089
+ # @param [String] resource
3090
+ # REQUIRED: The resource for which the policy is being specified. See Resource
3091
+ # names (https://cloud.google.com/apis/design/resource_names) for the
3092
+ # appropriate value for this field.
3093
+ # @param [Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object
3094
+ # @param [String] fields
3095
+ # Selector specifying which fields to include in a partial response.
3096
+ # @param [String] quota_user
3097
+ # Available to use for quota purposes for server-side applications. Can be any
3098
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3099
+ # @param [Google::Apis::RequestOptions] options
3100
+ # Request-specific options
3101
+ #
3102
+ # @yield [result, err] Result & error if block supplied
3103
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1Policy] parsed result object
3104
+ # @yieldparam err [StandardError] error object if request failed
3105
+ #
3106
+ # @return [Google::Apis::DataplexV1::GoogleIamV1Policy]
3107
+ #
3108
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3109
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3110
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3111
+ def set_project_location_glossary_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3112
+ command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
3113
+ command.request_representation = Google::Apis::DataplexV1::GoogleIamV1SetIamPolicyRequest::Representation
3114
+ command.request_object = google_iam_v1_set_iam_policy_request_object
3115
+ command.response_representation = Google::Apis::DataplexV1::GoogleIamV1Policy::Representation
3116
+ command.response_class = Google::Apis::DataplexV1::GoogleIamV1Policy
3117
+ command.params['resource'] = resource unless resource.nil?
3118
+ command.query['fields'] = fields unless fields.nil?
3119
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3120
+ execute_or_queue_command(command, &block)
3121
+ end
3122
+
3123
+ # Returns permissions that a caller has on the specified resource. If the
3124
+ # resource does not exist, this will return an empty set of permissions, not a
3125
+ # NOT_FOUND error.Note: This operation is designed to be used for building
3126
+ # permission-aware UIs and command-line tools, not for authorization checking.
3127
+ # This operation may "fail open" without warning.
3128
+ # @param [String] resource
3129
+ # REQUIRED: The resource for which the policy detail is being requested. See
3130
+ # Resource names (https://cloud.google.com/apis/design/resource_names) for the
3131
+ # appropriate value for this field.
3132
+ # @param [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsRequest] google_iam_v1_test_iam_permissions_request_object
3133
+ # @param [String] fields
3134
+ # Selector specifying which fields to include in a partial response.
3135
+ # @param [String] quota_user
3136
+ # Available to use for quota purposes for server-side applications. Can be any
3137
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3138
+ # @param [Google::Apis::RequestOptions] options
3139
+ # Request-specific options
3140
+ #
3141
+ # @yield [result, err] Result & error if block supplied
3142
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse] parsed result object
3143
+ # @yieldparam err [StandardError] error object if request failed
3144
+ #
3145
+ # @return [Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse]
3146
+ #
3147
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3148
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3149
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3150
+ def test_project_location_glossary_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3151
+ command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
3152
+ command.request_representation = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsRequest::Representation
3153
+ command.request_object = google_iam_v1_test_iam_permissions_request_object
3154
+ command.response_representation = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse::Representation
3155
+ command.response_class = Google::Apis::DataplexV1::GoogleIamV1TestIamPermissionsResponse
3156
+ command.params['resource'] = resource unless resource.nil?
3157
+ command.query['fields'] = fields unless fields.nil?
3158
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3159
+ execute_or_queue_command(command, &block)
3160
+ end
3161
+
2901
3162
  # Gets the access control policy for a resource. Returns an empty policy if the
2902
3163
  # resource exists and does not have a policy set.
2903
3164
  # @param [String] resource
@@ -5905,6 +6166,164 @@ module Google
5905
6166
  execute_or_queue_command(command, &block)
5906
6167
  end
5907
6168
 
6169
+ # Cancels a metadata job.If you cancel a metadata import job that is in progress,
6170
+ # the changes in the job might be partially applied. We recommend that you
6171
+ # reset the state of the entry groups in your project by running another
6172
+ # metadata job that reverts the changes from the canceled job.
6173
+ # @param [String] name
6174
+ # Required. The resource name of the job, in the format projects/`
6175
+ # project_id_or_number`/locations/`location_id`/metadataJobs/`metadata_job_id`
6176
+ # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1CancelMetadataJobRequest] google_cloud_dataplex_v1_cancel_metadata_job_request_object
6177
+ # @param [String] fields
6178
+ # Selector specifying which fields to include in a partial response.
6179
+ # @param [String] quota_user
6180
+ # Available to use for quota purposes for server-side applications. Can be any
6181
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6182
+ # @param [Google::Apis::RequestOptions] options
6183
+ # Request-specific options
6184
+ #
6185
+ # @yield [result, err] Result & error if block supplied
6186
+ # @yieldparam result [Google::Apis::DataplexV1::Empty] parsed result object
6187
+ # @yieldparam err [StandardError] error object if request failed
6188
+ #
6189
+ # @return [Google::Apis::DataplexV1::Empty]
6190
+ #
6191
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6192
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6193
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6194
+ def cancel_project_location_metadata_job(name, google_cloud_dataplex_v1_cancel_metadata_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
6195
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
6196
+ command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1CancelMetadataJobRequest::Representation
6197
+ command.request_object = google_cloud_dataplex_v1_cancel_metadata_job_request_object
6198
+ command.response_representation = Google::Apis::DataplexV1::Empty::Representation
6199
+ command.response_class = Google::Apis::DataplexV1::Empty
6200
+ command.params['name'] = name unless name.nil?
6201
+ command.query['fields'] = fields unless fields.nil?
6202
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6203
+ execute_or_queue_command(command, &block)
6204
+ end
6205
+
6206
+ # Creates a metadata job. For example, use a metadata job to import Dataplex
6207
+ # Catalog entries and aspects from a third-party system into Dataplex.
6208
+ # @param [String] parent
6209
+ # Required. The resource name of the parent location, in the format projects/`
6210
+ # project_id_or_number`/locations/`location_id`
6211
+ # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1MetadataJob] google_cloud_dataplex_v1_metadata_job_object
6212
+ # @param [String] metadata_job_id
6213
+ # Optional. The metadata job ID. If not provided, a unique ID is generated with
6214
+ # the prefix metadata-job-.
6215
+ # @param [String] fields
6216
+ # Selector specifying which fields to include in a partial response.
6217
+ # @param [String] quota_user
6218
+ # Available to use for quota purposes for server-side applications. Can be any
6219
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6220
+ # @param [Google::Apis::RequestOptions] options
6221
+ # Request-specific options
6222
+ #
6223
+ # @yield [result, err] Result & error if block supplied
6224
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleLongrunningOperation] parsed result object
6225
+ # @yieldparam err [StandardError] error object if request failed
6226
+ #
6227
+ # @return [Google::Apis::DataplexV1::GoogleLongrunningOperation]
6228
+ #
6229
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6230
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6231
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6232
+ def create_project_location_metadata_job(parent, google_cloud_dataplex_v1_metadata_job_object = nil, metadata_job_id: nil, fields: nil, quota_user: nil, options: nil, &block)
6233
+ command = make_simple_command(:post, 'v1/{+parent}/metadataJobs', options)
6234
+ command.request_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1MetadataJob::Representation
6235
+ command.request_object = google_cloud_dataplex_v1_metadata_job_object
6236
+ command.response_representation = Google::Apis::DataplexV1::GoogleLongrunningOperation::Representation
6237
+ command.response_class = Google::Apis::DataplexV1::GoogleLongrunningOperation
6238
+ command.params['parent'] = parent unless parent.nil?
6239
+ command.query['metadataJobId'] = metadata_job_id unless metadata_job_id.nil?
6240
+ command.query['fields'] = fields unless fields.nil?
6241
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6242
+ execute_or_queue_command(command, &block)
6243
+ end
6244
+
6245
+ # Gets a metadata job.
6246
+ # @param [String] name
6247
+ # Required. The resource name of the metadata job, in the format projects/`
6248
+ # project_id_or_number`/locations/`location_id`/metadataJobs/`metadata_job_id`.
6249
+ # @param [String] fields
6250
+ # Selector specifying which fields to include in a partial response.
6251
+ # @param [String] quota_user
6252
+ # Available to use for quota purposes for server-side applications. Can be any
6253
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6254
+ # @param [Google::Apis::RequestOptions] options
6255
+ # Request-specific options
6256
+ #
6257
+ # @yield [result, err] Result & error if block supplied
6258
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1MetadataJob] parsed result object
6259
+ # @yieldparam err [StandardError] error object if request failed
6260
+ #
6261
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1MetadataJob]
6262
+ #
6263
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6264
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6265
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6266
+ def get_project_location_metadata_job(name, fields: nil, quota_user: nil, options: nil, &block)
6267
+ command = make_simple_command(:get, 'v1/{+name}', options)
6268
+ command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1MetadataJob::Representation
6269
+ command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1MetadataJob
6270
+ command.params['name'] = name unless name.nil?
6271
+ command.query['fields'] = fields unless fields.nil?
6272
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6273
+ execute_or_queue_command(command, &block)
6274
+ end
6275
+
6276
+ # Lists metadata jobs.
6277
+ # @param [String] parent
6278
+ # Required. The resource name of the parent location, in the format projects/`
6279
+ # project_id_or_number`/locations/`location_id`
6280
+ # @param [String] filter
6281
+ # Optional. Filter request. Filters are case-sensitive. The service supports the
6282
+ # following formats: labels.key1 = "value1" labels:key1 name = "value"You can
6283
+ # combine filters with AND, OR, and NOT operators.
6284
+ # @param [String] order_by
6285
+ # Optional. The field to sort the results by, either name or create_time. If not
6286
+ # specified, the ordering is undefined.
6287
+ # @param [Fixnum] page_size
6288
+ # Optional. The maximum number of metadata jobs to return. The service might
6289
+ # return fewer jobs than this value. If unspecified, at most 10 jobs are
6290
+ # returned. The maximum value is 1,000.
6291
+ # @param [String] page_token
6292
+ # Optional. The page token received from a previous ListMetadataJobs call.
6293
+ # Provide this token to retrieve the subsequent page of results. When paginating,
6294
+ # all other parameters that are provided to the ListMetadataJobs request must
6295
+ # match the call that provided the page token.
6296
+ # @param [String] fields
6297
+ # Selector specifying which fields to include in a partial response.
6298
+ # @param [String] quota_user
6299
+ # Available to use for quota purposes for server-side applications. Can be any
6300
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
6301
+ # @param [Google::Apis::RequestOptions] options
6302
+ # Request-specific options
6303
+ #
6304
+ # @yield [result, err] Result & error if block supplied
6305
+ # @yieldparam result [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListMetadataJobsResponse] parsed result object
6306
+ # @yieldparam err [StandardError] error object if request failed
6307
+ #
6308
+ # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1ListMetadataJobsResponse]
6309
+ #
6310
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
6311
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
6312
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
6313
+ def list_project_location_metadata_jobs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
6314
+ command = make_simple_command(:get, 'v1/{+parent}/metadataJobs', options)
6315
+ command.response_representation = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListMetadataJobsResponse::Representation
6316
+ command.response_class = Google::Apis::DataplexV1::GoogleCloudDataplexV1ListMetadataJobsResponse
6317
+ command.params['parent'] = parent unless parent.nil?
6318
+ command.query['filter'] = filter unless filter.nil?
6319
+ command.query['orderBy'] = order_by unless order_by.nil?
6320
+ command.query['pageSize'] = page_size unless page_size.nil?
6321
+ command.query['pageToken'] = page_token unless page_token.nil?
6322
+ command.query['fields'] = fields unless fields.nil?
6323
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
6324
+ execute_or_queue_command(command, &block)
6325
+ end
6326
+
5908
6327
  # Starts asynchronous cancellation on a long-running operation. The server makes
5909
6328
  # a best effort to cancel the operation, but success is not guaranteed. If the
5910
6329
  # server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.