Class: Google::Cloud::DiscoveryEngine::V1::WriteUserEventRequest

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

Overview

Request message for WriteUserEvent method.

Instance Attribute Summary collapse

Instance Attribute Details

#parent ⇒ ::String

Returns 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 [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 [Location][] level, for example, the event with Document across multiple DataStore, the format is: projects/{project}/locations/{location}.



44
45
46
47
 
# File 'proto_docs/google/cloud/discoveryengine/v1/user_event_service.rb', line 44

class WriteUserEventRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#user_event ⇒ ::Google::Cloud::DiscoveryEngine::V1::UserEvent

Returns Required. User event to write.

Returns:



44
45
46
47
 
# File 'proto_docs/google/cloud/discoveryengine/v1/user_event_service.rb', line 44

class WriteUserEventRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#write_async ⇒ ::Boolean

Returns 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.



44
45
46
47
 
# File 'proto_docs/google/cloud/discoveryengine/v1/user_event_service.rb', line 44

class WriteUserEventRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end