google-cloud-discovery_engine-v1 2.6.1 → 2.6.2

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 (36) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1/assistant_service/client.rb +20 -3
  3. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/client.rb +20 -3
  4. data/lib/google/cloud/discovery_engine/v1/cmek_config_service/operations.rb +20 -3
  5. data/lib/google/cloud/discovery_engine/v1/completion_service/client.rb +20 -3
  6. data/lib/google/cloud/discovery_engine/v1/completion_service/operations.rb +20 -3
  7. data/lib/google/cloud/discovery_engine/v1/control_service/client.rb +20 -3
  8. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +20 -3
  9. data/lib/google/cloud/discovery_engine/v1/data_store_service/client.rb +20 -3
  10. data/lib/google/cloud/discovery_engine/v1/data_store_service/operations.rb +20 -3
  11. data/lib/google/cloud/discovery_engine/v1/document_service/client.rb +20 -3
  12. data/lib/google/cloud/discovery_engine/v1/document_service/operations.rb +20 -3
  13. data/lib/google/cloud/discovery_engine/v1/engine_service/client.rb +20 -3
  14. data/lib/google/cloud/discovery_engine/v1/engine_service/operations.rb +20 -3
  15. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/client.rb +20 -3
  16. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/client.rb +20 -3
  17. data/lib/google/cloud/discovery_engine/v1/identity_mapping_store_service/operations.rb +20 -3
  18. data/lib/google/cloud/discovery_engine/v1/project_service/client.rb +20 -3
  19. data/lib/google/cloud/discovery_engine/v1/project_service/operations.rb +20 -3
  20. data/lib/google/cloud/discovery_engine/v1/rank_service/client.rb +20 -3
  21. data/lib/google/cloud/discovery_engine/v1/recommendation_service/client.rb +20 -3
  22. data/lib/google/cloud/discovery_engine/v1/schema_service/client.rb +20 -3
  23. data/lib/google/cloud/discovery_engine/v1/schema_service/operations.rb +20 -3
  24. data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +20 -3
  25. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/client.rb +20 -3
  26. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/operations.rb +20 -3
  27. data/lib/google/cloud/discovery_engine/v1/serving_config_service/client.rb +20 -3
  28. data/lib/google/cloud/discovery_engine/v1/session_service/client.rb +20 -3
  29. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb +20 -3
  30. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/operations.rb +20 -3
  31. data/lib/google/cloud/discovery_engine/v1/user_event_service/client.rb +20 -3
  32. data/lib/google/cloud/discovery_engine/v1/user_event_service/operations.rb +20 -3
  33. data/lib/google/cloud/discovery_engine/v1/user_license_service/client.rb +20 -3
  34. data/lib/google/cloud/discovery_engine/v1/user_license_service/operations.rb +20 -3
  35. data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
  36. metadata +1 -1
@@ -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::V1::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.
@@ -642,8 +642,6 @@ module Google
642
642
  # @return [::String,nil]
643
643
  # @!attribute [rw] credentials
644
644
  # Credentials to send with calls. You may provide any of the following types:
645
- # * (`String`) The path to a service account key file in JSON format
646
- # * (`Hash`) A service account key as a Hash
647
645
  # * (`Google::Auth::Credentials`) A googleauth credentials object
648
646
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
649
647
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -652,7 +650,26 @@ module Google
652
650
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
653
651
  # * (`nil`) indicating no credentials
654
652
  #
655
- # 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
656
673
  # external source for authentication to Google Cloud, you must validate it before
657
674
  # providing it to a Google API client library. Providing an unvalidated credential
658
675
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -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::V1::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::V1::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.
@@ -746,8 +746,6 @@ module Google
746
746
  # @return [::String,nil]
747
747
  # @!attribute [rw] credentials
748
748
  # Credentials to send with calls. You may provide any of the following types:
749
- # * (`String`) The path to a service account key file in JSON format
750
- # * (`Hash`) A service account key as a Hash
751
749
  # * (`Google::Auth::Credentials`) A googleauth credentials object
752
750
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
753
751
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -756,7 +754,26 @@ module Google
756
754
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
757
755
  # * (`nil`) indicating no credentials
758
756
  #
759
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
757
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
758
+ # is deprecated. Providing an unvalidated credential configuration to
759
+ # Google APIs can compromise the security of your systems and data.
760
+ #
761
+ # @example
762
+ #
763
+ # # The recommended way to provide credentials is to use the `make_creds` method
764
+ # # on the appropriate credentials class for your environment.
765
+ #
766
+ # require "googleauth"
767
+ #
768
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
769
+ # json_key_io: ::File.open("/path/to/keyfile.json")
770
+ # )
771
+ #
772
+ # client = ::Google::Cloud::DiscoveryEngine::V1::SchemaService::Client.new do |config|
773
+ # config.credentials = credentials
774
+ # end
775
+ #
776
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
760
777
  # external source for authentication to Google Cloud, you must validate it before
761
778
  # providing it to a Google API client library. Providing an unvalidated credential
762
779
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -642,8 +642,6 @@ module Google
642
642
  # @return [::String,nil]
643
643
  # @!attribute [rw] credentials
644
644
  # Credentials to send with calls. You may provide any of the following types:
645
- # * (`String`) The path to a service account key file in JSON format
646
- # * (`Hash`) A service account key as a Hash
647
645
  # * (`Google::Auth::Credentials`) A googleauth credentials object
648
646
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
649
647
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -652,7 +650,26 @@ module Google
652
650
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
653
651
  # * (`nil`) indicating no credentials
654
652
  #
655
- # 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
656
673
  # external source for authentication to Google Cloud, you must validate it before
657
674
  # providing it to a Google API client library. Providing an unvalidated credential
658
675
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -1057,8 +1057,6 @@ module Google
1057
1057
  # @return [::String,nil]
1058
1058
  # @!attribute [rw] credentials
1059
1059
  # Credentials to send with calls. You may provide any of the following types:
1060
- # * (`String`) The path to a service account key file in JSON format
1061
- # * (`Hash`) A service account key as a Hash
1062
1060
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1063
1061
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1064
1062
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -1067,7 +1065,26 @@ module Google
1067
1065
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1068
1066
  # * (`nil`) indicating no credentials
1069
1067
  #
1070
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
1068
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
1069
+ # is deprecated. Providing an unvalidated credential configuration to
1070
+ # Google APIs can compromise the security of your systems and data.
1071
+ #
1072
+ # @example
1073
+ #
1074
+ # # The recommended way to provide credentials is to use the `make_creds` method
1075
+ # # on the appropriate credentials class for your environment.
1076
+ #
1077
+ # require "googleauth"
1078
+ #
1079
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
1080
+ # json_key_io: ::File.open("/path/to/keyfile.json")
1081
+ # )
1082
+ #
1083
+ # client = ::Google::Cloud::DiscoveryEngine::V1::SearchService::Client.new do |config|
1084
+ # config.credentials = credentials
1085
+ # end
1086
+ #
1087
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
1071
1088
  # external source for authentication to Google Cloud, you must validate it before
1072
1089
  # providing it to a Google API client library. Providing an unvalidated credential
1073
1090
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -443,8 +443,6 @@ module Google
443
443
  # @return [::String,nil]
444
444
  # @!attribute [rw] credentials
445
445
  # Credentials to send with calls. You may provide any of the following types:
446
- # * (`String`) The path to a service account key file in JSON format
447
- # * (`Hash`) A service account key as a Hash
448
446
  # * (`Google::Auth::Credentials`) A googleauth credentials object
449
447
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
450
448
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -453,7 +451,26 @@ module Google
453
451
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
454
452
  # * (`nil`) indicating no credentials
455
453
  #
456
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
454
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
455
+ # is deprecated. Providing an unvalidated credential configuration to
456
+ # Google APIs can compromise the security of your systems and data.
457
+ #
458
+ # @example
459
+ #
460
+ # # The recommended way to provide credentials is to use the `make_creds` method
461
+ # # on the appropriate credentials class for your environment.
462
+ #
463
+ # require "googleauth"
464
+ #
465
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
466
+ # json_key_io: ::File.open("/path/to/keyfile.json")
467
+ # )
468
+ #
469
+ # client = ::Google::Cloud::DiscoveryEngine::V1::SearchTuningService::Client.new do |config|
470
+ # config.credentials = credentials
471
+ # end
472
+ #
473
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
457
474
  # external source for authentication to Google Cloud, you must validate it before
458
475
  # providing it to a Google API client library. Providing an unvalidated credential
459
476
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -642,8 +642,6 @@ module Google
642
642
  # @return [::String,nil]
643
643
  # @!attribute [rw] credentials
644
644
  # Credentials to send with calls. You may provide any of the following types:
645
- # * (`String`) The path to a service account key file in JSON format
646
- # * (`Hash`) A service account key as a Hash
647
645
  # * (`Google::Auth::Credentials`) A googleauth credentials object
648
646
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
649
647
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -652,7 +650,26 @@ module Google
652
650
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
653
651
  # * (`nil`) indicating no credentials
654
652
  #
655
- # 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
656
673
  # external source for authentication to Google Cloud, you must validate it before
657
674
  # providing it to a Google API client library. Providing an unvalidated credential
658
675
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -330,8 +330,6 @@ module Google
330
330
  # @return [::String,nil]
331
331
  # @!attribute [rw] credentials
332
332
  # Credentials to send with calls. You may provide any of the following types:
333
- # * (`String`) The path to a service account key file in JSON format
334
- # * (`Hash`) A service account key as a Hash
335
333
  # * (`Google::Auth::Credentials`) A googleauth credentials object
336
334
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
337
335
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -340,7 +338,26 @@ module Google
340
338
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
341
339
  # * (`nil`) indicating no credentials
342
340
  #
343
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
341
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
342
+ # is deprecated. Providing an unvalidated credential configuration to
343
+ # Google APIs can compromise the security of your systems and data.
344
+ #
345
+ # @example
346
+ #
347
+ # # The recommended way to provide credentials is to use the `make_creds` method
348
+ # # on the appropriate credentials class for your environment.
349
+ #
350
+ # require "googleauth"
351
+ #
352
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
353
+ # json_key_io: ::File.open("/path/to/keyfile.json")
354
+ # )
355
+ #
356
+ # client = ::Google::Cloud::DiscoveryEngine::V1::ServingConfigService::Client.new do |config|
357
+ # config.credentials = credentials
358
+ # end
359
+ #
360
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
344
361
  # external source for authentication to Google Cloud, you must validate it before
345
362
  # providing it to a Google API client library. Providing an unvalidated credential
346
363
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -738,8 +738,6 @@ module Google
738
738
  # @return [::String,nil]
739
739
  # @!attribute [rw] credentials
740
740
  # Credentials to send with calls. You may provide any of the following types:
741
- # * (`String`) The path to a service account key file in JSON format
742
- # * (`Hash`) A service account key as a Hash
743
741
  # * (`Google::Auth::Credentials`) A googleauth credentials object
744
742
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
745
743
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -748,7 +746,26 @@ module Google
748
746
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
749
747
  # * (`nil`) indicating no credentials
750
748
  #
751
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
749
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
750
+ # is deprecated. Providing an unvalidated credential configuration to
751
+ # Google APIs can compromise the security of your systems and data.
752
+ #
753
+ # @example
754
+ #
755
+ # # The recommended way to provide credentials is to use the `make_creds` method
756
+ # # on the appropriate credentials class for your environment.
757
+ #
758
+ # require "googleauth"
759
+ #
760
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
761
+ # json_key_io: ::File.open("/path/to/keyfile.json")
762
+ # )
763
+ #
764
+ # client = ::Google::Cloud::DiscoveryEngine::V1::SessionService::Client.new do |config|
765
+ # config.credentials = credentials
766
+ # end
767
+ #
768
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
752
769
  # external source for authentication to Google Cloud, you must validate it before
753
770
  # providing it to a Google API client library. Providing an unvalidated credential
754
771
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -1743,8 +1743,6 @@ module Google
1743
1743
  # @return [::String,nil]
1744
1744
  # @!attribute [rw] credentials
1745
1745
  # Credentials to send with calls. You may provide any of the following types:
1746
- # * (`String`) The path to a service account key file in JSON format
1747
- # * (`Hash`) A service account key as a Hash
1748
1746
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1749
1747
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1750
1748
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -1753,7 +1751,26 @@ module Google
1753
1751
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1754
1752
  # * (`nil`) indicating no credentials
1755
1753
  #
1756
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
1754
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
1755
+ # is deprecated. Providing an unvalidated credential configuration to
1756
+ # Google APIs can compromise the security of your systems and data.
1757
+ #
1758
+ # @example
1759
+ #
1760
+ # # The recommended way to provide credentials is to use the `make_creds` method
1761
+ # # on the appropriate credentials class for your environment.
1762
+ #
1763
+ # require "googleauth"
1764
+ #
1765
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
1766
+ # json_key_io: ::File.open("/path/to/keyfile.json")
1767
+ # )
1768
+ #
1769
+ # client = ::Google::Cloud::DiscoveryEngine::V1::SiteSearchEngineService::Client.new do |config|
1770
+ # config.credentials = credentials
1771
+ # end
1772
+ #
1773
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
1757
1774
  # external source for authentication to Google Cloud, you must validate it before
1758
1775
  # providing it to a Google API client library. Providing an unvalidated credential
1759
1776
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -642,8 +642,6 @@ module Google
642
642
  # @return [::String,nil]
643
643
  # @!attribute [rw] credentials
644
644
  # Credentials to send with calls. You may provide any of the following types:
645
- # * (`String`) The path to a service account key file in JSON format
646
- # * (`Hash`) A service account key as a Hash
647
645
  # * (`Google::Auth::Credentials`) A googleauth credentials object
648
646
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
649
647
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -652,7 +650,26 @@ module Google
652
650
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
653
651
  # * (`nil`) indicating no credentials
654
652
  #
655
- # 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
656
673
  # external source for authentication to Google Cloud, you must validate it before
657
674
  # providing it to a Google API client library. Providing an unvalidated credential
658
675
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -719,8 +719,6 @@ module Google
719
719
  # @return [::String,nil]
720
720
  # @!attribute [rw] credentials
721
721
  # Credentials to send with calls. You may provide any of the following types:
722
- # * (`String`) The path to a service account key file in JSON format
723
- # * (`Hash`) A service account key as a Hash
724
722
  # * (`Google::Auth::Credentials`) A googleauth credentials object
725
723
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
726
724
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -729,7 +727,26 @@ module Google
729
727
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
730
728
  # * (`nil`) indicating no credentials
731
729
  #
732
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
730
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
731
+ # is deprecated. Providing an unvalidated credential configuration to
732
+ # Google APIs can compromise the security of your systems and data.
733
+ #
734
+ # @example
735
+ #
736
+ # # The recommended way to provide credentials is to use the `make_creds` method
737
+ # # on the appropriate credentials class for your environment.
738
+ #
739
+ # require "googleauth"
740
+ #
741
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
742
+ # json_key_io: ::File.open("/path/to/keyfile.json")
743
+ # )
744
+ #
745
+ # client = ::Google::Cloud::DiscoveryEngine::V1::UserEventService::Client.new do |config|
746
+ # config.credentials = credentials
747
+ # end
748
+ #
749
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
733
750
  # external source for authentication to Google Cloud, you must validate it before
734
751
  # providing it to a Google API client library. Providing an unvalidated credential
735
752
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -642,8 +642,6 @@ module Google
642
642
  # @return [::String,nil]
643
643
  # @!attribute [rw] credentials
644
644
  # Credentials to send with calls. You may provide any of the following types:
645
- # * (`String`) The path to a service account key file in JSON format
646
- # * (`Hash`) A service account key as a Hash
647
645
  # * (`Google::Auth::Credentials`) A googleauth credentials object
648
646
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
649
647
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -652,7 +650,26 @@ module Google
652
650
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
653
651
  # * (`nil`) indicating no credentials
654
652
  #
655
- # 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
656
673
  # external source for authentication to Google Cloud, you must validate it before
657
674
  # providing it to a Google API client library. Providing an unvalidated credential
658
675
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -469,8 +469,6 @@ module Google
469
469
  # @return [::String,nil]
470
470
  # @!attribute [rw] credentials
471
471
  # Credentials to send with calls. You may provide any of the following types:
472
- # * (`String`) The path to a service account key file in JSON format
473
- # * (`Hash`) A service account key as a Hash
474
472
  # * (`Google::Auth::Credentials`) A googleauth credentials object
475
473
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
476
474
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -479,7 +477,26 @@ module Google
479
477
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
480
478
  # * (`nil`) indicating no credentials
481
479
  #
482
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
480
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
481
+ # is deprecated. Providing an unvalidated credential configuration to
482
+ # Google APIs can compromise the security of your systems and data.
483
+ #
484
+ # @example
485
+ #
486
+ # # The recommended way to provide credentials is to use the `make_creds` method
487
+ # # on the appropriate credentials class for your environment.
488
+ #
489
+ # require "googleauth"
490
+ #
491
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
492
+ # json_key_io: ::File.open("/path/to/keyfile.json")
493
+ # )
494
+ #
495
+ # client = ::Google::Cloud::DiscoveryEngine::V1::UserLicenseService::Client.new do |config|
496
+ # config.credentials = credentials
497
+ # end
498
+ #
499
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
483
500
  # external source for authentication to Google Cloud, you must validate it before
484
501
  # providing it to a Google API client library. Providing an unvalidated credential
485
502
  # configuration to Google APIs can compromise the security of your systems and data.