Class: Google::Cloud::DiscoveryEngine::V1beta::UserEventService::Rest::Client
- Inherits:
-
Object
- Object
- Google::Cloud::DiscoveryEngine::V1beta::UserEventService::Rest::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb
Overview
REST client for the UserEventService service.
Service for ingesting end user actions on a website to Discovery Engine API.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
-
#operations_client ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::UserEventService::Rest::Operations
readonly
Get the associated client for long-running operations.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the UserEventService Client class.
Instance Method Summary collapse
-
#collect_user_event(request, options = nil) {|result, operation| ... } ⇒ ::Google::Api::HttpBody
Writes a single user event from the browser.
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the UserEventService Client instance.
-
#import_user_events(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Operation
Bulk import of User events.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new UserEventService REST client object.
-
#write_user_event(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::UserEvent
Writes a single user event.
Methods included from Paths
#data_store_path, #document_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new UserEventService REST client object.
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb', line 121 def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = ::Google::Cloud::DiscoveryEngine::V1beta::UserEventService::Rest::Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @user_event_service_stub = ::Google::Cloud::DiscoveryEngine::V1beta::UserEventService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end |
Instance Attribute Details
#operations_client ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::UserEventService::Rest::Operations (readonly)
Get the associated client for long-running operations.
157 158 159 |
# File 'lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb', line 157 def operations_client @operations_client end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the UserEventService Client class.
See Configuration for a description of the configuration fields.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb', line 58 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "DiscoveryEngine", "V1beta"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.timeout = 30.0 default_config.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.import_user_events.timeout = 300.0 default_config.rpcs.import_user_events.retry_policy = { initial_delay: 1.0, max_delay: 30.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end |
Instance Method Details
#collect_user_event(request, options = nil) ⇒ ::Google::Api::HttpBody #collect_user_event(parent: nil, user_event: nil, uri: nil, ets: nil) ⇒ ::Google::Api::HttpBody
Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain.
This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 |
# File 'lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb', line 270 def collect_user_event request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::CollectUserEventRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.collect_user_event..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.collect_user_event.timeout, metadata: , retry_policy: @config.rpcs.collect_user_event.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @user_event_service_stub.collect_user_event request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#configure {|config| ... } ⇒ Client::Configuration
Configure the UserEventService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See Configuration for a description of the configuration fields.
100 101 102 103 |
# File 'lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb', line 100 def configure yield @config if block_given? @config end |
#import_user_events(request, options = nil) ⇒ ::Gapic::Operation #import_user_events(inline_source: nil, gcs_source: nil, bigquery_source: nil, parent: nil, error_config: nil) ⇒ ::Gapic::Operation
Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.
Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 |
# File 'lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb', line 348 def import_user_events request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::ImportUserEventsRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.import_user_events..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.import_user_events.timeout, metadata: , retry_policy: @config.rpcs.import_user_events.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @user_event_service_stub.import_user_events request, do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#write_user_event(request, options = nil) ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::UserEvent #write_user_event(parent: nil, user_event: nil) ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::UserEvent
Writes a single user event.
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
# File 'lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb', line 191 def write_user_event request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::WriteUserEventRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.write_user_event..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.write_user_event.timeout, metadata: , retry_policy: @config.rpcs.write_user_event.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @user_event_service_stub.write_user_event request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |