Class: Google::Cloud::Retail::V2::RejoinUserEventsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/user_event_service.rb

Overview

Request message for RejoinUserEvents method.

Defined Under Namespace

Modules: UserEventRejoinScope

Instance Attribute Summary collapse

Instance Attribute Details

#parent ⇒ ::String

Returns Required. The parent catalog resource name, such as projects/1234/locations/global/catalogs/default_catalog.

Returns:

  • (::String) —

    Required. The parent catalog resource name, such as projects/1234/locations/global/catalogs/default_catalog.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/retail/v2/user_event_service.rb', line 89

class RejoinUserEventsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The scope of user events to be rejoined with the latest product catalog.
  # If the rejoining aims at reducing number of unjoined events, set
  # `UserEventRejoinScope` to `UNJOINED_EVENTS`.
  # If the rejoining aims at correcting product catalog information in joined
  # events, set `UserEventRejoinScope` to `JOINED_EVENTS`.
  # If all events needs to be rejoined, set `UserEventRejoinScope` to
  # `USER_EVENT_REJOIN_SCOPE_UNSPECIFIED`.
  module UserEventRejoinScope
    # Rejoin all events with the latest product catalog, including both joined
    # events and unjoined events.
    USER_EVENT_REJOIN_SCOPE_UNSPECIFIED = 0

    # Only rejoin joined events with the latest product catalog.
    JOINED_EVENTS = 1

    # Only rejoin unjoined events with the latest product catalog.
    UNJOINED_EVENTS = 2
  end
end

#user_event_rejoin_scope ⇒ ::Google::Cloud::Retail::V2::RejoinUserEventsRequest::UserEventRejoinScope

Returns The type of the user event rejoin to define the scope and range of the user events to be rejoined with the latest product catalog. Defaults to USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to an invalid integer value.

Returns:



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/retail/v2/user_event_service.rb', line 89

class RejoinUserEventsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The scope of user events to be rejoined with the latest product catalog.
  # If the rejoining aims at reducing number of unjoined events, set
  # `UserEventRejoinScope` to `UNJOINED_EVENTS`.
  # If the rejoining aims at correcting product catalog information in joined
  # events, set `UserEventRejoinScope` to `JOINED_EVENTS`.
  # If all events needs to be rejoined, set `UserEventRejoinScope` to
  # `USER_EVENT_REJOIN_SCOPE_UNSPECIFIED`.
  module UserEventRejoinScope
    # Rejoin all events with the latest product catalog, including both joined
    # events and unjoined events.
    USER_EVENT_REJOIN_SCOPE_UNSPECIFIED = 0

    # Only rejoin joined events with the latest product catalog.
    JOINED_EVENTS = 1

    # Only rejoin unjoined events with the latest product catalog.
    UNJOINED_EVENTS = 2
  end
end