google-apis-apihub_v1 0.9.0 → 0.11.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.
@@ -195,6 +195,50 @@ module Google
195
195
  execute_or_queue_command(command, &block)
196
196
  end
197
197
 
198
+ # Retrieve API views.
199
+ # @param [String] parent
200
+ # Required. The parent resource name. Format: `projects/`project`/locations/`
201
+ # location``.
202
+ # @param [String] filter
203
+ # Optional. The filter expression.
204
+ # @param [Fixnum] page_size
205
+ # Optional. The maximum number of results to return. Default to 100.
206
+ # @param [String] page_token
207
+ # Optional. A page token, received from a previous `RetrieveApiViews` call.
208
+ # Provide this to retrieve the subsequent page.
209
+ # @param [String] view
210
+ # Required. The view type to return.
211
+ # @param [String] fields
212
+ # Selector specifying which fields to include in a partial response.
213
+ # @param [String] quota_user
214
+ # Available to use for quota purposes for server-side applications. Can be any
215
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
216
+ # @param [Google::Apis::RequestOptions] options
217
+ # Request-specific options
218
+ #
219
+ # @yield [result, err] Result & error if block supplied
220
+ # @yieldparam result [Google::Apis::ApihubV1::GoogleCloudApihubV1RetrieveApiViewsResponse] parsed result object
221
+ # @yieldparam err [StandardError] error object if request failed
222
+ #
223
+ # @return [Google::Apis::ApihubV1::GoogleCloudApihubV1RetrieveApiViewsResponse]
224
+ #
225
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
226
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
227
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
228
+ def retrieve_project_location_api_views(parent, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
229
+ command = make_simple_command(:get, 'v1/{+parent}:retrieveApiViews', options)
230
+ command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1RetrieveApiViewsResponse::Representation
231
+ command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1RetrieveApiViewsResponse
232
+ command.params['parent'] = parent unless parent.nil?
233
+ command.query['filter'] = filter unless filter.nil?
234
+ command.query['pageSize'] = page_size unless page_size.nil?
235
+ command.query['pageToken'] = page_token unless page_token.nil?
236
+ command.query['view'] = view unless view.nil?
237
+ command.query['fields'] = fields unless fields.nil?
238
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
239
+ execute_or_queue_command(command, &block)
240
+ end
241
+
198
242
  # Search across API-Hub resources.
199
243
  # @param [String] location
200
244
  # Required. The resource name of the location which will be of the type `
@@ -230,6 +274,122 @@ module Google
230
274
  execute_or_queue_command(command, &block)
231
275
  end
232
276
 
277
+ # Get an addon.
278
+ # @param [String] name
279
+ # Required. The name of the addon to get. Format: `projects/`project`/locations/`
280
+ # location`/addons/`addon``.
281
+ # @param [String] fields
282
+ # Selector specifying which fields to include in a partial response.
283
+ # @param [String] quota_user
284
+ # Available to use for quota purposes for server-side applications. Can be any
285
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
286
+ # @param [Google::Apis::RequestOptions] options
287
+ # Request-specific options
288
+ #
289
+ # @yield [result, err] Result & error if block supplied
290
+ # @yieldparam result [Google::Apis::ApihubV1::GoogleCloudApihubV1Addon] parsed result object
291
+ # @yieldparam err [StandardError] error object if request failed
292
+ #
293
+ # @return [Google::Apis::ApihubV1::GoogleCloudApihubV1Addon]
294
+ #
295
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
296
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
297
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
298
+ def get_project_location_addon(name, fields: nil, quota_user: nil, options: nil, &block)
299
+ command = make_simple_command(:get, 'v1/{+name}', options)
300
+ command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1Addon::Representation
301
+ command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1Addon
302
+ command.params['name'] = name unless name.nil?
303
+ command.query['fields'] = fields unless fields.nil?
304
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
305
+ execute_or_queue_command(command, &block)
306
+ end
307
+
308
+ # List addons.
309
+ # @param [String] parent
310
+ # Required. The parent resource where this addon will be created. Format: `
311
+ # projects/`project`/locations/`location``.
312
+ # @param [String] filter
313
+ # Optional. An expression that filters the list of addons. The only supported
314
+ # filter is `plugin_instance_name`. It can be used to filter addons that are
315
+ # enabled for a given plugin instance. The format of the filter is `
316
+ # plugin_instance_name = "projects/`project`/locations/`location`/plugins/`
317
+ # plugin`/instances/`instance`"`.
318
+ # @param [Fixnum] page_size
319
+ # Optional. The maximum number of hub addons to return. The service may return
320
+ # fewer than this value. If unspecified, at most 50 hub addons will be returned.
321
+ # The maximum value is 1000; values above 1000 will be coerced to 1000.
322
+ # @param [String] page_token
323
+ # Optional. A page token, received from a previous `ListAddons` call. Provide
324
+ # this to retrieve the subsequent page. When paginating, all other parameters (
325
+ # except page_size) provided to `ListAddons` must match the call that provided
326
+ # the page token.
327
+ # @param [String] fields
328
+ # Selector specifying which fields to include in a partial response.
329
+ # @param [String] quota_user
330
+ # Available to use for quota purposes for server-side applications. Can be any
331
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
332
+ # @param [Google::Apis::RequestOptions] options
333
+ # Request-specific options
334
+ #
335
+ # @yield [result, err] Result & error if block supplied
336
+ # @yieldparam result [Google::Apis::ApihubV1::GoogleCloudApihubV1ListAddonsResponse] parsed result object
337
+ # @yieldparam err [StandardError] error object if request failed
338
+ #
339
+ # @return [Google::Apis::ApihubV1::GoogleCloudApihubV1ListAddonsResponse]
340
+ #
341
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
342
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
343
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
344
+ def list_project_location_addons(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
345
+ command = make_simple_command(:get, 'v1/{+parent}/addons', options)
346
+ command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ListAddonsResponse::Representation
347
+ command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1ListAddonsResponse
348
+ command.params['parent'] = parent unless parent.nil?
349
+ command.query['filter'] = filter unless filter.nil?
350
+ command.query['pageSize'] = page_size unless page_size.nil?
351
+ command.query['pageToken'] = page_token unless page_token.nil?
352
+ command.query['fields'] = fields unless fields.nil?
353
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
354
+ execute_or_queue_command(command, &block)
355
+ end
356
+
357
+ # Manage addon config. This RPC is used for managing the config of the addon.
358
+ # Calling this RPC moves the addon into an updating state until the long-running
359
+ # operation succeeds.
360
+ # @param [String] name
361
+ # Required. The name of the addon for which the config is to be managed. Format:
362
+ # `projects/`project`/locations/`location`/addons/`addon``.
363
+ # @param [Google::Apis::ApihubV1::GoogleCloudApihubV1ManageAddonConfigRequest] google_cloud_apihub_v1_manage_addon_config_request_object
364
+ # @param [String] fields
365
+ # Selector specifying which fields to include in a partial response.
366
+ # @param [String] quota_user
367
+ # Available to use for quota purposes for server-side applications. Can be any
368
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
369
+ # @param [Google::Apis::RequestOptions] options
370
+ # Request-specific options
371
+ #
372
+ # @yield [result, err] Result & error if block supplied
373
+ # @yieldparam result [Google::Apis::ApihubV1::GoogleLongrunningOperation] parsed result object
374
+ # @yieldparam err [StandardError] error object if request failed
375
+ #
376
+ # @return [Google::Apis::ApihubV1::GoogleLongrunningOperation]
377
+ #
378
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
379
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
380
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
381
+ def manage_project_location_addon_config(name, google_cloud_apihub_v1_manage_addon_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
382
+ command = make_simple_command(:post, 'v1/{+name}:manageConfig', options)
383
+ command.request_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1ManageAddonConfigRequest::Representation
384
+ command.request_object = google_cloud_apihub_v1_manage_addon_config_request_object
385
+ command.response_representation = Google::Apis::ApihubV1::GoogleLongrunningOperation::Representation
386
+ command.response_class = Google::Apis::ApihubV1::GoogleLongrunningOperation
387
+ command.params['name'] = name unless name.nil?
388
+ command.query['fields'] = fields unless fields.nil?
389
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
390
+ execute_or_queue_command(command, &block)
391
+ end
392
+
233
393
  # Provisions instance resources for the API Hub.
234
394
  # @param [String] parent
235
395
  # Required. The parent resource for the Api Hub instance resource. Format: `
@@ -538,9 +698,13 @@ module Google
538
698
  # id of the resource name. For example, `id(name) = \"api-1\"` is equivalent to `
539
699
  # name = \"projects/test-project-id/locations/test-location-id/apis/api-1\"`
540
700
  # provided the parent is `projects/test-project-id/locations/test-location-id`.
541
- # Expressions are combined with either `AND` logic operator or `OR` logical
542
- # operator but not both of them together i.e. only one of the `AND` or `OR`
543
- # operator can be used throughout the filter string and both the operators
701
+ # Another supported filter function is `plugins(source_metadata)`. This function
702
+ # filters for resources that are associated with a specific plugin. For example,
703
+ # `plugins(source_metadata) : "projects/test-project-id/locations/test-location-
704
+ # id/plugins/test-plugin-id"` will return resources sourced from the given
705
+ # plugin. Expressions are combined with either `AND` logic operator or `OR`
706
+ # logical operator but not both of them together i.e. only one of the `AND` or `
707
+ # OR` operator can be used throughout the filter string and both the operators
544
708
  # cannot be used together. No other logical operators are supported. At most
545
709
  # three filter fields are allowed in the filter string and if provided more than
546
710
  # that then `INVALID_ARGUMENT` error is returned by the API. Here are a few
@@ -1149,14 +1313,15 @@ module Google
1149
1313
  # ApiOperation resource can be updated: * details.description * details.
1150
1314
  # documentation * details.http_operation.path * details.http_operation.method *
1151
1315
  # details.deprecated * attributes * details.mcp_tool.title * details.mcp_tool.
1152
- # description * details.input_schema * details.output_schema * details.mcp_tool.
1153
- # annotations.title * details.mcp_tool.annotations.read_only_hint * details.
1154
- # mcp_tool.annotations.destructive_hint * details.mcp_tool.annotations.
1155
- # idempotent_hint * details.mcp_tool.annotations.open_world_hint * details.
1156
- # mcp_tool.annotations.additional_hints The update_mask should be used to
1157
- # specify the fields being updated. An operation can be updated only if the
1158
- # operation was created via CreateApiOperation API. If the operation was created
1159
- # by parsing the spec, then it can be edited by updating the spec.
1316
+ # description * details.mcp_tool.input_schema * details.mcp_tool.output_schema *
1317
+ # details.input_schema * details.output_schema * details.mcp_tool.annotations.
1318
+ # title * details.mcp_tool.annotations.read_only_hint * details.mcp_tool.
1319
+ # annotations.destructive_hint * details.mcp_tool.annotations.idempotent_hint *
1320
+ # details.mcp_tool.annotations.open_world_hint * details.mcp_tool.annotations.
1321
+ # additional_hints The update_mask should be used to specify the fields being
1322
+ # updated. An operation can be updated only if the operation was created via
1323
+ # CreateApiOperation API. If the operation was created by parsing the spec, then
1324
+ # it can be edited by updating the spec.
1160
1325
  # @param [String] name
1161
1326
  # Identifier. The name of the operation. Format: `projects/`project`/locations/`
1162
1327
  # location`/apis/`api`/versions/`version`/operations/`operation``
@@ -1281,6 +1446,41 @@ module Google
1281
1446
  execute_or_queue_command(command, &block)
1282
1447
  end
1283
1448
 
1449
+ # Fetch additional spec content.
1450
+ # @param [String] name
1451
+ # Required. The name of the spec whose contents need to be retrieved. Format: `
1452
+ # projects/`project`/locations/`location`/apis/`api`/versions/`version`/specs/`
1453
+ # spec``
1454
+ # @param [String] spec_content_type
1455
+ # Optional. The type of the spec contents to be retrieved.
1456
+ # @param [String] fields
1457
+ # Selector specifying which fields to include in a partial response.
1458
+ # @param [String] quota_user
1459
+ # Available to use for quota purposes for server-side applications. Can be any
1460
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1461
+ # @param [Google::Apis::RequestOptions] options
1462
+ # Request-specific options
1463
+ #
1464
+ # @yield [result, err] Result & error if block supplied
1465
+ # @yieldparam result [Google::Apis::ApihubV1::GoogleCloudApihubV1FetchAdditionalSpecContentResponse] parsed result object
1466
+ # @yieldparam err [StandardError] error object if request failed
1467
+ #
1468
+ # @return [Google::Apis::ApihubV1::GoogleCloudApihubV1FetchAdditionalSpecContentResponse]
1469
+ #
1470
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1471
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1472
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1473
+ def fetch_project_location_api_version_spec_additional_spec_content(name, spec_content_type: nil, fields: nil, quota_user: nil, options: nil, &block)
1474
+ command = make_simple_command(:get, 'v1/{+name}:fetchAdditionalSpecContent', options)
1475
+ command.response_representation = Google::Apis::ApihubV1::GoogleCloudApihubV1FetchAdditionalSpecContentResponse::Representation
1476
+ command.response_class = Google::Apis::ApihubV1::GoogleCloudApihubV1FetchAdditionalSpecContentResponse
1477
+ command.params['name'] = name unless name.nil?
1478
+ command.query['specContentType'] = spec_content_type unless spec_content_type.nil?
1479
+ command.query['fields'] = fields unless fields.nil?
1480
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1481
+ execute_or_queue_command(command, &block)
1482
+ end
1483
+
1284
1484
  # Get details about the information parsed from a spec. Note that this method
1285
1485
  # does not return the raw spec contents. Use GetSpecContents method to retrieve
1286
1486
  # the same.
@@ -3023,11 +3223,12 @@ module Google
3023
3223
  # The standard list page token.
3024
3224
  # @param [Boolean] return_partial_success
3025
3225
  # When set to `true`, operations that are reachable are returned as normal, and
3026
- # those that are unreachable are returned in the [ListOperationsResponse.
3027
- # unreachable] field. This can only be `true` when reading across collections e.
3028
- # g. when `parent` is set to `"projects/example/locations/-"`. This field is not
3029
- # by default supported and will result in an `UNIMPLEMENTED` error if set unless
3030
- # explicitly documented otherwise in service or product specific documentation.
3226
+ # those that are unreachable are returned in the ListOperationsResponse.
3227
+ # unreachable field. This can only be `true` when reading across collections.
3228
+ # For example, when `parent` is set to `"projects/example/locations/-"`. This
3229
+ # field is not supported by default and will result in an `UNIMPLEMENTED` error
3230
+ # if set unless explicitly documented otherwise in service or product specific
3231
+ # documentation.
3031
3232
  # @param [String] fields
3032
3233
  # Selector specifying which fields to include in a partial response.
3033
3234
  # @param [String] quota_user
@@ -3578,19 +3779,21 @@ module Google
3578
3779
  # filtering. The value must be a string. The comparison operator must be one of:
3579
3780
  # `<`, `>` or `=`. Filters are not case sensitive. The following fields in the `
3580
3781
  # PluginInstances` are eligible for filtering: * `state` - The state of the
3581
- # Plugin Instance. Allowed comparison operators: `=`. A filter function is also
3582
- # supported in the filter string. The filter function is `id(name)`. The `id(
3583
- # name)` function returns the id of the resource name. For example, `id(name) = \
3584
- # "plugin-instance-1\"` is equivalent to `name = \"projects/test-project-id/
3585
- # locations/test-location-id/plugins/plugin-1/instances/plugin-instance-1\"`
3586
- # provided the parent is `projects/test-project-id/locations/test-location-id/
3587
- # plugins/plugin-1`. Expressions are combined with either `AND` logic operator
3588
- # or `OR` logical operator but not both of them together i.e. only one of the `
3589
- # AND` or `OR` operator can be used throughout the filter string and both the
3590
- # operators cannot be used together. No other logical operators are supported.
3591
- # At most three filter fields are allowed in the filter string and if provided
3592
- # more than that then `INVALID_ARGUMENT` error is returned by the API. Here are
3593
- # a few examples: * `state = ENABLED` - The plugin instance is in enabled state.
3782
+ # Plugin Instance. Allowed comparison operators: `=`. * `source_project_id` -
3783
+ # The source project id of the Plugin Instance. Allowed comparison operators: `=`
3784
+ # . A filter function is also supported in the filter string. The filter
3785
+ # function is `id(name)`. The `id(name)` function returns the id of the resource
3786
+ # name. For example, `id(name) = \"plugin-instance-1\"` is equivalent to `name =
3787
+ # \"projects/test-project-id/locations/test-location-id/plugins/plugin-1/
3788
+ # instances/plugin-instance-1\"` provided the parent is `projects/test-project-
3789
+ # id/locations/test-location-id/plugins/plugin-1`. Expressions are combined with
3790
+ # either `AND` logic operator or `OR` logical operator but not both of them
3791
+ # together i.e. only one of the `AND` or `OR` operator can be used throughout
3792
+ # the filter string and both the operators cannot be used together. No other
3793
+ # logical operators are supported. At most three filter fields are allowed in
3794
+ # the filter string and if provided more than that then `INVALID_ARGUMENT` error
3795
+ # is returned by the API. Here are a few examples: * `state = ENABLED` - The
3796
+ # plugin instance is in enabled state.
3594
3797
  # @param [Fixnum] page_size
3595
3798
  # Optional. The maximum number of hub plugins to return. The service may return
3596
3799
  # fewer than this value. If unspecified, at most 50 hub plugins will be returned.
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-apihub_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.9.0
4
+ version: 0.11.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-apihub_v1/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-apihub_v1/v0.9.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-apihub_v1/v0.11.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-apihub_v1
62
62
  rdoc_options: []
63
63
  require_paths: