google-cloud-dialogflow-v2 1.11.0 → 1.12.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 (39) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/dialogflow/v2/agents/client.rb +20 -3
  3. data/lib/google/cloud/dialogflow/v2/agents/operations.rb +32 -4
  4. data/lib/google/cloud/dialogflow/v2/agents/rest/operations.rb +12 -1
  5. data/lib/google/cloud/dialogflow/v2/answer_records/client.rb +20 -3
  6. data/lib/google/cloud/dialogflow/v2/contexts/client.rb +20 -3
  7. data/lib/google/cloud/dialogflow/v2/conversation_datasets/client.rb +20 -3
  8. data/lib/google/cloud/dialogflow/v2/conversation_datasets/operations.rb +32 -4
  9. data/lib/google/cloud/dialogflow/v2/conversation_datasets/rest/operations.rb +12 -1
  10. data/lib/google/cloud/dialogflow/v2/conversation_models/client.rb +20 -3
  11. data/lib/google/cloud/dialogflow/v2/conversation_models/operations.rb +32 -4
  12. data/lib/google/cloud/dialogflow/v2/conversation_models/rest/operations.rb +12 -1
  13. data/lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb +20 -3
  14. data/lib/google/cloud/dialogflow/v2/conversation_profiles/operations.rb +32 -4
  15. data/lib/google/cloud/dialogflow/v2/conversation_profiles/rest/operations.rb +12 -1
  16. data/lib/google/cloud/dialogflow/v2/conversations/client.rb +20 -3
  17. data/lib/google/cloud/dialogflow/v2/documents/client.rb +20 -3
  18. data/lib/google/cloud/dialogflow/v2/documents/operations.rb +32 -4
  19. data/lib/google/cloud/dialogflow/v2/documents/rest/operations.rb +12 -1
  20. data/lib/google/cloud/dialogflow/v2/encryption_spec_service/client.rb +20 -3
  21. data/lib/google/cloud/dialogflow/v2/encryption_spec_service/operations.rb +32 -4
  22. data/lib/google/cloud/dialogflow/v2/encryption_spec_service/rest/operations.rb +12 -1
  23. data/lib/google/cloud/dialogflow/v2/entity_types/client.rb +20 -3
  24. data/lib/google/cloud/dialogflow/v2/entity_types/operations.rb +32 -4
  25. data/lib/google/cloud/dialogflow/v2/entity_types/rest/operations.rb +12 -1
  26. data/lib/google/cloud/dialogflow/v2/environments/client.rb +20 -3
  27. data/lib/google/cloud/dialogflow/v2/fulfillments/client.rb +20 -3
  28. data/lib/google/cloud/dialogflow/v2/generators/client.rb +20 -3
  29. data/lib/google/cloud/dialogflow/v2/intents/client.rb +20 -3
  30. data/lib/google/cloud/dialogflow/v2/intents/operations.rb +32 -4
  31. data/lib/google/cloud/dialogflow/v2/intents/rest/operations.rb +12 -1
  32. data/lib/google/cloud/dialogflow/v2/knowledge_bases/client.rb +20 -3
  33. data/lib/google/cloud/dialogflow/v2/participants/client.rb +20 -3
  34. data/lib/google/cloud/dialogflow/v2/session_entity_types/client.rb +20 -3
  35. data/lib/google/cloud/dialogflow/v2/sessions/client.rb +20 -3
  36. data/lib/google/cloud/dialogflow/v2/version.rb +1 -1
  37. data/lib/google/cloud/dialogflow/v2/versions/client.rb +20 -3
  38. data/proto_docs/google/longrunning/operations.rb +18 -0
  39. metadata +1 -1
@@ -1387,8 +1387,6 @@ module Google
1387
1387
  # @return [::String,nil]
1388
1388
  # @!attribute [rw] credentials
1389
1389
  # Credentials to send with calls. You may provide any of the following types:
1390
- # * (`String`) The path to a service account key file in JSON format
1391
- # * (`Hash`) A service account key as a Hash
1392
1390
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1393
1391
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1394
1392
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -1397,7 +1395,26 @@ module Google
1397
1395
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1398
1396
  # * (`nil`) indicating no credentials
1399
1397
  #
1400
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
1398
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
1399
+ # is deprecated. Providing an unvalidated credential configuration to
1400
+ # Google APIs can compromise the security of your systems and data.
1401
+ #
1402
+ # @example
1403
+ #
1404
+ # # The recommended way to provide credentials is to use the `make_creds` method
1405
+ # # on the appropriate credentials class for your environment.
1406
+ #
1407
+ # require "googleauth"
1408
+ #
1409
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
1410
+ # json_key_io: ::File.open("/path/to/keyfile.json")
1411
+ # )
1412
+ #
1413
+ # client = ::Google::Cloud::Dialogflow::V2::Conversations::Client.new do |config|
1414
+ # config.credentials = credentials
1415
+ # end
1416
+ #
1417
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
1401
1418
  # external source for authentication to Google Cloud, you must validate it before
1402
1419
  # providing it to a Google API client library. Providing an unvalidated credential
1403
1420
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -1132,8 +1132,6 @@ module Google
1132
1132
  # @return [::String,nil]
1133
1133
  # @!attribute [rw] credentials
1134
1134
  # Credentials to send with calls. You may provide any of the following types:
1135
- # * (`String`) The path to a service account key file in JSON format
1136
- # * (`Hash`) A service account key as a Hash
1137
1135
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1138
1136
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1139
1137
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -1142,7 +1140,26 @@ module Google
1142
1140
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1143
1141
  # * (`nil`) indicating no credentials
1144
1142
  #
1145
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
1143
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
1144
+ # is deprecated. Providing an unvalidated credential configuration to
1145
+ # Google APIs can compromise the security of your systems and data.
1146
+ #
1147
+ # @example
1148
+ #
1149
+ # # The recommended way to provide credentials is to use the `make_creds` method
1150
+ # # on the appropriate credentials class for your environment.
1151
+ #
1152
+ # require "googleauth"
1153
+ #
1154
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
1155
+ # json_key_io: ::File.open("/path/to/keyfile.json")
1156
+ # )
1157
+ #
1158
+ # client = ::Google::Cloud::Dialogflow::V2::Documents::Client.new do |config|
1159
+ # config.credentials = credentials
1160
+ # end
1161
+ #
1162
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
1146
1163
  # external source for authentication to Google Cloud, you must validate it before
1147
1164
  # providing it to a Google API client library. Providing an unvalidated credential
1148
1165
  # 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]
@@ -439,8 +439,6 @@ module Google
439
439
  # @return [::String,nil]
440
440
  # @!attribute [rw] credentials
441
441
  # Credentials to send with calls. You may provide any of the following types:
442
- # * (`String`) The path to a service account key file in JSON format
443
- # * (`Hash`) A service account key as a Hash
444
442
  # * (`Google::Auth::Credentials`) A googleauth credentials object
445
443
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
446
444
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -449,7 +447,26 @@ module Google
449
447
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
450
448
  # * (`nil`) indicating no credentials
451
449
  #
452
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
450
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
451
+ # is deprecated. Providing an unvalidated credential configuration to
452
+ # Google APIs can compromise the security of your systems and data.
453
+ #
454
+ # @example
455
+ #
456
+ # # The recommended way to provide credentials is to use the `make_creds` method
457
+ # # on the appropriate credentials class for your environment.
458
+ #
459
+ # require "googleauth"
460
+ #
461
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
462
+ # json_key_io: ::File.open("/path/to/keyfile.json")
463
+ # )
464
+ #
465
+ # client = ::Google::Cloud::Dialogflow::V2::EncryptionSpecService::Client.new do |config|
466
+ # config.credentials = credentials
467
+ # end
468
+ #
469
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
453
470
  # external source for authentication to Google Cloud, you must validate it before
454
471
  # providing it to a Google API client library. Providing an unvalidated credential
455
472
  # 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]
@@ -1325,8 +1325,6 @@ module Google
1325
1325
  # @return [::String,nil]
1326
1326
  # @!attribute [rw] credentials
1327
1327
  # Credentials to send with calls. You may provide any of the following types:
1328
- # * (`String`) The path to a service account key file in JSON format
1329
- # * (`Hash`) A service account key as a Hash
1330
1328
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1331
1329
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1332
1330
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -1335,7 +1333,26 @@ module Google
1335
1333
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1336
1334
  # * (`nil`) indicating no credentials
1337
1335
  #
1338
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
1336
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
1337
+ # is deprecated. Providing an unvalidated credential configuration to
1338
+ # Google APIs can compromise the security of your systems and data.
1339
+ #
1340
+ # @example
1341
+ #
1342
+ # # The recommended way to provide credentials is to use the `make_creds` method
1343
+ # # on the appropriate credentials class for your environment.
1344
+ #
1345
+ # require "googleauth"
1346
+ #
1347
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
1348
+ # json_key_io: ::File.open("/path/to/keyfile.json")
1349
+ # )
1350
+ #
1351
+ # client = ::Google::Cloud::Dialogflow::V2::EntityTypes::Client.new do |config|
1352
+ # config.credentials = credentials
1353
+ # end
1354
+ #
1355
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
1339
1356
  # external source for authentication to Google Cloud, you must validate it before
1340
1357
  # providing it to a Google API client library. Providing an unvalidated credential
1341
1358
  # 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]
@@ -822,8 +822,6 @@ module Google
822
822
  # @return [::String,nil]
823
823
  # @!attribute [rw] credentials
824
824
  # Credentials to send with calls. You may provide any of the following types:
825
- # * (`String`) The path to a service account key file in JSON format
826
- # * (`Hash`) A service account key as a Hash
827
825
  # * (`Google::Auth::Credentials`) A googleauth credentials object
828
826
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
829
827
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -832,7 +830,26 @@ module Google
832
830
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
833
831
  # * (`nil`) indicating no credentials
834
832
  #
835
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
833
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
834
+ # is deprecated. Providing an unvalidated credential configuration to
835
+ # Google APIs can compromise the security of your systems and data.
836
+ #
837
+ # @example
838
+ #
839
+ # # The recommended way to provide credentials is to use the `make_creds` method
840
+ # # on the appropriate credentials class for your environment.
841
+ #
842
+ # require "googleauth"
843
+ #
844
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
845
+ # json_key_io: ::File.open("/path/to/keyfile.json")
846
+ # )
847
+ #
848
+ # client = ::Google::Cloud::Dialogflow::V2::Environments::Client.new do |config|
849
+ # config.credentials = credentials
850
+ # end
851
+ #
852
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
836
853
  # external source for authentication to Google Cloud, you must validate it before
837
854
  # providing it to a Google API client library. Providing an unvalidated credential
838
855
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -413,8 +413,6 @@ module Google
413
413
  # @return [::String,nil]
414
414
  # @!attribute [rw] credentials
415
415
  # Credentials to send with calls. You may provide any of the following types:
416
- # * (`String`) The path to a service account key file in JSON format
417
- # * (`Hash`) A service account key as a Hash
418
416
  # * (`Google::Auth::Credentials`) A googleauth credentials object
419
417
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
420
418
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -423,7 +421,26 @@ module Google
423
421
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
424
422
  # * (`nil`) indicating no credentials
425
423
  #
426
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
424
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
425
+ # is deprecated. Providing an unvalidated credential configuration to
426
+ # Google APIs can compromise the security of your systems and data.
427
+ #
428
+ # @example
429
+ #
430
+ # # The recommended way to provide credentials is to use the `make_creds` method
431
+ # # on the appropriate credentials class for your environment.
432
+ #
433
+ # require "googleauth"
434
+ #
435
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
436
+ # json_key_io: ::File.open("/path/to/keyfile.json")
437
+ # )
438
+ #
439
+ # client = ::Google::Cloud::Dialogflow::V2::Fulfillments::Client.new do |config|
440
+ # config.credentials = credentials
441
+ # end
442
+ #
443
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
427
444
  # external source for authentication to Google Cloud, you must validate it before
428
445
  # providing it to a Google API client library. Providing an unvalidated credential
429
446
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -699,8 +699,6 @@ module Google
699
699
  # @return [::String,nil]
700
700
  # @!attribute [rw] credentials
701
701
  # Credentials to send with calls. You may provide any of the following types:
702
- # * (`String`) The path to a service account key file in JSON format
703
- # * (`Hash`) A service account key as a Hash
704
702
  # * (`Google::Auth::Credentials`) A googleauth credentials object
705
703
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
706
704
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -709,7 +707,26 @@ module Google
709
707
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
710
708
  # * (`nil`) indicating no credentials
711
709
  #
712
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
710
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
711
+ # is deprecated. Providing an unvalidated credential configuration to
712
+ # Google APIs can compromise the security of your systems and data.
713
+ #
714
+ # @example
715
+ #
716
+ # # The recommended way to provide credentials is to use the `make_creds` method
717
+ # # on the appropriate credentials class for your environment.
718
+ #
719
+ # require "googleauth"
720
+ #
721
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
722
+ # json_key_io: ::File.open("/path/to/keyfile.json")
723
+ # )
724
+ #
725
+ # client = ::Google::Cloud::Dialogflow::V2::Generators::Client.new do |config|
726
+ # config.credentials = credentials
727
+ # end
728
+ #
729
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
713
730
  # external source for authentication to Google Cloud, you must validate it before
714
731
  # providing it to a Google API client library. Providing an unvalidated credential
715
732
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -989,8 +989,6 @@ module Google
989
989
  # @return [::String,nil]
990
990
  # @!attribute [rw] credentials
991
991
  # Credentials to send with calls. You may provide any of the following types:
992
- # * (`String`) The path to a service account key file in JSON format
993
- # * (`Hash`) A service account key as a Hash
994
992
  # * (`Google::Auth::Credentials`) A googleauth credentials object
995
993
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
996
994
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -999,7 +997,26 @@ module Google
999
997
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1000
998
  # * (`nil`) indicating no credentials
1001
999
  #
1002
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
1000
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
1001
+ # is deprecated. Providing an unvalidated credential configuration to
1002
+ # Google APIs can compromise the security of your systems and data.
1003
+ #
1004
+ # @example
1005
+ #
1006
+ # # The recommended way to provide credentials is to use the `make_creds` method
1007
+ # # on the appropriate credentials class for your environment.
1008
+ #
1009
+ # require "googleauth"
1010
+ #
1011
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
1012
+ # json_key_io: ::File.open("/path/to/keyfile.json")
1013
+ # )
1014
+ #
1015
+ # client = ::Google::Cloud::Dialogflow::V2::Intents::Client.new do |config|
1016
+ # config.credentials = credentials
1017
+ # end
1018
+ #
1019
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
1003
1020
  # external source for authentication to Google Cloud, you must validate it before
1004
1021
  # providing it to a Google API client library. Providing an unvalidated credential
1005
1022
  # configuration to Google APIs can compromise the security of your systems and data.