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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 78e275b33576c302ab8e440d1c9163966b8d2fc2161ed9ad7c0dd7713d0f646d
4
- data.tar.gz: 1c667b21e7349f66746ff44468c0dc048970d4992d0744b767ca76d8567109b6
3
+ metadata.gz: bfde689308455d5d15f75b8dd68a9ff39e527f3aa1b4d015100769708fbf98af
4
+ data.tar.gz: 3e356a32384bc846acf988588e29f22d0af5bb06d76e5da7bf76ac1a470fdc5e
5
5
  SHA512:
6
- metadata.gz: 17395001fae5b28121556691832d9ef5be24ab74cd05d6c8bf9a7f81699b2c360f37f6eb2975b340bb68622fea5d40be0dbef145641ea15ab9e5b38168f6d219
7
- data.tar.gz: 9ad1d72c052d58339762023545c6b5731ea5f47a400b58ac4742dc57736403b1e0f081a6638267dc020ba44d4ba2078f4662966435fee46a014ee61d74d9cbb9
6
+ metadata.gz: a8fce17645b17143b278e7b89355ce4a89f39147da9bbd9303e5dd9ff58758a848eadd8b528b0f227bdda221565e870bde6d25f900d28c241f9c727631810322
7
+ data.tar.gz: dfc4e434ccd601f93f122bb17f18e9cb9dc11ac2de1bd3decd719280d073be92fc9fc03a46dc591a5314f2b03a6a7213e111a05a4a695ffe94fb9156f4aa2b4c
@@ -948,8 +948,6 @@ module Google
948
948
  # @return [::String,nil]
949
949
  # @!attribute [rw] credentials
950
950
  # Credentials to send with calls. You may provide any of the following types:
951
- # * (`String`) The path to a service account key file in JSON format
952
- # * (`Hash`) A service account key as a Hash
953
951
  # * (`Google::Auth::Credentials`) A googleauth credentials object
954
952
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
955
953
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -958,7 +956,26 @@ module Google
958
956
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
959
957
  # * (`nil`) indicating no credentials
960
958
  #
961
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
959
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
960
+ # is deprecated. Providing an unvalidated credential configuration to
961
+ # Google APIs can compromise the security of your systems and data.
962
+ #
963
+ # @example
964
+ #
965
+ # # The recommended way to provide credentials is to use the `make_creds` method
966
+ # # on the appropriate credentials class for your environment.
967
+ #
968
+ # require "googleauth"
969
+ #
970
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
971
+ # json_key_io: ::File.open("/path/to/keyfile.json")
972
+ # )
973
+ #
974
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::CompletionService::Client.new do |config|
975
+ # config.credentials = credentials
976
+ # end
977
+ #
978
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
962
979
  # external source for authentication to Google Cloud, you must validate it before
963
980
  # providing it to a Google API client library. Providing an unvalidated credential
964
981
  # 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]
@@ -723,8 +723,6 @@ module Google
723
723
  # @return [::String,nil]
724
724
  # @!attribute [rw] credentials
725
725
  # Credentials to send with calls. You may provide any of the following types:
726
- # * (`String`) The path to a service account key file in JSON format
727
- # * (`Hash`) A service account key as a Hash
728
726
  # * (`Google::Auth::Credentials`) A googleauth credentials object
729
727
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
730
728
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -733,7 +731,26 @@ module Google
733
731
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
734
732
  # * (`nil`) indicating no credentials
735
733
  #
736
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
734
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
735
+ # is deprecated. Providing an unvalidated credential configuration to
736
+ # Google APIs can compromise the security of your systems and data.
737
+ #
738
+ # @example
739
+ #
740
+ # # The recommended way to provide credentials is to use the `make_creds` method
741
+ # # on the appropriate credentials class for your environment.
742
+ #
743
+ # require "googleauth"
744
+ #
745
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
746
+ # json_key_io: ::File.open("/path/to/keyfile.json")
747
+ # )
748
+ #
749
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::ControlService::Client.new do |config|
750
+ # config.credentials = credentials
751
+ # end
752
+ #
753
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
737
754
  # external source for authentication to Google Cloud, you must validate it before
738
755
  # providing it to a Google API client library. Providing an unvalidated credential
739
756
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -1599,8 +1599,6 @@ module Google
1599
1599
  # @return [::String,nil]
1600
1600
  # @!attribute [rw] credentials
1601
1601
  # Credentials to send with calls. You may provide any of the following types:
1602
- # * (`String`) The path to a service account key file in JSON format
1603
- # * (`Hash`) A service account key as a Hash
1604
1602
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1605
1603
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1606
1604
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -1609,7 +1607,26 @@ module Google
1609
1607
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1610
1608
  # * (`nil`) indicating no credentials
1611
1609
  #
1612
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
1610
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
1611
+ # is deprecated. Providing an unvalidated credential configuration to
1612
+ # Google APIs can compromise the security of your systems and data.
1613
+ #
1614
+ # @example
1615
+ #
1616
+ # # The recommended way to provide credentials is to use the `make_creds` method
1617
+ # # on the appropriate credentials class for your environment.
1618
+ #
1619
+ # require "googleauth"
1620
+ #
1621
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
1622
+ # json_key_io: ::File.open("/path/to/keyfile.json")
1623
+ # )
1624
+ #
1625
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client.new do |config|
1626
+ # config.credentials = credentials
1627
+ # end
1628
+ #
1629
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
1613
1630
  # external source for authentication to Google Cloud, you must validate it before
1614
1631
  # providing it to a Google API client library. Providing an unvalidated credential
1615
1632
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -792,8 +792,6 @@ module Google
792
792
  # @return [::String,nil]
793
793
  # @!attribute [rw] credentials
794
794
  # Credentials to send with calls. You may provide any of the following types:
795
- # * (`String`) The path to a service account key file in JSON format
796
- # * (`Hash`) A service account key as a Hash
797
795
  # * (`Google::Auth::Credentials`) A googleauth credentials object
798
796
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
799
797
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -802,7 +800,26 @@ module Google
802
800
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
803
801
  # * (`nil`) indicating no credentials
804
802
  #
805
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
803
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
804
+ # is deprecated. Providing an unvalidated credential configuration to
805
+ # Google APIs can compromise the security of your systems and data.
806
+ #
807
+ # @example
808
+ #
809
+ # # The recommended way to provide credentials is to use the `make_creds` method
810
+ # # on the appropriate credentials class for your environment.
811
+ #
812
+ # require "googleauth"
813
+ #
814
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
815
+ # json_key_io: ::File.open("/path/to/keyfile.json")
816
+ # )
817
+ #
818
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::DataStoreService::Client.new do |config|
819
+ # config.credentials = credentials
820
+ # end
821
+ #
822
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
806
823
  # external source for authentication to Google Cloud, you must validate it before
807
824
  # providing it to a Google API client library. Providing an unvalidated credential
808
825
  # 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]
@@ -1202,8 +1202,6 @@ module Google
1202
1202
  # @return [::String,nil]
1203
1203
  # @!attribute [rw] credentials
1204
1204
  # Credentials to send with calls. You may provide any of the following types:
1205
- # * (`String`) The path to a service account key file in JSON format
1206
- # * (`Hash`) A service account key as a Hash
1207
1205
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1208
1206
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1209
1207
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -1212,7 +1210,26 @@ module Google
1212
1210
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1213
1211
  # * (`nil`) indicating no credentials
1214
1212
  #
1215
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
1213
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
1214
+ # is deprecated. Providing an unvalidated credential configuration to
1215
+ # Google APIs can compromise the security of your systems and data.
1216
+ #
1217
+ # @example
1218
+ #
1219
+ # # The recommended way to provide credentials is to use the `make_creds` method
1220
+ # # on the appropriate credentials class for your environment.
1221
+ #
1222
+ # require "googleauth"
1223
+ #
1224
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
1225
+ # json_key_io: ::File.open("/path/to/keyfile.json")
1226
+ # )
1227
+ #
1228
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Client.new do |config|
1229
+ # config.credentials = credentials
1230
+ # end
1231
+ #
1232
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
1216
1233
  # external source for authentication to Google Cloud, you must validate it before
1217
1234
  # providing it to a Google API client library. Providing an unvalidated credential
1218
1235
  # 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]
@@ -1021,8 +1021,6 @@ module Google
1021
1021
  # @return [::String,nil]
1022
1022
  # @!attribute [rw] credentials
1023
1023
  # Credentials to send with calls. You may provide any of the following types:
1024
- # * (`String`) The path to a service account key file in JSON format
1025
- # * (`Hash`) A service account key as a Hash
1026
1024
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1027
1025
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1028
1026
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -1031,7 +1029,26 @@ module Google
1031
1029
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1032
1030
  # * (`nil`) indicating no credentials
1033
1031
  #
1034
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
1032
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
1033
+ # is deprecated. Providing an unvalidated credential configuration to
1034
+ # Google APIs can compromise the security of your systems and data.
1035
+ #
1036
+ # @example
1037
+ #
1038
+ # # The recommended way to provide credentials is to use the `make_creds` method
1039
+ # # on the appropriate credentials class for your environment.
1040
+ #
1041
+ # require "googleauth"
1042
+ #
1043
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
1044
+ # json_key_io: ::File.open("/path/to/keyfile.json")
1045
+ # )
1046
+ #
1047
+ # client = ::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client.new do |config|
1048
+ # config.credentials = credentials
1049
+ # end
1050
+ #
1051
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
1035
1052
  # external source for authentication to Google Cloud, you must validate it before
1036
1053
  # providing it to a Google API client library. Providing an unvalidated credential
1037
1054
  # 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]