Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::WriteUserEventRequest.
Request message for WriteUserEvent method.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#parent
defparent()->::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 [Location][] level, for
example, the event with
Document across multiple
DataStore, the format is:
projects/{project}/locations/{location}.
#parent=
defparent=(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 [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}.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::WriteUserEventRequest (v0.21.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.21.0 (latest)](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.20.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.20.1/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.19.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.19.1/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.18.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.18.0/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.17.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.17.0/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.16.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.16.0/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.15.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.15.0/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.14.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.14.2/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.13.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.13.0/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.12.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.12.0/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.11.0/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.10.0/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.9.0/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.8.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.8.0/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.7.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.7.2/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.6.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.6.0/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.5.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.5.0/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.4.0/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.3.0/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.2.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.2.1/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest)\n- [0.1.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.1.0/Google-Cloud-DiscoveryEngine-V1beta-WriteUserEventRequest) \nReference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::WriteUserEventRequest.\n\nRequest message for WriteUserEvent method. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The parent resource name. If the write user event action is applied in [DataStore](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-DataStore \"Google::Cloud::DiscoveryEngine::V1beta::DataStore (class)\") 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](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Document \"Google::Cloud::DiscoveryEngine::V1beta::Document (class)\") across multiple [DataStore](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-DataStore \"Google::Cloud::DiscoveryEngine::V1beta::DataStore (class)\"), the format is: `projects/{project}/locations/{location}`.\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The parent resource name. If the write user event action is applied in [DataStore](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-DataStore \"Google::Cloud::DiscoveryEngine::V1beta::DataStore (class)\") 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](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Document \"Google::Cloud::DiscoveryEngine::V1beta::Document (class)\") across multiple [DataStore](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-DataStore \"Google::Cloud::DiscoveryEngine::V1beta::DataStore (class)\"), the format is: `projects/{project}/locations/{location}`. \n**Returns**\n\n- (::String) --- Required. The parent resource name. If the write user event action is applied in [DataStore](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-DataStore \"Google::Cloud::DiscoveryEngine::V1beta::DataStore (class)\") 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](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Document \"Google::Cloud::DiscoveryEngine::V1beta::Document (class)\") across multiple [DataStore](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-DataStore \"Google::Cloud::DiscoveryEngine::V1beta::DataStore (class)\"), the format is: `projects/{project}/locations/{location}`.\n\n### #user_event\n\n def user_event() -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::UserEvent\n\n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::UserEvent](./Google-Cloud-DiscoveryEngine-V1beta-UserEvent)) --- Required. User event to write.\n\n### #user_event=\n\n def user_event=(value) -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::UserEvent\n\n**Parameter**\n\n- **value** ([::Google::Cloud::DiscoveryEngine::V1beta::UserEvent](./Google-Cloud-DiscoveryEngine-V1beta-UserEvent)) --- Required. User event to write. \n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::UserEvent](./Google-Cloud-DiscoveryEngine-V1beta-UserEvent)) --- Required. User event to write.\n\n### #write_async\n\n def write_async() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.\n\n### #write_async=\n\n def write_async=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. \n**Returns**\n\n- (::Boolean) --- If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write."]]
