google-cloud-discovery_engine-v1beta 0.22.0 → 0.23.1

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 (46) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +20 -3
  3. data/lib/google/cloud/discovery_engine/v1beta/completion_service/operations.rb +32 -4
  4. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +12 -1
  5. data/lib/google/cloud/discovery_engine/v1beta/control_service/client.rb +20 -3
  6. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +20 -3
  7. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/client.rb +20 -3
  8. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/operations.rb +32 -4
  9. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +12 -1
  10. data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +20 -3
  11. data/lib/google/cloud/discovery_engine/v1beta/document_service/operations.rb +32 -4
  12. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +12 -1
  13. data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +20 -3
  14. data/lib/google/cloud/discovery_engine/v1beta/engine_service/operations.rb +32 -4
  15. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +12 -1
  16. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/client.rb +20 -3
  17. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/operations.rb +32 -4
  18. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/operations.rb +12 -1
  19. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +20 -3
  20. data/lib/google/cloud/discovery_engine/v1beta/project_service/client.rb +20 -3
  21. data/lib/google/cloud/discovery_engine/v1beta/project_service/operations.rb +32 -4
  22. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb +12 -1
  23. data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +20 -3
  24. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +20 -3
  25. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/client.rb +20 -3
  26. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/operations.rb +32 -4
  27. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/operations.rb +12 -1
  28. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/client.rb +20 -3
  29. data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +20 -3
  30. data/lib/google/cloud/discovery_engine/v1beta/schema_service/operations.rb +32 -4
  31. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +12 -1
  32. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +20 -3
  33. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/client.rb +20 -3
  34. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/operations.rb +32 -4
  35. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +12 -1
  36. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +20 -3
  37. data/lib/google/cloud/discovery_engine/v1beta/session_service/client.rb +20 -3
  38. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +20 -3
  39. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/operations.rb +32 -4
  40. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +12 -1
  41. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +20 -3
  42. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/operations.rb +32 -4
  43. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +12 -1
  44. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  45. data/proto_docs/google/longrunning/operations.rb +18 -0
  46. metadata +1 -1
@@ -682,8 +682,6 @@ module Google
682
682
  # @return [::String,nil]
683
683
  # @!attribute [rw] credentials
684
684
  # Credentials to send with calls. You may provide any of the following types:
685
- # * (`String`) The path to a service account key file in JSON format
686
- # * (`Hash`) A service account key as a Hash
687
685
  # * (`Google::Auth::Credentials`) A googleauth credentials object
688
686
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
689
687
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -692,7 +690,26 @@ module Google
692
690
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
693
691
  # * (`nil`) indicating no credentials
694
692
  #
695
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
693
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
694
+ # is deprecated. Providing an unvalidated credential configuration to
695
+ # Google APIs can compromise the security of your systems and data.
696
+ #
697
+ # @example
698
+ #
699
+ # # The recommended way to provide credentials is to use the `make_creds` method
700
+ # # on the appropriate credentials class for your environment.
701
+ #
702
+ # require "googleauth"
703
+ #
704
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
705
+ # json_key_io: ::File.open("/path/to/keyfile.json")
706
+ # )
707
+ #
708
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::EvaluationService::Client.new do |config|
709
+ # config.credentials = credentials
710
+ # end
711
+ #
712
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
696
713
  # external source for authentication to Google Cloud, you must validate it before
697
714
  # providing it to a Google API client library. Providing an unvalidated credential
698
715
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -134,7 +134,7 @@ module Google
134
134
  # @param options [::Gapic::CallOptions, ::Hash]
135
135
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
136
136
  #
137
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
137
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
138
138
  # Pass arguments to `list_operations` via keyword arguments. Note that at
139
139
  # least one keyword argument is required. To specify no parameters, or to keep all
140
140
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -147,6 +147,17 @@ module Google
147
147
  # The standard list page size.
148
148
  # @param page_token [::String]
149
149
  # The standard list page token.
150
+ # @param return_partial_success [::Boolean]
151
+ # When set to `true`, operations that are reachable are returned as normal,
152
+ # and those that are unreachable are returned in the
153
+ # [ListOperationsResponse.unreachable] field.
154
+ #
155
+ # This can only be `true` when reading across collections e.g. when `parent`
156
+ # is set to `"projects/example/locations/-"`.
157
+ #
158
+ # This field is not by default supported and will result in an
159
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
160
+ # service or product specific documentation.
150
161
  #
151
162
  # @yield [response, operation] Access the result along with the RPC operation
152
163
  # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]
@@ -631,8 +642,6 @@ module Google
631
642
  # @return [::String,nil]
632
643
  # @!attribute [rw] credentials
633
644
  # Credentials to send with calls. You may provide any of the following types:
634
- # * (`String`) The path to a service account key file in JSON format
635
- # * (`Hash`) A service account key as a Hash
636
645
  # * (`Google::Auth::Credentials`) A googleauth credentials object
637
646
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
638
647
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -641,7 +650,26 @@ module Google
641
650
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
642
651
  # * (`nil`) indicating no credentials
643
652
  #
644
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
653
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
654
+ # is deprecated. Providing an unvalidated credential configuration to
655
+ # Google APIs can compromise the security of your systems and data.
656
+ #
657
+ # @example
658
+ #
659
+ # # The recommended way to provide credentials is to use the `make_creds` method
660
+ # # on the appropriate credentials class for your environment.
661
+ #
662
+ # require "googleauth"
663
+ #
664
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
665
+ # json_key_io: ::File.open("/path/to/keyfile.json")
666
+ # )
667
+ #
668
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
669
+ # config.credentials = credentials
670
+ # end
671
+ #
672
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
645
673
  # external source for authentication to Google Cloud, you must validate it before
646
674
  # providing it to a Google API client library. Providing an unvalidated credential
647
675
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -125,7 +125,7 @@ module Google
125
125
  # @param options [::Gapic::CallOptions, ::Hash]
126
126
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
127
127
  #
128
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
128
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
129
129
  # Pass arguments to `list_operations` via keyword arguments. Note that at
130
130
  # least one keyword argument is required. To specify no parameters, or to keep all
131
131
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -138,6 +138,17 @@ module Google
138
138
  # The standard list page size.
139
139
  # @param page_token [::String]
140
140
  # The standard list page token.
141
+ # @param return_partial_success [::Boolean]
142
+ # When set to `true`, operations that are reachable are returned as normal,
143
+ # and those that are unreachable are returned in the
144
+ # [ListOperationsResponse.unreachable] field.
145
+ #
146
+ # This can only be `true` when reading across collections e.g. when `parent`
147
+ # is set to `"projects/example/locations/-"`.
148
+ #
149
+ # This field is not by default supported and will result in an
150
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
151
+ # service or product specific documentation.
141
152
  # @yield [result, operation] Access the result along with the TransportOperation object
142
153
  # @yieldparam result [::Gapic::Operation]
143
154
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -548,8 +548,6 @@ module Google
548
548
  # @return [::String,nil]
549
549
  # @!attribute [rw] credentials
550
550
  # Credentials to send with calls. You may provide any of the following types:
551
- # * (`String`) The path to a service account key file in JSON format
552
- # * (`Hash`) A service account key as a Hash
553
551
  # * (`Google::Auth::Credentials`) A googleauth credentials object
554
552
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
555
553
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -558,7 +556,26 @@ module Google
558
556
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
559
557
  # * (`nil`) indicating no credentials
560
558
  #
561
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
559
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
560
+ # is deprecated. Providing an unvalidated credential configuration to
561
+ # Google APIs can compromise the security of your systems and data.
562
+ #
563
+ # @example
564
+ #
565
+ # # The recommended way to provide credentials is to use the `make_creds` method
566
+ # # on the appropriate credentials class for your environment.
567
+ #
568
+ # require "googleauth"
569
+ #
570
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
571
+ # json_key_io: ::File.open("/path/to/keyfile.json")
572
+ # )
573
+ #
574
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::GroundedGenerationService::Client.new do |config|
575
+ # config.credentials = credentials
576
+ # end
577
+ #
578
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
562
579
  # external source for authentication to Google Cloud, you must validate it before
563
580
  # providing it to a Google API client library. Providing an unvalidated credential
564
581
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -365,8 +365,6 @@ module Google
365
365
  # @return [::String,nil]
366
366
  # @!attribute [rw] credentials
367
367
  # Credentials to send with calls. You may provide any of the following types:
368
- # * (`String`) The path to a service account key file in JSON format
369
- # * (`Hash`) A service account key as a Hash
370
368
  # * (`Google::Auth::Credentials`) A googleauth credentials object
371
369
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
372
370
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -375,7 +373,26 @@ module Google
375
373
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
376
374
  # * (`nil`) indicating no credentials
377
375
  #
378
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
376
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
377
+ # is deprecated. Providing an unvalidated credential configuration to
378
+ # Google APIs can compromise the security of your systems and data.
379
+ #
380
+ # @example
381
+ #
382
+ # # The recommended way to provide credentials is to use the `make_creds` method
383
+ # # on the appropriate credentials class for your environment.
384
+ #
385
+ # require "googleauth"
386
+ #
387
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
388
+ # json_key_io: ::File.open("/path/to/keyfile.json")
389
+ # )
390
+ #
391
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::ProjectService::Client.new do |config|
392
+ # config.credentials = credentials
393
+ # end
394
+ #
395
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
379
396
  # external source for authentication to Google Cloud, you must validate it before
380
397
  # providing it to a Google API client library. Providing an unvalidated credential
381
398
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -134,7 +134,7 @@ module Google
134
134
  # @param options [::Gapic::CallOptions, ::Hash]
135
135
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
136
136
  #
137
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
137
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
138
138
  # Pass arguments to `list_operations` via keyword arguments. Note that at
139
139
  # least one keyword argument is required. To specify no parameters, or to keep all
140
140
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -147,6 +147,17 @@ module Google
147
147
  # The standard list page size.
148
148
  # @param page_token [::String]
149
149
  # The standard list page token.
150
+ # @param return_partial_success [::Boolean]
151
+ # When set to `true`, operations that are reachable are returned as normal,
152
+ # and those that are unreachable are returned in the
153
+ # [ListOperationsResponse.unreachable] field.
154
+ #
155
+ # This can only be `true` when reading across collections e.g. when `parent`
156
+ # is set to `"projects/example/locations/-"`.
157
+ #
158
+ # This field is not by default supported and will result in an
159
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
160
+ # service or product specific documentation.
150
161
  #
151
162
  # @yield [response, operation] Access the result along with the RPC operation
152
163
  # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]
@@ -631,8 +642,6 @@ module Google
631
642
  # @return [::String,nil]
632
643
  # @!attribute [rw] credentials
633
644
  # Credentials to send with calls. You may provide any of the following types:
634
- # * (`String`) The path to a service account key file in JSON format
635
- # * (`Hash`) A service account key as a Hash
636
645
  # * (`Google::Auth::Credentials`) A googleauth credentials object
637
646
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
638
647
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -641,7 +650,26 @@ module Google
641
650
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
642
651
  # * (`nil`) indicating no credentials
643
652
  #
644
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
653
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
654
+ # is deprecated. Providing an unvalidated credential configuration to
655
+ # Google APIs can compromise the security of your systems and data.
656
+ #
657
+ # @example
658
+ #
659
+ # # The recommended way to provide credentials is to use the `make_creds` method
660
+ # # on the appropriate credentials class for your environment.
661
+ #
662
+ # require "googleauth"
663
+ #
664
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
665
+ # json_key_io: ::File.open("/path/to/keyfile.json")
666
+ # )
667
+ #
668
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
669
+ # config.credentials = credentials
670
+ # end
671
+ #
672
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
645
673
  # external source for authentication to Google Cloud, you must validate it before
646
674
  # providing it to a Google API client library. Providing an unvalidated credential
647
675
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -125,7 +125,7 @@ module Google
125
125
  # @param options [::Gapic::CallOptions, ::Hash]
126
126
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
127
127
  #
128
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
128
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
129
129
  # Pass arguments to `list_operations` via keyword arguments. Note that at
130
130
  # least one keyword argument is required. To specify no parameters, or to keep all
131
131
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -138,6 +138,17 @@ module Google
138
138
  # The standard list page size.
139
139
  # @param page_token [::String]
140
140
  # The standard list page token.
141
+ # @param return_partial_success [::Boolean]
142
+ # When set to `true`, operations that are reachable are returned as normal,
143
+ # and those that are unreachable are returned in the
144
+ # [ListOperationsResponse.unreachable] field.
145
+ #
146
+ # This can only be `true` when reading across collections e.g. when `parent`
147
+ # is set to `"projects/example/locations/-"`.
148
+ #
149
+ # This field is not by default supported and will result in an
150
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
151
+ # service or product specific documentation.
141
152
  # @yield [result, operation] Access the result along with the TransportOperation object
142
153
  # @yieldparam result [::Gapic::Operation]
143
154
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -360,8 +360,6 @@ module Google
360
360
  # @return [::String,nil]
361
361
  # @!attribute [rw] credentials
362
362
  # Credentials to send with calls. You may provide any of the following types:
363
- # * (`String`) The path to a service account key file in JSON format
364
- # * (`Hash`) A service account key as a Hash
365
363
  # * (`Google::Auth::Credentials`) A googleauth credentials object
366
364
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
367
365
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -370,7 +368,26 @@ module Google
370
368
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
371
369
  # * (`nil`) indicating no credentials
372
370
  #
373
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
371
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
372
+ # is deprecated. Providing an unvalidated credential configuration to
373
+ # Google APIs can compromise the security of your systems and data.
374
+ #
375
+ # @example
376
+ #
377
+ # # The recommended way to provide credentials is to use the `make_creds` method
378
+ # # on the appropriate credentials class for your environment.
379
+ #
380
+ # require "googleauth"
381
+ #
382
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
383
+ # json_key_io: ::File.open("/path/to/keyfile.json")
384
+ # )
385
+ #
386
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::RankService::Client.new do |config|
387
+ # config.credentials = credentials
388
+ # end
389
+ #
390
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
374
391
  # external source for authentication to Google Cloud, you must validate it before
375
392
  # providing it to a Google API client library. Providing an unvalidated credential
376
393
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -438,8 +438,6 @@ module Google
438
438
  # @return [::String,nil]
439
439
  # @!attribute [rw] credentials
440
440
  # Credentials to send with calls. You may provide any of the following types:
441
- # * (`String`) The path to a service account key file in JSON format
442
- # * (`Hash`) A service account key as a Hash
443
441
  # * (`Google::Auth::Credentials`) A googleauth credentials object
444
442
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
445
443
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -448,7 +446,26 @@ module Google
448
446
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
449
447
  # * (`nil`) indicating no credentials
450
448
  #
451
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
449
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
450
+ # is deprecated. Providing an unvalidated credential configuration to
451
+ # Google APIs can compromise the security of your systems and data.
452
+ #
453
+ # @example
454
+ #
455
+ # # The recommended way to provide credentials is to use the `make_creds` method
456
+ # # on the appropriate credentials class for your environment.
457
+ #
458
+ # require "googleauth"
459
+ #
460
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
461
+ # json_key_io: ::File.open("/path/to/keyfile.json")
462
+ # )
463
+ #
464
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::RecommendationService::Client.new do |config|
465
+ # config.credentials = credentials
466
+ # end
467
+ #
468
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
452
469
  # external source for authentication to Google Cloud, you must validate it before
453
470
  # providing it to a Google API client library. Providing an unvalidated credential
454
471
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -882,8 +882,6 @@ module Google
882
882
  # @return [::String,nil]
883
883
  # @!attribute [rw] credentials
884
884
  # Credentials to send with calls. You may provide any of the following types:
885
- # * (`String`) The path to a service account key file in JSON format
886
- # * (`Hash`) A service account key as a Hash
887
885
  # * (`Google::Auth::Credentials`) A googleauth credentials object
888
886
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
889
887
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -892,7 +890,26 @@ module Google
892
890
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
893
891
  # * (`nil`) indicating no credentials
894
892
  #
895
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
893
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
894
+ # is deprecated. Providing an unvalidated credential configuration to
895
+ # Google APIs can compromise the security of your systems and data.
896
+ #
897
+ # @example
898
+ #
899
+ # # The recommended way to provide credentials is to use the `make_creds` method
900
+ # # on the appropriate credentials class for your environment.
901
+ #
902
+ # require "googleauth"
903
+ #
904
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
905
+ # json_key_io: ::File.open("/path/to/keyfile.json")
906
+ # )
907
+ #
908
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client.new do |config|
909
+ # config.credentials = credentials
910
+ # end
911
+ #
912
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
896
913
  # external source for authentication to Google Cloud, you must validate it before
897
914
  # providing it to a Google API client library. Providing an unvalidated credential
898
915
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -134,7 +134,7 @@ module Google
134
134
  # @param options [::Gapic::CallOptions, ::Hash]
135
135
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
136
136
  #
137
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
137
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
138
138
  # Pass arguments to `list_operations` via keyword arguments. Note that at
139
139
  # least one keyword argument is required. To specify no parameters, or to keep all
140
140
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -147,6 +147,17 @@ module Google
147
147
  # The standard list page size.
148
148
  # @param page_token [::String]
149
149
  # The standard list page token.
150
+ # @param return_partial_success [::Boolean]
151
+ # When set to `true`, operations that are reachable are returned as normal,
152
+ # and those that are unreachable are returned in the
153
+ # [ListOperationsResponse.unreachable] field.
154
+ #
155
+ # This can only be `true` when reading across collections e.g. when `parent`
156
+ # is set to `"projects/example/locations/-"`.
157
+ #
158
+ # This field is not by default supported and will result in an
159
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
160
+ # service or product specific documentation.
150
161
  #
151
162
  # @yield [response, operation] Access the result along with the RPC operation
152
163
  # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]
@@ -631,8 +642,6 @@ module Google
631
642
  # @return [::String,nil]
632
643
  # @!attribute [rw] credentials
633
644
  # Credentials to send with calls. You may provide any of the following types:
634
- # * (`String`) The path to a service account key file in JSON format
635
- # * (`Hash`) A service account key as a Hash
636
645
  # * (`Google::Auth::Credentials`) A googleauth credentials object
637
646
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
638
647
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -641,7 +650,26 @@ module Google
641
650
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
642
651
  # * (`nil`) indicating no credentials
643
652
  #
644
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
653
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
654
+ # is deprecated. Providing an unvalidated credential configuration to
655
+ # Google APIs can compromise the security of your systems and data.
656
+ #
657
+ # @example
658
+ #
659
+ # # The recommended way to provide credentials is to use the `make_creds` method
660
+ # # on the appropriate credentials class for your environment.
661
+ #
662
+ # require "googleauth"
663
+ #
664
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
665
+ # json_key_io: ::File.open("/path/to/keyfile.json")
666
+ # )
667
+ #
668
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
669
+ # config.credentials = credentials
670
+ # end
671
+ #
672
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
645
673
  # external source for authentication to Google Cloud, you must validate it before
646
674
  # providing it to a Google API client library. Providing an unvalidated credential
647
675
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -125,7 +125,7 @@ module Google
125
125
  # @param options [::Gapic::CallOptions, ::Hash]
126
126
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
127
127
  #
128
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
128
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
129
129
  # Pass arguments to `list_operations` via keyword arguments. Note that at
130
130
  # least one keyword argument is required. To specify no parameters, or to keep all
131
131
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -138,6 +138,17 @@ module Google
138
138
  # The standard list page size.
139
139
  # @param page_token [::String]
140
140
  # The standard list page token.
141
+ # @param return_partial_success [::Boolean]
142
+ # When set to `true`, operations that are reachable are returned as normal,
143
+ # and those that are unreachable are returned in the
144
+ # [ListOperationsResponse.unreachable] field.
145
+ #
146
+ # This can only be `true` when reading across collections e.g. when `parent`
147
+ # is set to `"projects/example/locations/-"`.
148
+ #
149
+ # This field is not by default supported and will result in an
150
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
151
+ # service or product specific documentation.
141
152
  # @yield [result, operation] Access the result along with the TransportOperation object
142
153
  # @yieldparam result [::Gapic::Operation]
143
154
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -759,8 +759,6 @@ module Google
759
759
  # @return [::String,nil]
760
760
  # @!attribute [rw] credentials
761
761
  # Credentials to send with calls. You may provide any of the following types:
762
- # * (`String`) The path to a service account key file in JSON format
763
- # * (`Hash`) A service account key as a Hash
764
762
  # * (`Google::Auth::Credentials`) A googleauth credentials object
765
763
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
766
764
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -769,7 +767,26 @@ module Google
769
767
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
770
768
  # * (`nil`) indicating no credentials
771
769
  #
772
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
770
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
771
+ # is deprecated. Providing an unvalidated credential configuration to
772
+ # Google APIs can compromise the security of your systems and data.
773
+ #
774
+ # @example
775
+ #
776
+ # # The recommended way to provide credentials is to use the `make_creds` method
777
+ # # on the appropriate credentials class for your environment.
778
+ #
779
+ # require "googleauth"
780
+ #
781
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
782
+ # json_key_io: ::File.open("/path/to/keyfile.json")
783
+ # )
784
+ #
785
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client.new do |config|
786
+ # config.credentials = credentials
787
+ # end
788
+ #
789
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
773
790
  # external source for authentication to Google Cloud, you must validate it before
774
791
  # providing it to a Google API client library. Providing an unvalidated credential
775
792
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -749,8 +749,6 @@ module Google
749
749
  # @return [::String,nil]
750
750
  # @!attribute [rw] credentials
751
751
  # Credentials to send with calls. You may provide any of the following types:
752
- # * (`String`) The path to a service account key file in JSON format
753
- # * (`Hash`) A service account key as a Hash
754
752
  # * (`Google::Auth::Credentials`) A googleauth credentials object
755
753
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
756
754
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -759,7 +757,26 @@ module Google
759
757
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
760
758
  # * (`nil`) indicating no credentials
761
759
  #
762
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
760
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
761
+ # is deprecated. Providing an unvalidated credential configuration to
762
+ # Google APIs can compromise the security of your systems and data.
763
+ #
764
+ # @example
765
+ #
766
+ # # The recommended way to provide credentials is to use the `make_creds` method
767
+ # # on the appropriate credentials class for your environment.
768
+ #
769
+ # require "googleauth"
770
+ #
771
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
772
+ # json_key_io: ::File.open("/path/to/keyfile.json")
773
+ # )
774
+ #
775
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::SchemaService::Client.new do |config|
776
+ # config.credentials = credentials
777
+ # end
778
+ #
779
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
763
780
  # external source for authentication to Google Cloud, you must validate it before
764
781
  # providing it to a Google API client library. Providing an unvalidated credential
765
782
  # configuration to Google APIs can compromise the security of your systems and data.