google-cloud-discovery_engine-v1beta 0.22.0 → 0.23.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/operations.rb +32 -4
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +12 -1
- data/lib/google/cloud/discovery_engine/v1beta/control_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/operations.rb +32 -4
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +12 -1
- data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/document_service/operations.rb +32 -4
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +12 -1
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/operations.rb +32 -4
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +12 -1
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/operations.rb +32 -4
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/operations.rb +12 -1
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/project_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/project_service/operations.rb +32 -4
- data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb +12 -1
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/operations.rb +32 -4
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/operations.rb +12 -1
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/operations.rb +32 -4
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +12 -1
- data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/operations.rb +32 -4
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +12 -1
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/session_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/operations.rb +32 -4
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +12 -1
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +20 -3
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/operations.rb +32 -4
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +12 -1
- data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
- data/proto_docs/google/longrunning/operations.rb +18 -0
- metadata +1 -1
|
@@ -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:
|
|
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]
|
|
@@ -1097,8 +1097,6 @@ module Google
|
|
|
1097
1097
|
# @return [::String,nil]
|
|
1098
1098
|
# @!attribute [rw] credentials
|
|
1099
1099
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1100
|
-
# * (`String`) The path to a service account key file in JSON format
|
|
1101
|
-
# * (`Hash`) A service account key as a Hash
|
|
1102
1100
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
|
1103
1101
|
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
|
1104
1102
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
|
@@ -1107,7 +1105,26 @@ module Google
|
|
|
1107
1105
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
|
1108
1106
|
# * (`nil`) indicating no credentials
|
|
1109
1107
|
#
|
|
1110
|
-
# Warning:
|
|
1108
|
+
# @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
|
|
1109
|
+
# is deprecated. Providing an unvalidated credential configuration to
|
|
1110
|
+
# Google APIs can compromise the security of your systems and data.
|
|
1111
|
+
#
|
|
1112
|
+
# @example
|
|
1113
|
+
#
|
|
1114
|
+
# # The recommended way to provide credentials is to use the `make_creds` method
|
|
1115
|
+
# # on the appropriate credentials class for your environment.
|
|
1116
|
+
#
|
|
1117
|
+
# require "googleauth"
|
|
1118
|
+
#
|
|
1119
|
+
# credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
|
|
1120
|
+
# json_key_io: ::File.open("/path/to/keyfile.json")
|
|
1121
|
+
# )
|
|
1122
|
+
#
|
|
1123
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1beta::SearchService::Client.new do |config|
|
|
1124
|
+
# config.credentials = credentials
|
|
1125
|
+
# end
|
|
1126
|
+
#
|
|
1127
|
+
# @note Warning: If you accept a credential configuration (JSON file or Hash) from an
|
|
1111
1128
|
# external source for authentication to Google Cloud, you must validate it before
|
|
1112
1129
|
# providing it to a Google API client library. Providing an unvalidated credential
|
|
1113
1130
|
# configuration to Google APIs can compromise the security of your systems and data.
|
|
@@ -443,8 +443,6 @@ module Google
|
|
|
443
443
|
# @return [::String,nil]
|
|
444
444
|
# @!attribute [rw] credentials
|
|
445
445
|
# Credentials to send with calls. You may provide any of the following types:
|
|
446
|
-
# * (`String`) The path to a service account key file in JSON format
|
|
447
|
-
# * (`Hash`) A service account key as a Hash
|
|
448
446
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
|
449
447
|
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
|
450
448
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
|
@@ -453,7 +451,26 @@ module Google
|
|
|
453
451
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
|
454
452
|
# * (`nil`) indicating no credentials
|
|
455
453
|
#
|
|
456
|
-
# Warning:
|
|
454
|
+
# @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
|
|
455
|
+
# is deprecated. Providing an unvalidated credential configuration to
|
|
456
|
+
# Google APIs can compromise the security of your systems and data.
|
|
457
|
+
#
|
|
458
|
+
# @example
|
|
459
|
+
#
|
|
460
|
+
# # The recommended way to provide credentials is to use the `make_creds` method
|
|
461
|
+
# # on the appropriate credentials class for your environment.
|
|
462
|
+
#
|
|
463
|
+
# require "googleauth"
|
|
464
|
+
#
|
|
465
|
+
# credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
|
|
466
|
+
# json_key_io: ::File.open("/path/to/keyfile.json")
|
|
467
|
+
# )
|
|
468
|
+
#
|
|
469
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1beta::SearchTuningService::Client.new do |config|
|
|
470
|
+
# config.credentials = credentials
|
|
471
|
+
# end
|
|
472
|
+
#
|
|
473
|
+
# @note Warning: If you accept a credential configuration (JSON file or Hash) from an
|
|
457
474
|
# external source for authentication to Google Cloud, you must validate it before
|
|
458
475
|
# providing it to a Google API client library. Providing an unvalidated credential
|
|
459
476
|
# 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:
|
|
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]
|
|
@@ -517,8 +517,6 @@ module Google
|
|
|
517
517
|
# @return [::String,nil]
|
|
518
518
|
# @!attribute [rw] credentials
|
|
519
519
|
# Credentials to send with calls. You may provide any of the following types:
|
|
520
|
-
# * (`String`) The path to a service account key file in JSON format
|
|
521
|
-
# * (`Hash`) A service account key as a Hash
|
|
522
520
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
|
523
521
|
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
|
524
522
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
|
@@ -527,7 +525,26 @@ module Google
|
|
|
527
525
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
|
528
526
|
# * (`nil`) indicating no credentials
|
|
529
527
|
#
|
|
530
|
-
# Warning:
|
|
528
|
+
# @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
|
|
529
|
+
# is deprecated. Providing an unvalidated credential configuration to
|
|
530
|
+
# Google APIs can compromise the security of your systems and data.
|
|
531
|
+
#
|
|
532
|
+
# @example
|
|
533
|
+
#
|
|
534
|
+
# # The recommended way to provide credentials is to use the `make_creds` method
|
|
535
|
+
# # on the appropriate credentials class for your environment.
|
|
536
|
+
#
|
|
537
|
+
# require "googleauth"
|
|
538
|
+
#
|
|
539
|
+
# credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
|
|
540
|
+
# json_key_io: ::File.open("/path/to/keyfile.json")
|
|
541
|
+
# )
|
|
542
|
+
#
|
|
543
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1beta::ServingConfigService::Client.new do |config|
|
|
544
|
+
# config.credentials = credentials
|
|
545
|
+
# end
|
|
546
|
+
#
|
|
547
|
+
# @note Warning: If you accept a credential configuration (JSON file or Hash) from an
|
|
531
548
|
# external source for authentication to Google Cloud, you must validate it before
|
|
532
549
|
# providing it to a Google API client library. Providing an unvalidated credential
|
|
533
550
|
# configuration to Google APIs can compromise the security of your systems and data.
|
|
@@ -738,8 +738,6 @@ module Google
|
|
|
738
738
|
# @return [::String,nil]
|
|
739
739
|
# @!attribute [rw] credentials
|
|
740
740
|
# Credentials to send with calls. You may provide any of the following types:
|
|
741
|
-
# * (`String`) The path to a service account key file in JSON format
|
|
742
|
-
# * (`Hash`) A service account key as a Hash
|
|
743
741
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
|
744
742
|
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
|
745
743
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
|
@@ -748,7 +746,26 @@ module Google
|
|
|
748
746
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
|
749
747
|
# * (`nil`) indicating no credentials
|
|
750
748
|
#
|
|
751
|
-
# Warning:
|
|
749
|
+
# @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
|
|
750
|
+
# is deprecated. Providing an unvalidated credential configuration to
|
|
751
|
+
# Google APIs can compromise the security of your systems and data.
|
|
752
|
+
#
|
|
753
|
+
# @example
|
|
754
|
+
#
|
|
755
|
+
# # The recommended way to provide credentials is to use the `make_creds` method
|
|
756
|
+
# # on the appropriate credentials class for your environment.
|
|
757
|
+
#
|
|
758
|
+
# require "googleauth"
|
|
759
|
+
#
|
|
760
|
+
# credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
|
|
761
|
+
# json_key_io: ::File.open("/path/to/keyfile.json")
|
|
762
|
+
# )
|
|
763
|
+
#
|
|
764
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1beta::SessionService::Client.new do |config|
|
|
765
|
+
# config.credentials = credentials
|
|
766
|
+
# end
|
|
767
|
+
#
|
|
768
|
+
# @note Warning: If you accept a credential configuration (JSON file or Hash) from an
|
|
752
769
|
# external source for authentication to Google Cloud, you must validate it before
|
|
753
770
|
# providing it to a Google API client library. Providing an unvalidated credential
|
|
754
771
|
# configuration to Google APIs can compromise the security of your systems and data.
|
|
@@ -1752,8 +1752,6 @@ module Google
|
|
|
1752
1752
|
# @return [::String,nil]
|
|
1753
1753
|
# @!attribute [rw] credentials
|
|
1754
1754
|
# Credentials to send with calls. You may provide any of the following types:
|
|
1755
|
-
# * (`String`) The path to a service account key file in JSON format
|
|
1756
|
-
# * (`Hash`) A service account key as a Hash
|
|
1757
1755
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
|
1758
1756
|
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
|
1759
1757
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
|
@@ -1762,7 +1760,26 @@ module Google
|
|
|
1762
1760
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
|
1763
1761
|
# * (`nil`) indicating no credentials
|
|
1764
1762
|
#
|
|
1765
|
-
# Warning:
|
|
1763
|
+
# @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
|
|
1764
|
+
# is deprecated. Providing an unvalidated credential configuration to
|
|
1765
|
+
# Google APIs can compromise the security of your systems and data.
|
|
1766
|
+
#
|
|
1767
|
+
# @example
|
|
1768
|
+
#
|
|
1769
|
+
# # The recommended way to provide credentials is to use the `make_creds` method
|
|
1770
|
+
# # on the appropriate credentials class for your environment.
|
|
1771
|
+
#
|
|
1772
|
+
# require "googleauth"
|
|
1773
|
+
#
|
|
1774
|
+
# credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
|
|
1775
|
+
# json_key_io: ::File.open("/path/to/keyfile.json")
|
|
1776
|
+
# )
|
|
1777
|
+
#
|
|
1778
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngineService::Client.new do |config|
|
|
1779
|
+
# config.credentials = credentials
|
|
1780
|
+
# end
|
|
1781
|
+
#
|
|
1782
|
+
# @note Warning: If you accept a credential configuration (JSON file or Hash) from an
|
|
1766
1783
|
# external source for authentication to Google Cloud, you must validate it before
|
|
1767
1784
|
# providing it to a Google API client library. Providing an unvalidated credential
|
|
1768
1785
|
# 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:
|
|
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]
|
|
@@ -707,8 +707,6 @@ module Google
|
|
|
707
707
|
# @return [::String,nil]
|
|
708
708
|
# @!attribute [rw] credentials
|
|
709
709
|
# Credentials to send with calls. You may provide any of the following types:
|
|
710
|
-
# * (`String`) The path to a service account key file in JSON format
|
|
711
|
-
# * (`Hash`) A service account key as a Hash
|
|
712
710
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
|
713
711
|
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
|
714
712
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
|
@@ -717,7 +715,26 @@ module Google
|
|
|
717
715
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
|
718
716
|
# * (`nil`) indicating no credentials
|
|
719
717
|
#
|
|
720
|
-
# Warning:
|
|
718
|
+
# @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
|
|
719
|
+
# is deprecated. Providing an unvalidated credential configuration to
|
|
720
|
+
# Google APIs can compromise the security of your systems and data.
|
|
721
|
+
#
|
|
722
|
+
# @example
|
|
723
|
+
#
|
|
724
|
+
# # The recommended way to provide credentials is to use the `make_creds` method
|
|
725
|
+
# # on the appropriate credentials class for your environment.
|
|
726
|
+
#
|
|
727
|
+
# require "googleauth"
|
|
728
|
+
#
|
|
729
|
+
# credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
|
|
730
|
+
# json_key_io: ::File.open("/path/to/keyfile.json")
|
|
731
|
+
# )
|
|
732
|
+
#
|
|
733
|
+
# client = ::Google::Cloud::DiscoveryEngine::V1beta::UserEventService::Client.new do |config|
|
|
734
|
+
# config.credentials = credentials
|
|
735
|
+
# end
|
|
736
|
+
#
|
|
737
|
+
# @note Warning: If you accept a credential configuration (JSON file or Hash) from an
|
|
721
738
|
# external source for authentication to Google Cloud, you must validate it before
|
|
722
739
|
# providing it to a Google API client library. Providing an unvalidated credential
|
|
723
740
|
# 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:
|
|
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]
|
|
@@ -83,6 +83,18 @@ module Google
|
|
|
83
83
|
# @!attribute [rw] page_token
|
|
84
84
|
# @return [::String]
|
|
85
85
|
# The standard list page token.
|
|
86
|
+
# @!attribute [rw] return_partial_success
|
|
87
|
+
# @return [::Boolean]
|
|
88
|
+
# When set to `true`, operations that are reachable are returned as normal,
|
|
89
|
+
# and those that are unreachable are returned in the
|
|
90
|
+
# [ListOperationsResponse.unreachable] field.
|
|
91
|
+
#
|
|
92
|
+
# This can only be `true` when reading across collections e.g. when `parent`
|
|
93
|
+
# is set to `"projects/example/locations/-"`.
|
|
94
|
+
#
|
|
95
|
+
# This field is not by default supported and will result in an
|
|
96
|
+
# `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
|
|
97
|
+
# service or product specific documentation.
|
|
86
98
|
class ListOperationsRequest
|
|
87
99
|
include ::Google::Protobuf::MessageExts
|
|
88
100
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -96,6 +108,12 @@ module Google
|
|
|
96
108
|
# @!attribute [rw] next_page_token
|
|
97
109
|
# @return [::String]
|
|
98
110
|
# The standard List next-page token.
|
|
111
|
+
# @!attribute [rw] unreachable
|
|
112
|
+
# @return [::Array<::String>]
|
|
113
|
+
# Unordered list. Unreachable resources. Populated when the request sets
|
|
114
|
+
# `ListOperationsRequest.return_partial_success` and reads across
|
|
115
|
+
# collections e.g. when attempting to list all resources across all supported
|
|
116
|
+
# locations.
|
|
99
117
|
class ListOperationsResponse
|
|
100
118
|
include ::Google::Protobuf::MessageExts
|
|
101
119
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|