google-cloud-retail-v2 2.6.0 → 2.6.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1ac2decb1c24da07bdafe5ee1b9c8f3e62c3431430ad90dd1e6609212daacab2
4
- data.tar.gz: a93c25b183b0e99c295f8aa9aabab3a6771c76ce44174d767e9454d54a04e372
3
+ metadata.gz: d65c2c7cd673bb7bb9570d4d1a57b8d40133ba2bfdc0166a8a42e0e58489099c
4
+ data.tar.gz: fc99d101fb070ad00e60bb0a8bc3b2054cb6d184bbebb8ee4de4acb376997b1d
5
5
  SHA512:
6
- metadata.gz: 9034c528b7113199285ae678dd6fe9e162bae3a2f807bf08ab544f682fe233f725e7979dfa03547c905ffcf95ccf1c433de36fde448c7ffffe5e720064eef386
7
- data.tar.gz: a81f1bfeef43e63c9070c7b92e021a756766219c787bed08d47f29a1648c1d45c9674187a36869c855ec667c0f697f1e1323eb0fa25a39b42cbc26f2960e3b7b
6
+ metadata.gz: f4b2d19c94567667f4ea0e9cc424246c01980cf3ed4d3efa2db592c982bef08307e231133b29950e2ff5ef4bb7ced2ffea3d9eac40a30711e84076e8d88e33a2
7
+ data.tar.gz: aa6d5830fb94a317a348d30486d0157a0a7e64d1a9c29fbbb0be7310d397085937867ae25bf4dd02cbc8d569f8e0737cd69c0403212dd7191be1291f6db9f5e8
@@ -370,8 +370,6 @@ module Google
370
370
  # @return [::String,nil]
371
371
  # @!attribute [rw] credentials
372
372
  # Credentials to send with calls. You may provide any of the following types:
373
- # * (`String`) The path to a service account key file in JSON format
374
- # * (`Hash`) A service account key as a Hash
375
373
  # * (`Google::Auth::Credentials`) A googleauth credentials object
376
374
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
377
375
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -380,7 +378,26 @@ module Google
380
378
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
381
379
  # * (`nil`) indicating no credentials
382
380
  #
383
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
381
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
382
+ # is deprecated. Providing an unvalidated credential configuration to
383
+ # Google APIs can compromise the security of your systems and data.
384
+ #
385
+ # @example
386
+ #
387
+ # # The recommended way to provide credentials is to use the `make_creds` method
388
+ # # on the appropriate credentials class for your environment.
389
+ #
390
+ # require "googleauth"
391
+ #
392
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
393
+ # json_key_io: ::File.open("/path/to/keyfile.json")
394
+ # )
395
+ #
396
+ # client = ::Google::Cloud::Retail::V2::AnalyticsService::Client.new do |config|
397
+ # config.credentials = credentials
398
+ # end
399
+ #
400
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
384
401
  # external source for authentication to Google Cloud, you must validate it before
385
402
  # providing it to a Google API client library. Providing an unvalidated credential
386
403
  # 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.
@@ -1347,8 +1347,6 @@ module Google
1347
1347
  # @return [::String,nil]
1348
1348
  # @!attribute [rw] credentials
1349
1349
  # Credentials to send with calls. You may provide any of the following types:
1350
- # * (`String`) The path to a service account key file in JSON format
1351
- # * (`Hash`) A service account key as a Hash
1352
1350
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1353
1351
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1354
1352
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -1357,7 +1355,26 @@ module Google
1357
1355
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1358
1356
  # * (`nil`) indicating no credentials
1359
1357
  #
1360
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
1358
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
1359
+ # is deprecated. Providing an unvalidated credential configuration to
1360
+ # Google APIs can compromise the security of your systems and data.
1361
+ #
1362
+ # @example
1363
+ #
1364
+ # # The recommended way to provide credentials is to use the `make_creds` method
1365
+ # # on the appropriate credentials class for your environment.
1366
+ #
1367
+ # require "googleauth"
1368
+ #
1369
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
1370
+ # json_key_io: ::File.open("/path/to/keyfile.json")
1371
+ # )
1372
+ #
1373
+ # client = ::Google::Cloud::Retail::V2::CatalogService::Client.new do |config|
1374
+ # config.credentials = credentials
1375
+ # end
1376
+ #
1377
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
1361
1378
  # external source for authentication to Google Cloud, you must validate it before
1362
1379
  # providing it to a Google API client library. Providing an unvalidated credential
1363
1380
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -536,8 +536,6 @@ module Google
536
536
  # @return [::String,nil]
537
537
  # @!attribute [rw] credentials
538
538
  # Credentials to send with calls. You may provide any of the following types:
539
- # * (`String`) The path to a service account key file in JSON format
540
- # * (`Hash`) A service account key as a Hash
541
539
  # * (`Google::Auth::Credentials`) A googleauth credentials object
542
540
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
543
541
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -546,7 +544,26 @@ module Google
546
544
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
547
545
  # * (`nil`) indicating no credentials
548
546
  #
549
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
547
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
548
+ # is deprecated. Providing an unvalidated credential configuration to
549
+ # Google APIs can compromise the security of your systems and data.
550
+ #
551
+ # @example
552
+ #
553
+ # # The recommended way to provide credentials is to use the `make_creds` method
554
+ # # on the appropriate credentials class for your environment.
555
+ #
556
+ # require "googleauth"
557
+ #
558
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
559
+ # json_key_io: ::File.open("/path/to/keyfile.json")
560
+ # )
561
+ #
562
+ # client = ::Google::Cloud::Retail::V2::CompletionService::Client.new do |config|
563
+ # config.credentials = credentials
564
+ # end
565
+ #
566
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
550
567
  # external source for authentication to Google Cloud, you must validate it before
551
568
  # providing it to a Google API client library. Providing an unvalidated credential
552
569
  # 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.
@@ -710,8 +710,6 @@ module Google
710
710
  # @return [::String,nil]
711
711
  # @!attribute [rw] credentials
712
712
  # Credentials to send with calls. You may provide any of the following types:
713
- # * (`String`) The path to a service account key file in JSON format
714
- # * (`Hash`) A service account key as a Hash
715
713
  # * (`Google::Auth::Credentials`) A googleauth credentials object
716
714
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
717
715
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -720,7 +718,26 @@ module Google
720
718
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
721
719
  # * (`nil`) indicating no credentials
722
720
  #
723
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
721
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
722
+ # is deprecated. Providing an unvalidated credential configuration to
723
+ # Google APIs can compromise the security of your systems and data.
724
+ #
725
+ # @example
726
+ #
727
+ # # The recommended way to provide credentials is to use the `make_creds` method
728
+ # # on the appropriate credentials class for your environment.
729
+ #
730
+ # require "googleauth"
731
+ #
732
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
733
+ # json_key_io: ::File.open("/path/to/keyfile.json")
734
+ # )
735
+ #
736
+ # client = ::Google::Cloud::Retail::V2::ControlService::Client.new do |config|
737
+ # config.credentials = credentials
738
+ # end
739
+ #
740
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
724
741
  # external source for authentication to Google Cloud, you must validate it before
725
742
  # providing it to a Google API client library. Providing an unvalidated credential
726
743
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -403,8 +403,6 @@ module Google
403
403
  # @return [::String,nil]
404
404
  # @!attribute [rw] credentials
405
405
  # Credentials to send with calls. You may provide any of the following types:
406
- # * (`String`) The path to a service account key file in JSON format
407
- # * (`Hash`) A service account key as a Hash
408
406
  # * (`Google::Auth::Credentials`) A googleauth credentials object
409
407
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
410
408
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -413,7 +411,26 @@ module Google
413
411
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
414
412
  # * (`nil`) indicating no credentials
415
413
  #
416
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
414
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
415
+ # is deprecated. Providing an unvalidated credential configuration to
416
+ # Google APIs can compromise the security of your systems and data.
417
+ #
418
+ # @example
419
+ #
420
+ # # The recommended way to provide credentials is to use the `make_creds` method
421
+ # # on the appropriate credentials class for your environment.
422
+ #
423
+ # require "googleauth"
424
+ #
425
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
426
+ # json_key_io: ::File.open("/path/to/keyfile.json")
427
+ # )
428
+ #
429
+ # client = ::Google::Cloud::Retail::V2::ConversationalSearchService::Client.new do |config|
430
+ # config.credentials = credentials
431
+ # end
432
+ #
433
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
417
434
  # external source for authentication to Google Cloud, you must validate it before
418
435
  # providing it to a Google API client library. Providing an unvalidated credential
419
436
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -678,8 +678,6 @@ module Google
678
678
  # @return [::String,nil]
679
679
  # @!attribute [rw] credentials
680
680
  # Credentials to send with calls. You may provide any of the following types:
681
- # * (`String`) The path to a service account key file in JSON format
682
- # * (`Hash`) A service account key as a Hash
683
681
  # * (`Google::Auth::Credentials`) A googleauth credentials object
684
682
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
685
683
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -688,7 +686,26 @@ module Google
688
686
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
689
687
  # * (`nil`) indicating no credentials
690
688
  #
691
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
689
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
690
+ # is deprecated. Providing an unvalidated credential configuration to
691
+ # Google APIs can compromise the security of your systems and data.
692
+ #
693
+ # @example
694
+ #
695
+ # # The recommended way to provide credentials is to use the `make_creds` method
696
+ # # on the appropriate credentials class for your environment.
697
+ #
698
+ # require "googleauth"
699
+ #
700
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
701
+ # json_key_io: ::File.open("/path/to/keyfile.json")
702
+ # )
703
+ #
704
+ # client = ::Google::Cloud::Retail::V2::GenerativeQuestionService::Client.new do |config|
705
+ # config.credentials = credentials
706
+ # end
707
+ #
708
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
692
709
  # external source for authentication to Google Cloud, you must validate it before
693
710
  # providing it to a Google API client library. Providing an unvalidated credential
694
711
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -999,8 +999,6 @@ module Google
999
999
  # @return [::String,nil]
1000
1000
  # @!attribute [rw] credentials
1001
1001
  # Credentials to send with calls. You may provide any of the following types:
1002
- # * (`String`) The path to a service account key file in JSON format
1003
- # * (`Hash`) A service account key as a Hash
1004
1002
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1005
1003
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1006
1004
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -1009,7 +1007,26 @@ module Google
1009
1007
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1010
1008
  # * (`nil`) indicating no credentials
1011
1009
  #
1012
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
1010
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
1011
+ # is deprecated. Providing an unvalidated credential configuration to
1012
+ # Google APIs can compromise the security of your systems and data.
1013
+ #
1014
+ # @example
1015
+ #
1016
+ # # The recommended way to provide credentials is to use the `make_creds` method
1017
+ # # on the appropriate credentials class for your environment.
1018
+ #
1019
+ # require "googleauth"
1020
+ #
1021
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
1022
+ # json_key_io: ::File.open("/path/to/keyfile.json")
1023
+ # )
1024
+ #
1025
+ # client = ::Google::Cloud::Retail::V2::ModelService::Client.new do |config|
1026
+ # config.credentials = credentials
1027
+ # end
1028
+ #
1029
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
1013
1030
  # external source for authentication to Google Cloud, you must validate it before
1014
1031
  # providing it to a Google API client library. Providing an unvalidated credential
1015
1032
  # 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.
@@ -450,8 +450,6 @@ module Google
450
450
  # @return [::String,nil]
451
451
  # @!attribute [rw] credentials
452
452
  # Credentials to send with calls. You may provide any of the following types:
453
- # * (`String`) The path to a service account key file in JSON format
454
- # * (`Hash`) A service account key as a Hash
455
453
  # * (`Google::Auth::Credentials`) A googleauth credentials object
456
454
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
457
455
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -460,7 +458,26 @@ module Google
460
458
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
461
459
  # * (`nil`) indicating no credentials
462
460
  #
463
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
461
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
462
+ # is deprecated. Providing an unvalidated credential configuration to
463
+ # Google APIs can compromise the security of your systems and data.
464
+ #
465
+ # @example
466
+ #
467
+ # # The recommended way to provide credentials is to use the `make_creds` method
468
+ # # on the appropriate credentials class for your environment.
469
+ #
470
+ # require "googleauth"
471
+ #
472
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
473
+ # json_key_io: ::File.open("/path/to/keyfile.json")
474
+ # )
475
+ #
476
+ # client = ::Google::Cloud::Retail::V2::PredictionService::Client.new do |config|
477
+ # config.credentials = credentials
478
+ # end
479
+ #
480
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
464
481
  # external source for authentication to Google Cloud, you must validate it before
465
482
  # providing it to a Google API client library. Providing an unvalidated credential
466
483
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -1989,8 +1989,6 @@ module Google
1989
1989
  # @return [::String,nil]
1990
1990
  # @!attribute [rw] credentials
1991
1991
  # Credentials to send with calls. You may provide any of the following types:
1992
- # * (`String`) The path to a service account key file in JSON format
1993
- # * (`Hash`) A service account key as a Hash
1994
1992
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1995
1993
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1996
1994
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -1999,7 +1997,26 @@ module Google
1999
1997
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
2000
1998
  # * (`nil`) indicating no credentials
2001
1999
  #
2002
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
2000
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
2001
+ # is deprecated. Providing an unvalidated credential configuration to
2002
+ # Google APIs can compromise the security of your systems and data.
2003
+ #
2004
+ # @example
2005
+ #
2006
+ # # The recommended way to provide credentials is to use the `make_creds` method
2007
+ # # on the appropriate credentials class for your environment.
2008
+ #
2009
+ # require "googleauth"
2010
+ #
2011
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
2012
+ # json_key_io: ::File.open("/path/to/keyfile.json")
2013
+ # )
2014
+ #
2015
+ # client = ::Google::Cloud::Retail::V2::ProductService::Client.new do |config|
2016
+ # config.credentials = credentials
2017
+ # end
2018
+ #
2019
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
2003
2020
  # external source for authentication to Google Cloud, you must validate it before
2004
2021
  # providing it to a Google API client library. Providing an unvalidated credential
2005
2022
  # 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.
@@ -616,8 +616,6 @@ module Google
616
616
  # @return [::String,nil]
617
617
  # @!attribute [rw] credentials
618
618
  # Credentials to send with calls. You may provide any of the following types:
619
- # * (`String`) The path to a service account key file in JSON format
620
- # * (`Hash`) A service account key as a Hash
621
619
  # * (`Google::Auth::Credentials`) A googleauth credentials object
622
620
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
623
621
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -626,7 +624,26 @@ module Google
626
624
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
627
625
  # * (`nil`) indicating no credentials
628
626
  #
629
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
627
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
628
+ # is deprecated. Providing an unvalidated credential configuration to
629
+ # Google APIs can compromise the security of your systems and data.
630
+ #
631
+ # @example
632
+ #
633
+ # # The recommended way to provide credentials is to use the `make_creds` method
634
+ # # on the appropriate credentials class for your environment.
635
+ #
636
+ # require "googleauth"
637
+ #
638
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
639
+ # json_key_io: ::File.open("/path/to/keyfile.json")
640
+ # )
641
+ #
642
+ # client = ::Google::Cloud::Retail::V2::SearchService::Client.new do |config|
643
+ # config.credentials = credentials
644
+ # end
645
+ #
646
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
630
647
  # external source for authentication to Google Cloud, you must validate it before
631
648
  # providing it to a Google API client library. Providing an unvalidated credential
632
649
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -887,8 +887,6 @@ module Google
887
887
  # @return [::String,nil]
888
888
  # @!attribute [rw] credentials
889
889
  # Credentials to send with calls. You may provide any of the following types:
890
- # * (`String`) The path to a service account key file in JSON format
891
- # * (`Hash`) A service account key as a Hash
892
890
  # * (`Google::Auth::Credentials`) A googleauth credentials object
893
891
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
894
892
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -897,7 +895,26 @@ module Google
897
895
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
898
896
  # * (`nil`) indicating no credentials
899
897
  #
900
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
898
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
899
+ # is deprecated. Providing an unvalidated credential configuration to
900
+ # Google APIs can compromise the security of your systems and data.
901
+ #
902
+ # @example
903
+ #
904
+ # # The recommended way to provide credentials is to use the `make_creds` method
905
+ # # on the appropriate credentials class for your environment.
906
+ #
907
+ # require "googleauth"
908
+ #
909
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
910
+ # json_key_io: ::File.open("/path/to/keyfile.json")
911
+ # )
912
+ #
913
+ # client = ::Google::Cloud::Retail::V2::ServingConfigService::Client.new do |config|
914
+ # config.credentials = credentials
915
+ # end
916
+ #
917
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
901
918
  # external source for authentication to Google Cloud, you must validate it before
902
919
  # providing it to a Google API client library. Providing an unvalidated credential
903
920
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -807,8 +807,6 @@ module Google
807
807
  # @return [::String,nil]
808
808
  # @!attribute [rw] credentials
809
809
  # Credentials to send with calls. You may provide any of the following types:
810
- # * (`String`) The path to a service account key file in JSON format
811
- # * (`Hash`) A service account key as a Hash
812
810
  # * (`Google::Auth::Credentials`) A googleauth credentials object
813
811
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
814
812
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -817,7 +815,26 @@ module Google
817
815
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
818
816
  # * (`nil`) indicating no credentials
819
817
  #
820
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
818
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
819
+ # is deprecated. Providing an unvalidated credential configuration to
820
+ # Google APIs can compromise the security of your systems and data.
821
+ #
822
+ # @example
823
+ #
824
+ # # The recommended way to provide credentials is to use the `make_creds` method
825
+ # # on the appropriate credentials class for your environment.
826
+ #
827
+ # require "googleauth"
828
+ #
829
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
830
+ # json_key_io: ::File.open("/path/to/keyfile.json")
831
+ # )
832
+ #
833
+ # client = ::Google::Cloud::Retail::V2::UserEventService::Client.new do |config|
834
+ # config.credentials = credentials
835
+ # end
836
+ #
837
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
821
838
  # external source for authentication to Google Cloud, you must validate it before
822
839
  # providing it to a Google API client library. Providing an unvalidated credential
823
840
  # 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.
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Retail
23
23
  module V2
24
- VERSION = "2.6.0"
24
+ VERSION = "2.6.1"
25
25
  end
26
26
  end
27
27
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-retail-v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.6.0
4
+ version: 2.6.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC