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
@@ -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]
@@ -706,8 +706,6 @@ module Google
706
706
  # @return [::String,nil]
707
707
  # @!attribute [rw] credentials
708
708
  # Credentials to send with calls. You may provide any of the following types:
709
- # * (`String`) The path to a service account key file in JSON format
710
- # * (`Hash`) A service account key as a Hash
711
709
  # * (`Google::Auth::Credentials`) A googleauth credentials object
712
710
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
713
711
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -716,7 +714,26 @@ module Google
716
714
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
717
715
  # * (`nil`) indicating no credentials
718
716
  #
719
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
717
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
718
+ # is deprecated. Providing an unvalidated credential configuration to
719
+ # Google APIs can compromise the security of your systems and data.
720
+ #
721
+ # @example
722
+ #
723
+ # # The recommended way to provide credentials is to use the `make_creds` method
724
+ # # on the appropriate credentials class for your environment.
725
+ #
726
+ # require "googleauth"
727
+ #
728
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
729
+ # json_key_io: ::File.open("/path/to/keyfile.json")
730
+ # )
731
+ #
732
+ # client = ::Google::Cloud::Dialogflow::CX::V3::Generators::Client.new do |config|
733
+ # config.credentials = credentials
734
+ # end
735
+ #
736
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
720
737
  # external source for authentication to Google Cloud, you must validate it before
721
738
  # providing it to a Google API client library. Providing an unvalidated credential
722
739
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -1007,8 +1007,6 @@ module Google
1007
1007
  # @return [::String,nil]
1008
1008
  # @!attribute [rw] credentials
1009
1009
  # Credentials to send with calls. You may provide any of the following types:
1010
- # * (`String`) The path to a service account key file in JSON format
1011
- # * (`Hash`) A service account key as a Hash
1012
1010
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1013
1011
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1014
1012
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -1017,7 +1015,26 @@ module Google
1017
1015
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1018
1016
  # * (`nil`) indicating no credentials
1019
1017
  #
1020
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
1018
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
1019
+ # is deprecated. Providing an unvalidated credential configuration to
1020
+ # Google APIs can compromise the security of your systems and data.
1021
+ #
1022
+ # @example
1023
+ #
1024
+ # # The recommended way to provide credentials is to use the `make_creds` method
1025
+ # # on the appropriate credentials class for your environment.
1026
+ #
1027
+ # require "googleauth"
1028
+ #
1029
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
1030
+ # json_key_io: ::File.open("/path/to/keyfile.json")
1031
+ # )
1032
+ #
1033
+ # client = ::Google::Cloud::Dialogflow::CX::V3::Intents::Client.new do |config|
1034
+ # config.credentials = credentials
1035
+ # end
1036
+ #
1037
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
1021
1038
  # external source for authentication to Google Cloud, you must validate it before
1022
1039
  # providing it to a Google API client library. Providing an unvalidated credential
1023
1040
  # 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]
@@ -798,8 +798,6 @@ module Google
798
798
  # @return [::String,nil]
799
799
  # @!attribute [rw] credentials
800
800
  # Credentials to send with calls. You may provide any of the following types:
801
- # * (`String`) The path to a service account key file in JSON format
802
- # * (`Hash`) A service account key as a Hash
803
801
  # * (`Google::Auth::Credentials`) A googleauth credentials object
804
802
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
805
803
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -808,7 +806,26 @@ module Google
808
806
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
809
807
  # * (`nil`) indicating no credentials
810
808
  #
811
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
809
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
810
+ # is deprecated. Providing an unvalidated credential configuration to
811
+ # Google APIs can compromise the security of your systems and data.
812
+ #
813
+ # @example
814
+ #
815
+ # # The recommended way to provide credentials is to use the `make_creds` method
816
+ # # on the appropriate credentials class for your environment.
817
+ #
818
+ # require "googleauth"
819
+ #
820
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
821
+ # json_key_io: ::File.open("/path/to/keyfile.json")
822
+ # )
823
+ #
824
+ # client = ::Google::Cloud::Dialogflow::CX::V3::Pages::Client.new do |config|
825
+ # config.credentials = credentials
826
+ # end
827
+ #
828
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
812
829
  # external source for authentication to Google Cloud, you must validate it before
813
830
  # providing it to a Google API client library. Providing an unvalidated credential
814
831
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -694,8 +694,6 @@ module Google
694
694
  # @return [::String,nil]
695
695
  # @!attribute [rw] credentials
696
696
  # Credentials to send with calls. You may provide any of the following types:
697
- # * (`String`) The path to a service account key file in JSON format
698
- # * (`Hash`) A service account key as a Hash
699
697
  # * (`Google::Auth::Credentials`) A googleauth credentials object
700
698
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
701
699
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -704,7 +702,26 @@ module Google
704
702
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
705
703
  # * (`nil`) indicating no credentials
706
704
  #
707
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
705
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
706
+ # is deprecated. Providing an unvalidated credential configuration to
707
+ # Google APIs can compromise the security of your systems and data.
708
+ #
709
+ # @example
710
+ #
711
+ # # The recommended way to provide credentials is to use the `make_creds` method
712
+ # # on the appropriate credentials class for your environment.
713
+ #
714
+ # require "googleauth"
715
+ #
716
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
717
+ # json_key_io: ::File.open("/path/to/keyfile.json")
718
+ # )
719
+ #
720
+ # client = ::Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client.new do |config|
721
+ # config.credentials = credentials
722
+ # end
723
+ #
724
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
708
725
  # external source for authentication to Google Cloud, you must validate it before
709
726
  # providing it to a Google API client library. Providing an unvalidated credential
710
727
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -711,8 +711,6 @@ module Google
711
711
  # @return [::String,nil]
712
712
  # @!attribute [rw] credentials
713
713
  # Credentials to send with calls. You may provide any of the following types:
714
- # * (`String`) The path to a service account key file in JSON format
715
- # * (`Hash`) A service account key as a Hash
716
714
  # * (`Google::Auth::Credentials`) A googleauth credentials object
717
715
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
718
716
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -721,7 +719,26 @@ module Google
721
719
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
722
720
  # * (`nil`) indicating no credentials
723
721
  #
724
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
722
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
723
+ # is deprecated. Providing an unvalidated credential configuration to
724
+ # Google APIs can compromise the security of your systems and data.
725
+ #
726
+ # @example
727
+ #
728
+ # # The recommended way to provide credentials is to use the `make_creds` method
729
+ # # on the appropriate credentials class for your environment.
730
+ #
731
+ # require "googleauth"
732
+ #
733
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
734
+ # json_key_io: ::File.open("/path/to/keyfile.json")
735
+ # )
736
+ #
737
+ # client = ::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client.new do |config|
738
+ # config.credentials = credentials
739
+ # end
740
+ #
741
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
725
742
  # external source for authentication to Google Cloud, you must validate it before
726
743
  # providing it to a Google API client library. Providing an unvalidated credential
727
744
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -858,8 +858,6 @@ module Google
858
858
  # @return [::String,nil]
859
859
  # @!attribute [rw] credentials
860
860
  # Credentials to send with calls. You may provide any of the following types:
861
- # * (`String`) The path to a service account key file in JSON format
862
- # * (`Hash`) A service account key as a Hash
863
861
  # * (`Google::Auth::Credentials`) A googleauth credentials object
864
862
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
865
863
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -868,7 +866,26 @@ module Google
868
866
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
869
867
  # * (`nil`) indicating no credentials
870
868
  #
871
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
869
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
870
+ # is deprecated. Providing an unvalidated credential configuration to
871
+ # Google APIs can compromise the security of your systems and data.
872
+ #
873
+ # @example
874
+ #
875
+ # # The recommended way to provide credentials is to use the `make_creds` method
876
+ # # on the appropriate credentials class for your environment.
877
+ #
878
+ # require "googleauth"
879
+ #
880
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
881
+ # json_key_io: ::File.open("/path/to/keyfile.json")
882
+ # )
883
+ #
884
+ # client = ::Google::Cloud::Dialogflow::CX::V3::Sessions::Client.new do |config|
885
+ # config.credentials = credentials
886
+ # end
887
+ #
888
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
872
889
  # external source for authentication to Google Cloud, you must validate it before
873
890
  # providing it to a Google API client library. Providing an unvalidated credential
874
891
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -1480,8 +1480,6 @@ module Google
1480
1480
  # @return [::String,nil]
1481
1481
  # @!attribute [rw] credentials
1482
1482
  # Credentials to send with calls. You may provide any of the following types:
1483
- # * (`String`) The path to a service account key file in JSON format
1484
- # * (`Hash`) A service account key as a Hash
1485
1483
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1486
1484
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1487
1485
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -1490,7 +1488,26 @@ module Google
1490
1488
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1491
1489
  # * (`nil`) indicating no credentials
1492
1490
  #
1493
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
1491
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
1492
+ # is deprecated. Providing an unvalidated credential configuration to
1493
+ # Google APIs can compromise the security of your systems and data.
1494
+ #
1495
+ # @example
1496
+ #
1497
+ # # The recommended way to provide credentials is to use the `make_creds` method
1498
+ # # on the appropriate credentials class for your environment.
1499
+ #
1500
+ # require "googleauth"
1501
+ #
1502
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
1503
+ # json_key_io: ::File.open("/path/to/keyfile.json")
1504
+ # )
1505
+ #
1506
+ # client = ::Google::Cloud::Dialogflow::CX::V3::TestCases::Client.new do |config|
1507
+ # config.credentials = credentials
1508
+ # end
1509
+ #
1510
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
1494
1511
  # external source for authentication to Google Cloud, you must validate it before
1495
1512
  # providing it to a Google API client library. Providing an unvalidated credential
1496
1513
  # 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]
@@ -774,8 +774,6 @@ module Google
774
774
  # @return [::String,nil]
775
775
  # @!attribute [rw] credentials
776
776
  # Credentials to send with calls. You may provide any of the following types:
777
- # * (`String`) The path to a service account key file in JSON format
778
- # * (`Hash`) A service account key as a Hash
779
777
  # * (`Google::Auth::Credentials`) A googleauth credentials object
780
778
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
781
779
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -784,7 +782,26 @@ module Google
784
782
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
785
783
  # * (`nil`) indicating no credentials
786
784
  #
787
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
785
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
786
+ # is deprecated. Providing an unvalidated credential configuration to
787
+ # Google APIs can compromise the security of your systems and data.
788
+ #
789
+ # @example
790
+ #
791
+ # # The recommended way to provide credentials is to use the `make_creds` method
792
+ # # on the appropriate credentials class for your environment.
793
+ #
794
+ # require "googleauth"
795
+ #
796
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
797
+ # json_key_io: ::File.open("/path/to/keyfile.json")
798
+ # )
799
+ #
800
+ # client = ::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroups::Client.new do |config|
801
+ # config.credentials = credentials
802
+ # end
803
+ #
804
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
788
805
  # external source for authentication to Google Cloud, you must validate it before
789
806
  # providing it to a Google API client library. Providing an unvalidated credential
790
807
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -22,7 +22,7 @@ module Google
22
22
  module Dialogflow
23
23
  module CX
24
24
  module V3
25
- VERSION = "1.9.0"
25
+ VERSION = "1.10.1"
26
26
  end
27
27
  end
28
28
  end
@@ -934,8 +934,6 @@ module Google
934
934
  # @return [::String,nil]
935
935
  # @!attribute [rw] credentials
936
936
  # Credentials to send with calls. You may provide any of the following types:
937
- # * (`String`) The path to a service account key file in JSON format
938
- # * (`Hash`) A service account key as a Hash
939
937
  # * (`Google::Auth::Credentials`) A googleauth credentials object
940
938
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
941
939
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -944,7 +942,26 @@ module Google
944
942
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
945
943
  # * (`nil`) indicating no credentials
946
944
  #
947
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
945
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
946
+ # is deprecated. Providing an unvalidated credential configuration to
947
+ # Google APIs can compromise the security of your systems and data.
948
+ #
949
+ # @example
950
+ #
951
+ # # The recommended way to provide credentials is to use the `make_creds` method
952
+ # # on the appropriate credentials class for your environment.
953
+ #
954
+ # require "googleauth"
955
+ #
956
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
957
+ # json_key_io: ::File.open("/path/to/keyfile.json")
958
+ # )
959
+ #
960
+ # client = ::Google::Cloud::Dialogflow::CX::V3::Versions::Client.new do |config|
961
+ # config.credentials = credentials
962
+ # end
963
+ #
964
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
948
965
  # external source for authentication to Google Cloud, you must validate it before
949
966
  # providing it to a Google API client library. Providing an unvalidated credential
950
967
  # 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.