Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::WriteUserEventRequest (v2.2.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::WriteUserEventRequest.

Request message for WriteUserEvent method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}. If the write user event action is applied in ::Google::Cloud::Location::Location level, for example, the event with Document across multiple DataStore, the format is: projects/{project}/locations/{location}.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}. If the write user event action is applied in ::Google::Cloud::Location::Location level, for example, the event with Document across multiple DataStore, the format is: projects/{project}/locations/{location}.
Returns
  • (::String) — Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}. If the write user event action is applied in ::Google::Cloud::Location::Location level, for example, the event with Document across multiple DataStore, the format is: projects/{project}/locations/{location}.

#user_event

def user_event() -> ::Google::Cloud::DiscoveryEngine::V1::UserEvent
Returns

#user_event=

def user_event=(value) -> ::Google::Cloud::DiscoveryEngine::V1::UserEvent
Parameter
Returns

#write_async

def write_async() -> ::Boolean
Returns
  • (::Boolean) — If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.

#write_async=

def write_async=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.
Returns
  • (::Boolean) — If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.