Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::Session.
External session proto definition.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#end_time
def end_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time the session finished.
#name
def name() -> ::String
Returns
-
(::String) — Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
Returns
-
(::String) — Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
#start_time
def start_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time the session started.
#state
def state() -> ::Google::Cloud::DiscoveryEngine::V1::Session::State
Returns
- (::Google::Cloud::DiscoveryEngine::V1::Session::State) — The state of the session.
#state=
def state=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Session::State
Parameter
- value (::Google::Cloud::DiscoveryEngine::V1::Session::State) — The state of the session.
Returns
- (::Google::Cloud::DiscoveryEngine::V1::Session::State) — The state of the session.
#turns
def turns() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::Session::Turn>
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1::Session::Turn>) — Turns.
#turns=
def turns=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::Session::Turn>
Parameter
- value (::Array<::Google::Cloud::DiscoveryEngine::V1::Session::Turn>) — Turns.
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1::Session::Turn>) — Turns.
#user_pseudo_id
def user_pseudo_id() -> ::String
Returns
- (::String) — A unique identifier for tracking users.
#user_pseudo_id=
def user_pseudo_id=(value) -> ::String
Parameter
- value (::String) — A unique identifier for tracking users.
Returns
- (::String) — A unique identifier for tracking users.