google-cloud-recommendation_engine-v1beta1 0.14.0 → 0.15.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: af088d6430e4882541088b00cfc55fc5775295e6b01c397b5185c9db28e14032
4
- data.tar.gz: c1c191eddfdd511133729edefb21b08036460a6310f25000b9d0845bbaa0422c
3
+ metadata.gz: a3767e7ea4d9083f4ee68c729c79eba31b2c0872b71f02207a7db6620d0c2811
4
+ data.tar.gz: bf1f374600ac9f2572189d602eb35c6a78a5ca1bc4b417d7286c53e6f6f75ca0
5
5
  SHA512:
6
- metadata.gz: 84d9846d5aca206ce37fc1d221366abf54a9e4a0b500822007395e6a466d4a8ce980ae026f1fc8cacec63b1dd2344b88c5b44ccf6a0ba4060cefe3b56a095400
7
- data.tar.gz: 5a7d2d0080ba4252578f963ff94a6d89b2445696c7685ba40bf75eeff35b91feac887d639d07b5da176301c904721a8be653e3a2cfc947157c02025f0f6506f7
6
+ metadata.gz: fbdc4d3cd107d8b959b0c0b1461fe228ed69e1f0491db06e2bba868ef765593f668423808f7839e451949c18b550908d18ff8c81771ab87d2b5bca524211a3f5
7
+ data.tar.gz: f074efd0abd39ec29a4b51ce32158537ff58279f6c4232f70746d03090d89180a5ef0257986cf0472264116fc92e725157cbca52ace4c6d98bdfc92245f943d4
@@ -822,8 +822,6 @@ module Google
822
822
  # @return [::String,nil]
823
823
  # @!attribute [rw] credentials
824
824
  # Credentials to send with calls. You may provide any of the following types:
825
- # * (`String`) The path to a service account key file in JSON format
826
- # * (`Hash`) A service account key as a Hash
827
825
  # * (`Google::Auth::Credentials`) A googleauth credentials object
828
826
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
829
827
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -832,7 +830,26 @@ module Google
832
830
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
833
831
  # * (`nil`) indicating no credentials
834
832
  #
835
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
833
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
834
+ # is deprecated. Providing an unvalidated credential configuration to
835
+ # Google APIs can compromise the security of your systems and data.
836
+ #
837
+ # @example
838
+ #
839
+ # # The recommended way to provide credentials is to use the `make_creds` method
840
+ # # on the appropriate credentials class for your environment.
841
+ #
842
+ # require "googleauth"
843
+ #
844
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
845
+ # json_key_io: ::File.open("/path/to/keyfile.json")
846
+ # )
847
+ #
848
+ # client = ::Google::Cloud::RecommendationEngine::V1beta1::CatalogService::Client.new do |config|
849
+ # config.credentials = credentials
850
+ # end
851
+ #
852
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
836
853
  # external source for authentication to Google Cloud, you must validate it before
837
854
  # providing it to a Google API client library. Providing an unvalidated credential
838
855
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -134,7 +134,7 @@ module Google
134
134
  # @param options [::Gapic::CallOptions, ::Hash]
135
135
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
136
136
  #
137
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
137
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
138
138
  # Pass arguments to `list_operations` via keyword arguments. Note that at
139
139
  # least one keyword argument is required. To specify no parameters, or to keep all
140
140
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -147,6 +147,17 @@ module Google
147
147
  # The standard list page size.
148
148
  # @param page_token [::String]
149
149
  # The standard list page token.
150
+ # @param return_partial_success [::Boolean]
151
+ # When set to `true`, operations that are reachable are returned as normal,
152
+ # and those that are unreachable are returned in the
153
+ # [ListOperationsResponse.unreachable] field.
154
+ #
155
+ # This can only be `true` when reading across collections e.g. when `parent`
156
+ # is set to `"projects/example/locations/-"`.
157
+ #
158
+ # This field is not by default supported and will result in an
159
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
160
+ # service or product specific documentation.
150
161
  #
151
162
  # @yield [response, operation] Access the result along with the RPC operation
152
163
  # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]
@@ -631,8 +642,6 @@ module Google
631
642
  # @return [::String,nil]
632
643
  # @!attribute [rw] credentials
633
644
  # Credentials to send with calls. You may provide any of the following types:
634
- # * (`String`) The path to a service account key file in JSON format
635
- # * (`Hash`) A service account key as a Hash
636
645
  # * (`Google::Auth::Credentials`) A googleauth credentials object
637
646
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
638
647
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -641,7 +650,26 @@ module Google
641
650
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
642
651
  # * (`nil`) indicating no credentials
643
652
  #
644
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
653
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
654
+ # is deprecated. Providing an unvalidated credential configuration to
655
+ # Google APIs can compromise the security of your systems and data.
656
+ #
657
+ # @example
658
+ #
659
+ # # The recommended way to provide credentials is to use the `make_creds` method
660
+ # # on the appropriate credentials class for your environment.
661
+ #
662
+ # require "googleauth"
663
+ #
664
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
665
+ # json_key_io: ::File.open("/path/to/keyfile.json")
666
+ # )
667
+ #
668
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
669
+ # config.credentials = credentials
670
+ # end
671
+ #
672
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
645
673
  # external source for authentication to Google Cloud, you must validate it before
646
674
  # providing it to a Google API client library. Providing an unvalidated credential
647
675
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -125,7 +125,7 @@ module Google
125
125
  # @param options [::Gapic::CallOptions, ::Hash]
126
126
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
127
127
  #
128
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
128
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
129
129
  # Pass arguments to `list_operations` via keyword arguments. Note that at
130
130
  # least one keyword argument is required. To specify no parameters, or to keep all
131
131
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -138,6 +138,17 @@ module Google
138
138
  # The standard list page size.
139
139
  # @param page_token [::String]
140
140
  # The standard list page token.
141
+ # @param return_partial_success [::Boolean]
142
+ # When set to `true`, operations that are reachable are returned as normal,
143
+ # and those that are unreachable are returned in the
144
+ # [ListOperationsResponse.unreachable] field.
145
+ #
146
+ # This can only be `true` when reading across collections e.g. when `parent`
147
+ # is set to `"projects/example/locations/-"`.
148
+ #
149
+ # This field is not by default supported and will result in an
150
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
151
+ # service or product specific documentation.
141
152
  # @yield [result, operation] Access the result along with the TransportOperation object
142
153
  # @yieldparam result [::Gapic::Operation]
143
154
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -508,8 +508,6 @@ module Google
508
508
  # @return [::String,nil]
509
509
  # @!attribute [rw] credentials
510
510
  # Credentials to send with calls. You may provide any of the following types:
511
- # * (`String`) The path to a service account key file in JSON format
512
- # * (`Hash`) A service account key as a Hash
513
511
  # * (`Google::Auth::Credentials`) A googleauth credentials object
514
512
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
515
513
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -518,7 +516,26 @@ module Google
518
516
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
519
517
  # * (`nil`) indicating no credentials
520
518
  #
521
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
519
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
520
+ # is deprecated. Providing an unvalidated credential configuration to
521
+ # Google APIs can compromise the security of your systems and data.
522
+ #
523
+ # @example
524
+ #
525
+ # # The recommended way to provide credentials is to use the `make_creds` method
526
+ # # on the appropriate credentials class for your environment.
527
+ #
528
+ # require "googleauth"
529
+ #
530
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
531
+ # json_key_io: ::File.open("/path/to/keyfile.json")
532
+ # )
533
+ #
534
+ # client = ::Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistry::Client.new do |config|
535
+ # config.credentials = credentials
536
+ # end
537
+ #
538
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
522
539
  # external source for authentication to Google Cloud, you must validate it before
523
540
  # providing it to a Google API client library. Providing an unvalidated credential
524
541
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -404,8 +404,6 @@ module Google
404
404
  # @return [::String,nil]
405
405
  # @!attribute [rw] credentials
406
406
  # Credentials to send with calls. You may provide any of the following types:
407
- # * (`String`) The path to a service account key file in JSON format
408
- # * (`Hash`) A service account key as a Hash
409
407
  # * (`Google::Auth::Credentials`) A googleauth credentials object
410
408
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
411
409
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -414,7 +412,26 @@ module Google
414
412
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
415
413
  # * (`nil`) indicating no credentials
416
414
  #
417
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
415
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
416
+ # is deprecated. Providing an unvalidated credential configuration to
417
+ # Google APIs can compromise the security of your systems and data.
418
+ #
419
+ # @example
420
+ #
421
+ # # The recommended way to provide credentials is to use the `make_creds` method
422
+ # # on the appropriate credentials class for your environment.
423
+ #
424
+ # require "googleauth"
425
+ #
426
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
427
+ # json_key_io: ::File.open("/path/to/keyfile.json")
428
+ # )
429
+ #
430
+ # client = ::Google::Cloud::RecommendationEngine::V1beta1::PredictionService::Client.new do |config|
431
+ # config.credentials = credentials
432
+ # end
433
+ #
434
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
418
435
  # external source for authentication to Google Cloud, you must validate it before
419
436
  # providing it to a Google API client library. Providing an unvalidated credential
420
437
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -810,8 +810,6 @@ module Google
810
810
  # @return [::String,nil]
811
811
  # @!attribute [rw] credentials
812
812
  # Credentials to send with calls. You may provide any of the following types:
813
- # * (`String`) The path to a service account key file in JSON format
814
- # * (`Hash`) A service account key as a Hash
815
813
  # * (`Google::Auth::Credentials`) A googleauth credentials object
816
814
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
817
815
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -820,7 +818,26 @@ module Google
820
818
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
821
819
  # * (`nil`) indicating no credentials
822
820
  #
823
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
821
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
822
+ # is deprecated. Providing an unvalidated credential configuration to
823
+ # Google APIs can compromise the security of your systems and data.
824
+ #
825
+ # @example
826
+ #
827
+ # # The recommended way to provide credentials is to use the `make_creds` method
828
+ # # on the appropriate credentials class for your environment.
829
+ #
830
+ # require "googleauth"
831
+ #
832
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
833
+ # json_key_io: ::File.open("/path/to/keyfile.json")
834
+ # )
835
+ #
836
+ # client = ::Google::Cloud::RecommendationEngine::V1beta1::UserEventService::Client.new do |config|
837
+ # config.credentials = credentials
838
+ # end
839
+ #
840
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
824
841
  # external source for authentication to Google Cloud, you must validate it before
825
842
  # providing it to a Google API client library. Providing an unvalidated credential
826
843
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -134,7 +134,7 @@ module Google
134
134
  # @param options [::Gapic::CallOptions, ::Hash]
135
135
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
136
136
  #
137
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
137
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
138
138
  # Pass arguments to `list_operations` via keyword arguments. Note that at
139
139
  # least one keyword argument is required. To specify no parameters, or to keep all
140
140
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -147,6 +147,17 @@ module Google
147
147
  # The standard list page size.
148
148
  # @param page_token [::String]
149
149
  # The standard list page token.
150
+ # @param return_partial_success [::Boolean]
151
+ # When set to `true`, operations that are reachable are returned as normal,
152
+ # and those that are unreachable are returned in the
153
+ # [ListOperationsResponse.unreachable] field.
154
+ #
155
+ # This can only be `true` when reading across collections e.g. when `parent`
156
+ # is set to `"projects/example/locations/-"`.
157
+ #
158
+ # This field is not by default supported and will result in an
159
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
160
+ # service or product specific documentation.
150
161
  #
151
162
  # @yield [response, operation] Access the result along with the RPC operation
152
163
  # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]
@@ -631,8 +642,6 @@ module Google
631
642
  # @return [::String,nil]
632
643
  # @!attribute [rw] credentials
633
644
  # Credentials to send with calls. You may provide any of the following types:
634
- # * (`String`) The path to a service account key file in JSON format
635
- # * (`Hash`) A service account key as a Hash
636
645
  # * (`Google::Auth::Credentials`) A googleauth credentials object
637
646
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
638
647
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -641,7 +650,26 @@ module Google
641
650
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
642
651
  # * (`nil`) indicating no credentials
643
652
  #
644
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
653
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
654
+ # is deprecated. Providing an unvalidated credential configuration to
655
+ # Google APIs can compromise the security of your systems and data.
656
+ #
657
+ # @example
658
+ #
659
+ # # The recommended way to provide credentials is to use the `make_creds` method
660
+ # # on the appropriate credentials class for your environment.
661
+ #
662
+ # require "googleauth"
663
+ #
664
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
665
+ # json_key_io: ::File.open("/path/to/keyfile.json")
666
+ # )
667
+ #
668
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
669
+ # config.credentials = credentials
670
+ # end
671
+ #
672
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
645
673
  # external source for authentication to Google Cloud, you must validate it before
646
674
  # providing it to a Google API client library. Providing an unvalidated credential
647
675
  # configuration to Google APIs can compromise the security of your systems and data.
@@ -125,7 +125,7 @@ module Google
125
125
  # @param options [::Gapic::CallOptions, ::Hash]
126
126
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
127
127
  #
128
- # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
128
+ # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
129
129
  # Pass arguments to `list_operations` via keyword arguments. Note that at
130
130
  # least one keyword argument is required. To specify no parameters, or to keep all
131
131
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -138,6 +138,17 @@ module Google
138
138
  # The standard list page size.
139
139
  # @param page_token [::String]
140
140
  # The standard list page token.
141
+ # @param return_partial_success [::Boolean]
142
+ # When set to `true`, operations that are reachable are returned as normal,
143
+ # and those that are unreachable are returned in the
144
+ # [ListOperationsResponse.unreachable] field.
145
+ #
146
+ # This can only be `true` when reading across collections e.g. when `parent`
147
+ # is set to `"projects/example/locations/-"`.
148
+ #
149
+ # This field is not by default supported and will result in an
150
+ # `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
151
+ # service or product specific documentation.
141
152
  # @yield [result, operation] Access the result along with the TransportOperation object
142
153
  # @yieldparam result [::Gapic::Operation]
143
154
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module RecommendationEngine
23
23
  module V1beta1
24
- VERSION = "0.14.0"
24
+ VERSION = "0.15.1"
25
25
  end
26
26
  end
27
27
  end
@@ -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
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-recommendation_engine-v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.14.0
4
+ version: 0.15.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC