google-cloud-dialogflow-cx-v3 1.9.0 → 1.10.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 (35) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/dialogflow/cx/v3/agents/client.rb +20 -3
  3. data/lib/google/cloud/dialogflow/cx/v3/agents/operations.rb +32 -4
  4. data/lib/google/cloud/dialogflow/cx/v3/agents/rest/operations.rb +12 -1
  5. data/lib/google/cloud/dialogflow/cx/v3/changelogs/client.rb +20 -3
  6. data/lib/google/cloud/dialogflow/cx/v3/deployments/client.rb +20 -3
  7. data/lib/google/cloud/dialogflow/cx/v3/entity_types/client.rb +20 -3
  8. data/lib/google/cloud/dialogflow/cx/v3/entity_types/operations.rb +32 -4
  9. data/lib/google/cloud/dialogflow/cx/v3/entity_types/rest/operations.rb +12 -1
  10. data/lib/google/cloud/dialogflow/cx/v3/environments/client.rb +20 -3
  11. data/lib/google/cloud/dialogflow/cx/v3/environments/operations.rb +32 -4
  12. data/lib/google/cloud/dialogflow/cx/v3/environments/rest/operations.rb +12 -1
  13. data/lib/google/cloud/dialogflow/cx/v3/experiments/client.rb +20 -3
  14. data/lib/google/cloud/dialogflow/cx/v3/flows/client.rb +20 -3
  15. data/lib/google/cloud/dialogflow/cx/v3/flows/operations.rb +32 -4
  16. data/lib/google/cloud/dialogflow/cx/v3/flows/rest/operations.rb +12 -1
  17. data/lib/google/cloud/dialogflow/cx/v3/generators/client.rb +20 -3
  18. data/lib/google/cloud/dialogflow/cx/v3/intents/client.rb +20 -3
  19. data/lib/google/cloud/dialogflow/cx/v3/intents/operations.rb +32 -4
  20. data/lib/google/cloud/dialogflow/cx/v3/intents/rest/operations.rb +12 -1
  21. data/lib/google/cloud/dialogflow/cx/v3/pages/client.rb +20 -3
  22. data/lib/google/cloud/dialogflow/cx/v3/security_settings_service/client.rb +20 -3
  23. data/lib/google/cloud/dialogflow/cx/v3/session_entity_types/client.rb +20 -3
  24. data/lib/google/cloud/dialogflow/cx/v3/sessions/client.rb +20 -3
  25. data/lib/google/cloud/dialogflow/cx/v3/test_cases/client.rb +20 -3
  26. data/lib/google/cloud/dialogflow/cx/v3/test_cases/operations.rb +32 -4
  27. data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/operations.rb +12 -1
  28. data/lib/google/cloud/dialogflow/cx/v3/transition_route_groups/client.rb +20 -3
  29. data/lib/google/cloud/dialogflow/cx/v3/version.rb +1 -1
  30. data/lib/google/cloud/dialogflow/cx/v3/versions/client.rb +20 -3
  31. data/lib/google/cloud/dialogflow/cx/v3/versions/operations.rb +32 -4
  32. data/lib/google/cloud/dialogflow/cx/v3/versions/rest/operations.rb +12 -1
  33. data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb +20 -3
  34. data/proto_docs/google/longrunning/operations.rb +18 -0
  35. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9b2e742e864079c7459060a624ee2e7076c67b62508249b0563d7426d17af4b2
4
- data.tar.gz: 23cb4beb06e8f5e972a94a9643d3df3c8aba7a63bf22b23179e9248ae8abeceb
3
+ metadata.gz: 7ed7368a3e328af4dd0cf91de601aaece55c0ef8413b75c8d59463ca87932fb7
4
+ data.tar.gz: 588b19b5a6346c3000c6c147b27e7ea74cb04ff1470c7df8bd0733cb8553e33a
5
5
  SHA512:
6
- metadata.gz: 98402fd212ec90a8347d0a8e5587ed79953610585a60b5ef845de0180b3bf6987417942684fed9bf9b0001b58c62204da52957fd2120d9b741b6025ae3dfdaf2
7
- data.tar.gz: d1f44312431b2574cfe6909db0be6035eb7711783d0071219e4c5b943eed32f22defc95f420446bd8bb2f1bbaa650eebedb369b9454425f2be80d0c64bc1ccd6
6
+ metadata.gz: a0f08c1ba91ba174ed3f184b05af724c5078fd7d6b383e09ee5aadf02f833ec03b0f7941d45e4894b996e7c1c3c231efd19c4c90a5c43dcbd7a83da13a8c08c8
7
+ data.tar.gz: 188e99d02820c35d1335b9f0ba7ffd9d6735cde24ab8eec520264f588b0c4920f36cf7b3fe343bbf6dabfd345a6256c2d369afb1f28fc5a43e9e7db651634f55
@@ -1327,8 +1327,6 @@ module Google
1327
1327
  # @return [::String,nil]
1328
1328
  # @!attribute [rw] credentials
1329
1329
  # Credentials to send with calls. You may provide any of the following types:
1330
- # * (`String`) The path to a service account key file in JSON format
1331
- # * (`Hash`) A service account key as a Hash
1332
1330
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1333
1331
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1334
1332
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -1337,7 +1335,26 @@ module Google
1337
1335
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1338
1336
  # * (`nil`) indicating no credentials
1339
1337
  #
1340
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
1338
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
1339
+ # is deprecated. Providing an unvalidated credential configuration to
1340
+ # Google APIs can compromise the security of your systems and data.
1341
+ #
1342
+ # @example
1343
+ #
1344
+ # # The recommended way to provide credentials is to use the `make_creds` method
1345
+ # # on the appropriate credentials class for your environment.
1346
+ #
1347
+ # require "googleauth"
1348
+ #
1349
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
1350
+ # json_key_io: ::File.open("/path/to/keyfile.json")
1351
+ # )
1352
+ #
1353
+ # client = ::Google::Cloud::Dialogflow::CX::V3::Agents::Client.new do |config|
1354
+ # config.credentials = credentials
1355
+ # end
1356
+ #
1357
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
1341
1358
  # external source for authentication to Google Cloud, you must validate it before
1342
1359
  # providing it to a Google API client library. Providing an unvalidated credential
1343
1360
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -135,7 +135,7 @@ module Google
135
135
  # @param options [::Gapic::CallOptions, ::Hash]
136
136
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
137
137
  #
138
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
138
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
139
139
  # Pass arguments to `list_operations` via keyword arguments. Note that at
140
140
  # least one keyword argument is required. To specify no parameters, or to keep all
141
141
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -148,6 +148,17 @@ module Google
148
148
  # The standard list page size.
149
149
  # @param page_token [::String]
150
150
  # The standard list page token.
151
+ # @param return_partial_success [::Boolean]
152
+ # When set to `true`, operations that are reachable are returned as normal,
153
+ # and those that are unreachable are returned in the
154
+ # [ListOperationsResponse.unreachable] field.
155
+ #
156
+ # This can only be `true` when reading across collections e.g. when `parent`
157
+ # is set to `"projects/example/locations/-"`.
158
+ #
159
+ # This field is not by default supported and will result in an
160
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
161
+ # service or product specific documentation.
151
162
  #
152
163
  # @yield [response, operation] Access the result along with the RPC operation
153
164
  # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]
@@ -632,8 +643,6 @@ module Google
632
643
  # @return [::String,nil]
633
644
  # @!attribute [rw] credentials
634
645
  # Credentials to send with calls. You may provide any of the following types:
635
- # * (`String`) The path to a service account key file in JSON format
636
- # * (`Hash`) A service account key as a Hash
637
646
  # * (`Google::Auth::Credentials`) A googleauth credentials object
638
647
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
639
648
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -642,7 +651,26 @@ module Google
642
651
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
643
652
  # * (`nil`) indicating no credentials
644
653
  #
645
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
654
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
655
+ # is deprecated. Providing an unvalidated credential configuration to
656
+ # Google APIs can compromise the security of your systems and data.
657
+ #
658
+ # @example
659
+ #
660
+ # # The recommended way to provide credentials is to use the `make_creds` method
661
+ # # on the appropriate credentials class for your environment.
662
+ #
663
+ # require "googleauth"
664
+ #
665
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
666
+ # json_key_io: ::File.open("/path/to/keyfile.json")
667
+ # )
668
+ #
669
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
670
+ # config.credentials = credentials
671
+ # end
672
+ #
673
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
646
674
  # external source for authentication to Google Cloud, you must validate it before
647
675
  # providing it to a Google API client library. Providing an unvalidated credential
648
676
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -126,7 +126,7 @@ module Google
126
126
  # @param options [::Gapic::CallOptions, ::Hash]
127
127
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
128
128
  #
129
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
129
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
130
130
  # Pass arguments to `list_operations` via keyword arguments. Note that at
131
131
  # least one keyword argument is required. To specify no parameters, or to keep all
132
132
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -139,6 +139,17 @@ module Google
139
139
  # The standard list page size.
140
140
  # @param page_token [::String]
141
141
  # The standard list page token.
142
+ # @param return_partial_success [::Boolean]
143
+ # When set to `true`, operations that are reachable are returned as normal,
144
+ # and those that are unreachable are returned in the
145
+ # [ListOperationsResponse.unreachable] field.
146
+ #
147
+ # This can only be `true` when reading across collections e.g. when `parent`
148
+ # is set to `"projects/example/locations/-"`.
149
+ #
150
+ # This field is not by default supported and will result in an
151
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
152
+ # service or product specific documentation.
142
153
  # @yield [result, operation] Access the result along with the TransportOperation object
143
154
  # @yieldparam result [::Gapic::Operation]
144
155
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -445,8 +445,6 @@ module Google
445
445
  # @return [::String,nil]
446
446
  # @!attribute [rw] credentials
447
447
  # Credentials to send with calls. You may provide any of the following types:
448
- # * (`String`) The path to a service account key file in JSON format
449
- # * (`Hash`) A service account key as a Hash
450
448
  # * (`Google::Auth::Credentials`) A googleauth credentials object
451
449
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
452
450
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -455,7 +453,26 @@ module Google
455
453
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
456
454
  # * (`nil`) indicating no credentials
457
455
  #
458
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
456
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
457
+ # is deprecated. Providing an unvalidated credential configuration to
458
+ # Google APIs can compromise the security of your systems and data.
459
+ #
460
+ # @example
461
+ #
462
+ # # The recommended way to provide credentials is to use the `make_creds` method
463
+ # # on the appropriate credentials class for your environment.
464
+ #
465
+ # require "googleauth"
466
+ #
467
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
468
+ # json_key_io: ::File.open("/path/to/keyfile.json")
469
+ # )
470
+ #
471
+ # client = ::Google::Cloud::Dialogflow::CX::V3::Changelogs::Client.new do |config|
472
+ # config.credentials = credentials
473
+ # end
474
+ #
475
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
459
476
  # external source for authentication to Google Cloud, you must validate it before
460
477
  # providing it to a Google API client library. Providing an unvalidated credential
461
478
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -427,8 +427,6 @@ module Google
427
427
  # @return [::String,nil]
428
428
  # @!attribute [rw] credentials
429
429
  # Credentials to send with calls. You may provide any of the following types:
430
- # * (`String`) The path to a service account key file in JSON format
431
- # * (`Hash`) A service account key as a Hash
432
430
  # * (`Google::Auth::Credentials`) A googleauth credentials object
433
431
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
434
432
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -437,7 +435,26 @@ module Google
437
435
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
438
436
  # * (`nil`) indicating no credentials
439
437
  #
440
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
438
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
439
+ # is deprecated. Providing an unvalidated credential configuration to
440
+ # Google APIs can compromise the security of your systems and data.
441
+ #
442
+ # @example
443
+ #
444
+ # # The recommended way to provide credentials is to use the `make_creds` method
445
+ # # on the appropriate credentials class for your environment.
446
+ #
447
+ # require "googleauth"
448
+ #
449
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
450
+ # json_key_io: ::File.open("/path/to/keyfile.json")
451
+ # )
452
+ #
453
+ # client = ::Google::Cloud::Dialogflow::CX::V3::Deployments::Client.new do |config|
454
+ # config.credentials = credentials
455
+ # end
456
+ #
457
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
441
458
  # external source for authentication to Google Cloud, you must validate it before
442
459
  # providing it to a Google API client library. Providing an unvalidated credential
443
460
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -1029,8 +1029,6 @@ module Google
1029
1029
  # @return [::String,nil]
1030
1030
  # @!attribute [rw] credentials
1031
1031
  # Credentials to send with calls. You may provide any of the following types:
1032
- # * (`String`) The path to a service account key file in JSON format
1033
- # * (`Hash`) A service account key as a Hash
1034
1032
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1035
1033
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1036
1034
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -1039,7 +1037,26 @@ module Google
1039
1037
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1040
1038
  # * (`nil`) indicating no credentials
1041
1039
  #
1042
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
1040
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
1041
+ # is deprecated. Providing an unvalidated credential configuration to
1042
+ # Google APIs can compromise the security of your systems and data.
1043
+ #
1044
+ # @example
1045
+ #
1046
+ # # The recommended way to provide credentials is to use the `make_creds` method
1047
+ # # on the appropriate credentials class for your environment.
1048
+ #
1049
+ # require "googleauth"
1050
+ #
1051
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
1052
+ # json_key_io: ::File.open("/path/to/keyfile.json")
1053
+ # )
1054
+ #
1055
+ # client = ::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client.new do |config|
1056
+ # config.credentials = credentials
1057
+ # end
1058
+ #
1059
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
1043
1060
  # external source for authentication to Google Cloud, you must validate it before
1044
1061
  # providing it to a Google API client library. Providing an unvalidated credential
1045
1062
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -135,7 +135,7 @@ module Google
135
135
  # @param options [::Gapic::CallOptions, ::Hash]
136
136
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
137
137
  #
138
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
138
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
139
139
  # Pass arguments to `list_operations` via keyword arguments. Note that at
140
140
  # least one keyword argument is required. To specify no parameters, or to keep all
141
141
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -148,6 +148,17 @@ module Google
148
148
  # The standard list page size.
149
149
  # @param page_token [::String]
150
150
  # The standard list page token.
151
+ # @param return_partial_success [::Boolean]
152
+ # When set to `true`, operations that are reachable are returned as normal,
153
+ # and those that are unreachable are returned in the
154
+ # [ListOperationsResponse.unreachable] field.
155
+ #
156
+ # This can only be `true` when reading across collections e.g. when `parent`
157
+ # is set to `"projects/example/locations/-"`.
158
+ #
159
+ # This field is not by default supported and will result in an
160
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
161
+ # service or product specific documentation.
151
162
  #
152
163
  # @yield [response, operation] Access the result along with the RPC operation
153
164
  # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]
@@ -632,8 +643,6 @@ module Google
632
643
  # @return [::String,nil]
633
644
  # @!attribute [rw] credentials
634
645
  # Credentials to send with calls. You may provide any of the following types:
635
- # * (`String`) The path to a service account key file in JSON format
636
- # * (`Hash`) A service account key as a Hash
637
646
  # * (`Google::Auth::Credentials`) A googleauth credentials object
638
647
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
639
648
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -642,7 +651,26 @@ module Google
642
651
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
643
652
  # * (`nil`) indicating no credentials
644
653
  #
645
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
654
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
655
+ # is deprecated. Providing an unvalidated credential configuration to
656
+ # Google APIs can compromise the security of your systems and data.
657
+ #
658
+ # @example
659
+ #
660
+ # # The recommended way to provide credentials is to use the `make_creds` method
661
+ # # on the appropriate credentials class for your environment.
662
+ #
663
+ # require "googleauth"
664
+ #
665
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
666
+ # json_key_io: ::File.open("/path/to/keyfile.json")
667
+ # )
668
+ #
669
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
670
+ # config.credentials = credentials
671
+ # end
672
+ #
673
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
646
674
  # external source for authentication to Google Cloud, you must validate it before
647
675
  # providing it to a Google API client library. Providing an unvalidated credential
648
676
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -126,7 +126,7 @@ module Google
126
126
  # @param options [::Gapic::CallOptions, ::Hash]
127
127
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
128
128
  #
129
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
129
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
130
130
  # Pass arguments to `list_operations` via keyword arguments. Note that at
131
131
  # least one keyword argument is required. To specify no parameters, or to keep all
132
132
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -139,6 +139,17 @@ module Google
139
139
  # The standard list page size.
140
140
  # @param page_token [::String]
141
141
  # The standard list page token.
142
+ # @param return_partial_success [::Boolean]
143
+ # When set to `true`, operations that are reachable are returned as normal,
144
+ # and those that are unreachable are returned in the
145
+ # [ListOperationsResponse.unreachable] field.
146
+ #
147
+ # This can only be `true` when reading across collections e.g. when `parent`
148
+ # is set to `"projects/example/locations/-"`.
149
+ #
150
+ # This field is not by default supported and will result in an
151
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
152
+ # service or product specific documentation.
142
153
  # @yield [result, operation] Access the result along with the TransportOperation object
143
154
  # @yieldparam result [::Gapic::Operation]
144
155
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1154,8 +1154,6 @@ module Google
1154
1154
  # @return [::String,nil]
1155
1155
  # @!attribute [rw] credentials
1156
1156
  # Credentials to send with calls. You may provide any of the following types:
1157
- # * (`String`) The path to a service account key file in JSON format
1158
- # * (`Hash`) A service account key as a Hash
1159
1157
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1160
1158
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1161
1159
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -1164,7 +1162,26 @@ module Google
1164
1162
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1165
1163
  # * (`nil`) indicating no credentials
1166
1164
  #
1167
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
1165
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
1166
+ # is deprecated. Providing an unvalidated credential configuration to
1167
+ # Google APIs can compromise the security of your systems and data.
1168
+ #
1169
+ # @example
1170
+ #
1171
+ # # The recommended way to provide credentials is to use the `make_creds` method
1172
+ # # on the appropriate credentials class for your environment.
1173
+ #
1174
+ # require "googleauth"
1175
+ #
1176
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
1177
+ # json_key_io: ::File.open("/path/to/keyfile.json")
1178
+ # )
1179
+ #
1180
+ # client = ::Google::Cloud::Dialogflow::CX::V3::Environments::Client.new do |config|
1181
+ # config.credentials = credentials
1182
+ # end
1183
+ #
1184
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
1168
1185
  # external source for authentication to Google Cloud, you must validate it before
1169
1186
  # providing it to a Google API client library. Providing an unvalidated credential
1170
1187
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -135,7 +135,7 @@ module Google
135
135
  # @param options [::Gapic::CallOptions, ::Hash]
136
136
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
137
137
  #
138
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
138
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
139
139
  # Pass arguments to `list_operations` via keyword arguments. Note that at
140
140
  # least one keyword argument is required. To specify no parameters, or to keep all
141
141
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -148,6 +148,17 @@ module Google
148
148
  # The standard list page size.
149
149
  # @param page_token [::String]
150
150
  # The standard list page token.
151
+ # @param return_partial_success [::Boolean]
152
+ # When set to `true`, operations that are reachable are returned as normal,
153
+ # and those that are unreachable are returned in the
154
+ # [ListOperationsResponse.unreachable] field.
155
+ #
156
+ # This can only be `true` when reading across collections e.g. when `parent`
157
+ # is set to `"projects/example/locations/-"`.
158
+ #
159
+ # This field is not by default supported and will result in an
160
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
161
+ # service or product specific documentation.
151
162
  #
152
163
  # @yield [response, operation] Access the result along with the RPC operation
153
164
  # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]
@@ -632,8 +643,6 @@ module Google
632
643
  # @return [::String,nil]
633
644
  # @!attribute [rw] credentials
634
645
  # Credentials to send with calls. You may provide any of the following types:
635
- # * (`String`) The path to a service account key file in JSON format
636
- # * (`Hash`) A service account key as a Hash
637
646
  # * (`Google::Auth::Credentials`) A googleauth credentials object
638
647
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
639
648
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -642,7 +651,26 @@ module Google
642
651
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
643
652
  # * (`nil`) indicating no credentials
644
653
  #
645
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
654
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
655
+ # is deprecated. Providing an unvalidated credential configuration to
656
+ # Google APIs can compromise the security of your systems and data.
657
+ #
658
+ # @example
659
+ #
660
+ # # The recommended way to provide credentials is to use the `make_creds` method
661
+ # # on the appropriate credentials class for your environment.
662
+ #
663
+ # require "googleauth"
664
+ #
665
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
666
+ # json_key_io: ::File.open("/path/to/keyfile.json")
667
+ # )
668
+ #
669
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
670
+ # config.credentials = credentials
671
+ # end
672
+ #
673
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
646
674
  # external source for authentication to Google Cloud, you must validate it before
647
675
  # providing it to a Google API client library. Providing an unvalidated credential
648
676
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -126,7 +126,7 @@ module Google
126
126
  # @param options [::Gapic::CallOptions, ::Hash]
127
127
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
128
128
  #
129
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
129
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
130
130
  # Pass arguments to `list_operations` via keyword arguments. Note that at
131
131
  # least one keyword argument is required. To specify no parameters, or to keep all
132
132
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -139,6 +139,17 @@ module Google
139
139
  # The standard list page size.
140
140
  # @param page_token [::String]
141
141
  # The standard list page token.
142
+ # @param return_partial_success [::Boolean]
143
+ # When set to `true`, operations that are reachable are returned as normal,
144
+ # and those that are unreachable are returned in the
145
+ # [ListOperationsResponse.unreachable] field.
146
+ #
147
+ # This can only be `true` when reading across collections e.g. when `parent`
148
+ # is set to `"projects/example/locations/-"`.
149
+ #
150
+ # This field is not by default supported and will result in an
151
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
152
+ # service or product specific documentation.
142
153
  # @yield [result, operation] Access the result along with the TransportOperation object
143
154
  # @yieldparam result [::Gapic::Operation]
144
155
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -870,8 +870,6 @@ module Google
870
870
  # @return [::String,nil]
871
871
  # @!attribute [rw] credentials
872
872
  # Credentials to send with calls. You may provide any of the following types:
873
- # * (`String`) The path to a service account key file in JSON format
874
- # * (`Hash`) A service account key as a Hash
875
873
  # * (`Google::Auth::Credentials`) A googleauth credentials object
876
874
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
877
875
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -880,7 +878,26 @@ module Google
880
878
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
881
879
  # * (`nil`) indicating no credentials
882
880
  #
883
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
881
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
882
+ # is deprecated. Providing an unvalidated credential configuration to
883
+ # Google APIs can compromise the security of your systems and data.
884
+ #
885
+ # @example
886
+ #
887
+ # # The recommended way to provide credentials is to use the `make_creds` method
888
+ # # on the appropriate credentials class for your environment.
889
+ #
890
+ # require "googleauth"
891
+ #
892
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
893
+ # json_key_io: ::File.open("/path/to/keyfile.json")
894
+ # )
895
+ #
896
+ # client = ::Google::Cloud::Dialogflow::CX::V3::Experiments::Client.new do |config|
897
+ # config.credentials = credentials
898
+ # end
899
+ #
900
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
884
901
  # external source for authentication to Google Cloud, you must validate it before
885
902
  # providing it to a Google API client library. Providing an unvalidated credential
886
903
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -1315,8 +1315,6 @@ module Google
1315
1315
  # @return [::String,nil]
1316
1316
  # @!attribute [rw] credentials
1317
1317
  # Credentials to send with calls. You may provide any of the following types:
1318
- # * (`String`) The path to a service account key file in JSON format
1319
- # * (`Hash`) A service account key as a Hash
1320
1318
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1321
1319
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1322
1320
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -1325,7 +1323,26 @@ module Google
1325
1323
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1326
1324
  # * (`nil`) indicating no credentials
1327
1325
  #
1328
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
1326
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
1327
+ # is deprecated. Providing an unvalidated credential configuration to
1328
+ # Google APIs can compromise the security of your systems and data.
1329
+ #
1330
+ # @example
1331
+ #
1332
+ # # The recommended way to provide credentials is to use the `make_creds` method
1333
+ # # on the appropriate credentials class for your environment.
1334
+ #
1335
+ # require "googleauth"
1336
+ #
1337
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
1338
+ # json_key_io: ::File.open("/path/to/keyfile.json")
1339
+ # )
1340
+ #
1341
+ # client = ::Google::Cloud::Dialogflow::CX::V3::Flows::Client.new do |config|
1342
+ # config.credentials = credentials
1343
+ # end
1344
+ #
1345
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
1329
1346
  # external source for authentication to Google Cloud, you must validate it before
1330
1347
  # providing it to a Google API client library. Providing an unvalidated credential
1331
1348
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -135,7 +135,7 @@ module Google
135
135
  # @param options [::Gapic::CallOptions, ::Hash]
136
136
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
137
137
  #
138
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
138
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
139
139
  # Pass arguments to `list_operations` via keyword arguments. Note that at
140
140
  # least one keyword argument is required. To specify no parameters, or to keep all
141
141
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -148,6 +148,17 @@ module Google
148
148
  # The standard list page size.
149
149
  # @param page_token [::String]
150
150
  # The standard list page token.
151
+ # @param return_partial_success [::Boolean]
152
+ # When set to `true`, operations that are reachable are returned as normal,
153
+ # and those that are unreachable are returned in the
154
+ # [ListOperationsResponse.unreachable] field.
155
+ #
156
+ # This can only be `true` when reading across collections e.g. when `parent`
157
+ # is set to `"projects/example/locations/-"`.
158
+ #
159
+ # This field is not by default supported and will result in an
160
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
161
+ # service or product specific documentation.
151
162
  #
152
163
  # @yield [response, operation] Access the result along with the RPC operation
153
164
  # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]
@@ -632,8 +643,6 @@ module Google
632
643
  # @return [::String,nil]
633
644
  # @!attribute [rw] credentials
634
645
  # Credentials to send with calls. You may provide any of the following types:
635
- # * (`String`) The path to a service account key file in JSON format
636
- # * (`Hash`) A service account key as a Hash
637
646
  # * (`Google::Auth::Credentials`) A googleauth credentials object
638
647
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
639
648
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -642,7 +651,26 @@ module Google
642
651
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
643
652
  # * (`nil`) indicating no credentials
644
653
  #
645
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
654
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
655
+ # is deprecated. Providing an unvalidated credential configuration to
656
+ # Google APIs can compromise the security of your systems and data.
657
+ #
658
+ # @example
659
+ #
660
+ # # The recommended way to provide credentials is to use the `make_creds` method
661
+ # # on the appropriate credentials class for your environment.
662
+ #
663
+ # require "googleauth"
664
+ #
665
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
666
+ # json_key_io: ::File.open("/path/to/keyfile.json")
667
+ # )
668
+ #
669
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
670
+ # config.credentials = credentials
671
+ # end
672
+ #
673
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
646
674
  # external source for authentication to Google Cloud, you must validate it before
647
675
  # providing it to a Google API client library. Providing an unvalidated credential
648
676
  # configuration to Google APIs can compromise the security of your systems and data.