[[["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::Session (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-Session)\n- [0.20.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.20.1/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.19.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.19.1/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.18.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.18.0/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.17.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.17.0/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.16.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.16.0/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.15.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.15.0/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.14.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.14.2/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.13.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.13.0/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.12.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.12.0/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.11.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.11.0/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.10.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.10.0/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.9.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.9.0/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.8.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.8.0/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.7.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.7.2/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.6.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.6.0/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.5.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.5.0/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.4.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.4.0/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.3.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.3.0/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.2.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.2.1/Google-Cloud-DiscoveryEngine-V1beta-Session)\n- [0.1.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.1.0/Google-Cloud-DiscoveryEngine-V1beta-Session) \nReference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::Session.\n\nExternal session proto definition. \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### #display_name\n\n def display_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. The display name of the session.\n\n This field is used to identify the session in the UI.\n By default, the display name is the first turn query text in the session.\n\n### #display_name=\n\n def display_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. The display name of the session.\n\n\n This field is used to identify the session in the UI.\nBy default, the display name is the first turn query text in the session. \n**Returns**\n\n- (::String) --- Optional. The display name of the session.\n\n This field is used to identify the session in the UI.\n By default, the display name is the first turn query text in the session.\n\n### #end_time\n\n def end_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The time the session finished.\n\n### #is_pinned\n\n def is_pinned() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.\n\n### #is_pinned=\n\n def is_pinned=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. \n**Returns**\n\n- (::Boolean) --- Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` \n**Returns**\n\n- (::String) --- Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`\n\n### #start_time\n\n def start_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The time the session started.\n\n### #state\n\n def state() -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::Session::State\n\n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::Session::State](./Google-Cloud-DiscoveryEngine-V1beta-Session-State)) --- The state of the session.\n\n### #state=\n\n def state=(value) -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::Session::State\n\n**Parameter**\n\n- **value** ([::Google::Cloud::DiscoveryEngine::V1beta::Session::State](./Google-Cloud-DiscoveryEngine-V1beta-Session-State)) --- The state of the session. \n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::Session::State](./Google-Cloud-DiscoveryEngine-V1beta-Session-State)) --- The state of the session.\n\n### #turns\n\n def turns() -\u003e ::Array\u003c::Google::Cloud::DiscoveryEngine::V1beta::Session::Turn\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::DiscoveryEngine::V1beta::Session::Turn](./Google-Cloud-DiscoveryEngine-V1beta-Session-Turn)\\\u003e) --- Turns.\n\n### #turns=\n\n def turns=(value) -\u003e ::Array\u003c::Google::Cloud::DiscoveryEngine::V1beta::Session::Turn\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::DiscoveryEngine::V1beta::Session::Turn](./Google-Cloud-DiscoveryEngine-V1beta-Session-Turn)\\\u003e) --- Turns. \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::DiscoveryEngine::V1beta::Session::Turn](./Google-Cloud-DiscoveryEngine-V1beta-Session-Turn)\\\u003e) --- Turns.\n\n### #user_pseudo_id\n\n def user_pseudo_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A unique identifier for tracking users.\n\n### #user_pseudo_id=\n\n def user_pseudo_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A unique identifier for tracking users. \n**Returns**\n\n- (::String) --- A unique identifier for tracking users."]]
