google-cloud-retail-v2 0.17.0 → 0.18.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -101
- data/lib/google/cloud/retail/v2/catalog_service/client.rb +38 -14
- data/lib/google/cloud/retail/v2/catalog_service/rest/client.rb +36 -9
- data/lib/google/cloud/retail/v2/catalog_service/rest/service_stub.rb +23 -2
- data/lib/google/cloud/retail/v2/completion_service/client.rb +39 -14
- data/lib/google/cloud/retail/v2/completion_service/operations.rb +28 -6
- data/lib/google/cloud/retail/v2/completion_service/rest/client.rb +37 -9
- data/lib/google/cloud/retail/v2/completion_service/rest/operations.rb +33 -8
- data/lib/google/cloud/retail/v2/completion_service/rest/service_stub.rb +23 -2
- data/lib/google/cloud/retail/v2/control_service/client.rb +38 -14
- data/lib/google/cloud/retail/v2/control_service/rest/client.rb +36 -9
- data/lib/google/cloud/retail/v2/control_service/rest/service_stub.rb +23 -2
- data/lib/google/cloud/retail/v2/model_service/client.rb +39 -14
- data/lib/google/cloud/retail/v2/model_service/operations.rb +28 -6
- data/lib/google/cloud/retail/v2/model_service/rest/client.rb +37 -9
- data/lib/google/cloud/retail/v2/model_service/rest/operations.rb +33 -8
- data/lib/google/cloud/retail/v2/model_service/rest/service_stub.rb +23 -2
- data/lib/google/cloud/retail/v2/prediction_service/client.rb +38 -14
- data/lib/google/cloud/retail/v2/prediction_service/rest/client.rb +36 -9
- data/lib/google/cloud/retail/v2/prediction_service/rest/service_stub.rb +23 -2
- data/lib/google/cloud/retail/v2/product_service/client.rb +39 -14
- data/lib/google/cloud/retail/v2/product_service/operations.rb +28 -6
- data/lib/google/cloud/retail/v2/product_service/rest/client.rb +37 -9
- data/lib/google/cloud/retail/v2/product_service/rest/operations.rb +33 -8
- data/lib/google/cloud/retail/v2/product_service/rest/service_stub.rb +23 -2
- data/lib/google/cloud/retail/v2/search_service/client.rb +38 -14
- data/lib/google/cloud/retail/v2/search_service/rest/client.rb +36 -9
- data/lib/google/cloud/retail/v2/search_service/rest/service_stub.rb +23 -2
- data/lib/google/cloud/retail/v2/serving_config_service/client.rb +38 -14
- data/lib/google/cloud/retail/v2/serving_config_service/rest/client.rb +36 -9
- data/lib/google/cloud/retail/v2/serving_config_service/rest/service_stub.rb +23 -2
- data/lib/google/cloud/retail/v2/user_event_service/client.rb +39 -14
- data/lib/google/cloud/retail/v2/user_event_service/operations.rb +28 -6
- data/lib/google/cloud/retail/v2/user_event_service/rest/client.rb +37 -9
- data/lib/google/cloud/retail/v2/user_event_service/rest/operations.rb +33 -8
- data/lib/google/cloud/retail/v2/user_event_service/rest/service_stub.rb +23 -2
- data/lib/google/cloud/retail/v2/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/cloud/retail/v2/common.rb +2 -0
- data/proto_docs/google/cloud/retail/v2/import_config.rb +2 -0
- data/proto_docs/google/cloud/retail/v2/prediction_service.rb +1 -0
- data/proto_docs/google/cloud/retail/v2/product.rb +1 -0
- data/proto_docs/google/cloud/retail/v2/search_service.rb +1 -0
- metadata +7 -7
@@ -33,6 +33,9 @@ module Google
|
|
33
33
|
# Service for ingesting end user actions on the customer website.
|
34
34
|
#
|
35
35
|
class Client
|
36
|
+
# @private
|
37
|
+
DEFAULT_ENDPOINT_TEMPLATE = "retail.$UNIVERSE_DOMAIN$"
|
38
|
+
|
36
39
|
include Paths
|
37
40
|
|
38
41
|
# @private
|
@@ -108,6 +111,15 @@ module Google
|
|
108
111
|
@config
|
109
112
|
end
|
110
113
|
|
114
|
+
##
|
115
|
+
# The effective universe domain
|
116
|
+
#
|
117
|
+
# @return [String]
|
118
|
+
#
|
119
|
+
def universe_domain
|
120
|
+
@user_event_service_stub.universe_domain
|
121
|
+
end
|
122
|
+
|
111
123
|
##
|
112
124
|
# Create a new UserEventService REST client object.
|
113
125
|
#
|
@@ -135,8 +147,9 @@ module Google
|
|
135
147
|
credentials = @config.credentials
|
136
148
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
137
149
|
# but only if the default endpoint does not have a region prefix.
|
138
|
-
enable_self_signed_jwt = @config.endpoint
|
139
|
-
|
150
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
151
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
152
|
+
!@config.endpoint.split(".").first.include?("-"))
|
140
153
|
credentials ||= Credentials.default scope: @config.scope,
|
141
154
|
enable_self_signed_jwt: enable_self_signed_jwt
|
142
155
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -150,15 +163,22 @@ module Google
|
|
150
163
|
config.credentials = credentials
|
151
164
|
config.quota_project = @quota_project_id
|
152
165
|
config.endpoint = @config.endpoint
|
166
|
+
config.universe_domain = @config.universe_domain
|
153
167
|
end
|
154
168
|
|
169
|
+
@user_event_service_stub = ::Google::Cloud::Retail::V2::UserEventService::Rest::ServiceStub.new(
|
170
|
+
endpoint: @config.endpoint,
|
171
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
172
|
+
universe_domain: @config.universe_domain,
|
173
|
+
credentials: credentials
|
174
|
+
)
|
175
|
+
|
155
176
|
@location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
|
156
177
|
config.credentials = credentials
|
157
178
|
config.quota_project = @quota_project_id
|
158
|
-
config.endpoint = @
|
179
|
+
config.endpoint = @user_event_service_stub.endpoint
|
180
|
+
config.universe_domain = @user_event_service_stub.universe_domain
|
159
181
|
end
|
160
|
-
|
161
|
-
@user_event_service_stub = ::Google::Cloud::Retail::V2::UserEventService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
|
162
182
|
end
|
163
183
|
|
164
184
|
##
|
@@ -711,9 +731,9 @@ module Google
|
|
711
731
|
# end
|
712
732
|
#
|
713
733
|
# @!attribute [rw] endpoint
|
714
|
-
#
|
715
|
-
#
|
716
|
-
# @return [::String]
|
734
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
735
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
736
|
+
# @return [::String,nil]
|
717
737
|
# @!attribute [rw] credentials
|
718
738
|
# Credentials to send with calls. You may provide any of the following types:
|
719
739
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -750,13 +770,20 @@ module Google
|
|
750
770
|
# @!attribute [rw] quota_project
|
751
771
|
# A separate project against which to charge quota.
|
752
772
|
# @return [::String]
|
773
|
+
# @!attribute [rw] universe_domain
|
774
|
+
# The universe domain within which to make requests. This determines the
|
775
|
+
# default endpoint URL. The default value of nil uses the environment
|
776
|
+
# universe (usually the default "googleapis.com" universe).
|
777
|
+
# @return [::String,nil]
|
753
778
|
#
|
754
779
|
class Configuration
|
755
780
|
extend ::Gapic::Config
|
756
781
|
|
782
|
+
# @private
|
783
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
757
784
|
DEFAULT_ENDPOINT = "retail.googleapis.com"
|
758
785
|
|
759
|
-
config_attr :endpoint,
|
786
|
+
config_attr :endpoint, nil, ::String, nil
|
760
787
|
config_attr :credentials, nil do |value|
|
761
788
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
762
789
|
allowed.any? { |klass| klass === value }
|
@@ -768,6 +795,7 @@ module Google
|
|
768
795
|
config_attr :metadata, nil, ::Hash, nil
|
769
796
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
770
797
|
config_attr :quota_project, nil, ::String, nil
|
798
|
+
config_attr :universe_domain, nil, ::String, nil
|
771
799
|
|
772
800
|
# @private
|
773
801
|
def initialize parent_config = nil
|
@@ -26,6 +26,9 @@ module Google
|
|
26
26
|
module Rest
|
27
27
|
# Service that implements Longrunning Operations API.
|
28
28
|
class Operations
|
29
|
+
# @private
|
30
|
+
DEFAULT_ENDPOINT_TEMPLATE = "retail.$UNIVERSE_DOMAIN$"
|
31
|
+
|
29
32
|
# @private
|
30
33
|
attr_reader :operations_stub
|
31
34
|
|
@@ -60,6 +63,15 @@ module Google
|
|
60
63
|
@config
|
61
64
|
end
|
62
65
|
|
66
|
+
##
|
67
|
+
# The effective universe domain
|
68
|
+
#
|
69
|
+
# @return [String]
|
70
|
+
#
|
71
|
+
def universe_domain
|
72
|
+
@operations_stub.universe_domain
|
73
|
+
end
|
74
|
+
|
63
75
|
##
|
64
76
|
# Create a new Operations client object.
|
65
77
|
#
|
@@ -84,8 +96,10 @@ module Google
|
|
84
96
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
85
97
|
|
86
98
|
@operations_stub = OperationsServiceStub.new(
|
87
|
-
endpoint:
|
88
|
-
|
99
|
+
endpoint: @config.endpoint,
|
100
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
101
|
+
universe_domain: @config.universe_domain,
|
102
|
+
credentials: credentials
|
89
103
|
)
|
90
104
|
|
91
105
|
# Used by an LRO wrapper for some methods of this service
|
@@ -478,9 +492,9 @@ module Google
|
|
478
492
|
# end
|
479
493
|
#
|
480
494
|
# @!attribute [rw] endpoint
|
481
|
-
#
|
482
|
-
#
|
483
|
-
# @return [::String]
|
495
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
496
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
497
|
+
# @return [::String,nil]
|
484
498
|
# @!attribute [rw] credentials
|
485
499
|
# Credentials to send with calls. You may provide any of the following types:
|
486
500
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -517,13 +531,20 @@ module Google
|
|
517
531
|
# @!attribute [rw] quota_project
|
518
532
|
# A separate project against which to charge quota.
|
519
533
|
# @return [::String]
|
534
|
+
# @!attribute [rw] universe_domain
|
535
|
+
# The universe domain within which to make requests. This determines the
|
536
|
+
# default endpoint URL. The default value of nil uses the environment
|
537
|
+
# universe (usually the default "googleapis.com" universe).
|
538
|
+
# @return [::String,nil]
|
520
539
|
#
|
521
540
|
class Configuration
|
522
541
|
extend ::Gapic::Config
|
523
542
|
|
543
|
+
# @private
|
544
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
524
545
|
DEFAULT_ENDPOINT = "retail.googleapis.com"
|
525
546
|
|
526
|
-
config_attr :endpoint,
|
547
|
+
config_attr :endpoint, nil, ::String, nil
|
527
548
|
config_attr :credentials, nil do |value|
|
528
549
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
529
550
|
allowed.any? { |klass| klass === value }
|
@@ -535,6 +556,7 @@ module Google
|
|
535
556
|
config_attr :metadata, nil, ::Hash, nil
|
536
557
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
537
558
|
config_attr :quota_project, nil, ::String, nil
|
559
|
+
config_attr :universe_domain, nil, ::String, nil
|
538
560
|
|
539
561
|
# @private
|
540
562
|
def initialize parent_config = nil
|
@@ -617,12 +639,15 @@ module Google
|
|
617
639
|
# Service stub contains baseline method implementations
|
618
640
|
# including transcoding, making the REST call, and deserialing the response.
|
619
641
|
class OperationsServiceStub
|
620
|
-
def initialize endpoint:, credentials:
|
642
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
621
643
|
# These require statements are intentionally placed here to initialize
|
622
644
|
# the REST modules only when it's required.
|
623
645
|
require "gapic/rest"
|
624
646
|
|
625
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
647
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
648
|
+
endpoint_template: endpoint_template,
|
649
|
+
universe_domain: universe_domain,
|
650
|
+
credentials: credentials
|
626
651
|
end
|
627
652
|
|
628
653
|
##
|
@@ -30,16 +30,37 @@ module Google
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
31
31
|
#
|
32
32
|
class ServiceStub
|
33
|
-
def initialize endpoint:, credentials:
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
34
34
|
# These require statements are intentionally placed here to initialize
|
35
35
|
# the REST modules only when it's required.
|
36
36
|
require "gapic/rest"
|
37
37
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
39
|
+
endpoint_template: endpoint_template,
|
40
|
+
universe_domain: universe_domain,
|
41
|
+
credentials: credentials,
|
39
42
|
numeric_enums: true,
|
40
43
|
raise_faraday_errors: false
|
41
44
|
end
|
42
45
|
|
46
|
+
##
|
47
|
+
# The effective universe domain
|
48
|
+
#
|
49
|
+
# @return [String]
|
50
|
+
#
|
51
|
+
def universe_domain
|
52
|
+
@client_stub.universe_domain
|
53
|
+
end
|
54
|
+
|
55
|
+
##
|
56
|
+
# The effective endpoint
|
57
|
+
#
|
58
|
+
# @return [String]
|
59
|
+
#
|
60
|
+
def endpoint
|
61
|
+
@client_stub.endpoint
|
62
|
+
end
|
63
|
+
|
43
64
|
##
|
44
65
|
# Baseline implementation for the write_user_event REST call
|
45
66
|
#
|
@@ -21,6 +21,7 @@ module Google
|
|
21
21
|
module Api
|
22
22
|
# Required information for every language.
|
23
23
|
# @!attribute [rw] reference_docs_uri
|
24
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
24
25
|
# @return [::String]
|
25
26
|
# Link to automatically generated reference documentation. Example:
|
26
27
|
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
@@ -304,6 +305,19 @@ module Google
|
|
304
305
|
# seconds: 360 # 6 minutes
|
305
306
|
# total_poll_timeout:
|
306
307
|
# seconds: 54000 # 90 minutes
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
309
|
+
# @return [::Array<::String>]
|
310
|
+
# List of top-level fields of the request message, that should be
|
311
|
+
# automatically populated by the client libraries based on their
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
313
|
+
#
|
314
|
+
# Example of a YAML configuration:
|
315
|
+
#
|
316
|
+
# publishing:
|
317
|
+
# method_settings:
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
319
|
+
# auto_populated_fields:
|
320
|
+
# - request_id
|
307
321
|
class MethodSettings
|
308
322
|
include ::Google::Protobuf::MessageExts
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -384,6 +384,7 @@ module Google
|
|
384
384
|
# {::Google::Cloud::Retail::V2::CustomAttribute#numbers numbers} should be set.
|
385
385
|
# Otherwise, an INVALID_ARGUMENT error is returned.
|
386
386
|
# @!attribute [rw] searchable
|
387
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
387
388
|
# @return [::Boolean]
|
388
389
|
# This field is normally ignored unless
|
389
390
|
# {::Google::Cloud::Retail::V2::AttributesConfig#attribute_config_level AttributesConfig.attribute_config_level}
|
@@ -399,6 +400,7 @@ module Google
|
|
399
400
|
# Only set if type {::Google::Cloud::Retail::V2::CustomAttribute#text text} is
|
400
401
|
# set. Otherwise, a INVALID_ARGUMENT error is returned.
|
401
402
|
# @!attribute [rw] indexable
|
403
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
402
404
|
# @return [::Boolean]
|
403
405
|
# This field is normally ignored unless
|
404
406
|
# {::Google::Cloud::Retail::V2::AttributesConfig#attribute_config_level AttributesConfig.attribute_config_level}
|
@@ -164,6 +164,7 @@ module Google
|
|
164
164
|
# If no updateMask is specified, requires products.create permission.
|
165
165
|
# If updateMask is specified, requires products.update permission.
|
166
166
|
# @!attribute [rw] request_id
|
167
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
167
168
|
# @return [::String]
|
168
169
|
# Deprecated. This field has no effect.
|
169
170
|
# @!attribute [rw] input_config
|
@@ -309,6 +310,7 @@ module Google
|
|
309
310
|
# @return [::Integer]
|
310
311
|
# Count of entries that encountered errors while processing.
|
311
312
|
# @!attribute [rw] request_id
|
313
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
312
314
|
# @return [::String]
|
313
315
|
# Deprecated. This field is never set.
|
314
316
|
# @!attribute [rw] notification_pubsub_topic
|
@@ -61,6 +61,7 @@ module Google
|
|
61
61
|
# default. The maximum allowed value is 100. Values above 100 will be coerced
|
62
62
|
# to 100.
|
63
63
|
# @!attribute [rw] page_token
|
64
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
64
65
|
# @return [::String]
|
65
66
|
# This field is not used; leave it unset.
|
66
67
|
# @!attribute [rw] filter
|
@@ -420,6 +420,7 @@ module Google
|
|
420
420
|
# purely describes product freshness regardless of when it is available on
|
421
421
|
# search and recommendation.
|
422
422
|
# @!attribute [rw] retrievable_fields
|
423
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
423
424
|
# @return [::Google::Protobuf::FieldMask]
|
424
425
|
# Indicates which fields in the {::Google::Cloud::Retail::V2::Product Product}s
|
425
426
|
# are returned in {::Google::Cloud::Retail::V2::SearchResponse SearchResponse}.
|
@@ -127,6 +127,7 @@ module Google
|
|
127
127
|
# A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error
|
128
128
|
# is returned.
|
129
129
|
# @!attribute [rw] dynamic_facet_spec
|
130
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
130
131
|
# @return [::Google::Cloud::Retail::V2::SearchRequest::DynamicFacetSpec]
|
131
132
|
# Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic
|
132
133
|
# to enable dynamic facets. Do not set this field.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-retail-v2
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.18.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2024-01-12 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0.
|
19
|
+
version: 0.21.1
|
20
20
|
- - "<"
|
21
21
|
- !ruby/object:Gem::Version
|
22
22
|
version: 2.a
|
@@ -26,7 +26,7 @@ dependencies:
|
|
26
26
|
requirements:
|
27
27
|
- - ">="
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version: 0.
|
29
|
+
version: 0.21.1
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -50,7 +50,7 @@ dependencies:
|
|
50
50
|
requirements:
|
51
51
|
- - ">="
|
52
52
|
- !ruby/object:Gem::Version
|
53
|
-
version: '0.
|
53
|
+
version: '0.7'
|
54
54
|
- - "<"
|
55
55
|
- !ruby/object:Gem::Version
|
56
56
|
version: 2.a
|
@@ -60,7 +60,7 @@ dependencies:
|
|
60
60
|
requirements:
|
61
61
|
- - ">="
|
62
62
|
- !ruby/object:Gem::Version
|
63
|
-
version: '0.
|
63
|
+
version: '0.7'
|
64
64
|
- - "<"
|
65
65
|
- !ruby/object:Gem::Version
|
66
66
|
version: 2.a
|
@@ -347,7 +347,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
347
347
|
- !ruby/object:Gem::Version
|
348
348
|
version: '0'
|
349
349
|
requirements: []
|
350
|
-
rubygems_version: 3.
|
350
|
+
rubygems_version: 3.5.3
|
351
351
|
signing_key:
|
352
352
|
specification_version: 4
|
353
353
|
summary: Cloud Retail service enables customers to build end-to-end personalized recommendation
|