GoogleCloudDiscoveryengineV1Session (Discovery Engine API v1-rev20260427-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1Session

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1Session
extends com.google.api.client.json.GenericJson
```
External session proto definition.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleCloudDiscoveryengineV1Session()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1Session()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1Session`	`clone()`
`String`	`getDisplayName()` Optional.
`String`	`getEndTime()` Output only.
`Boolean`	`getIsPinned()` Optional.
`List<String>`	`getLabels()` Optional.
`String`	`getName()` Immutable.
`String`	`getStartTime()` Output only.
`String`	`getState()` The state of the session.
`List<GoogleCloudDiscoveryengineV1SessionTurn>`	`getTurns()` Turns.
`String`	`getUserPseudoId()` A unique identifier for tracking users.
`GoogleCloudDiscoveryengineV1Session`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1Session`	`setDisplayName(String displayName)` Optional.
`GoogleCloudDiscoveryengineV1Session`	`setEndTime(String endTime)` Output only.
`GoogleCloudDiscoveryengineV1Session`	`setIsPinned(Boolean isPinned)` Optional.
`GoogleCloudDiscoveryengineV1Session`	`setLabels(List<String> labels)` Optional.
`GoogleCloudDiscoveryengineV1Session`	`setName(String name)` Immutable.
`GoogleCloudDiscoveryengineV1Session`	`setStartTime(String startTime)` Output only.
`GoogleCloudDiscoveryengineV1Session`	`setState(String state)` The state of the session.
`GoogleCloudDiscoveryengineV1Session`	`setTurns(List<GoogleCloudDiscoveryengineV1SessionTurn> turns)` Turns.
`GoogleCloudDiscoveryengineV1Session`	`setUserPseudoId(String userPseudoId)` A unique identifier for tracking users.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleCloudDiscoveryengineV1Session
```
public GoogleCloudDiscoveryengineV1Session()
```
- Method Detail
  - getDisplayName
```
public String getDisplayName()
```
    Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public GoogleCloudDiscoveryengineV1Session setDisplayName(String displayName)
```
    Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.
    
    Parameters:
    
    displayName - displayName or null for none
  - getEndTime
```
public String getEndTime()
```
    Output only. The time the session finished.
    
    Returns:
    
    value or null for none
  - setEndTime
```
public GoogleCloudDiscoveryengineV1Session setEndTime(String endTime)
```
    Output only. The time the session finished.
    
    Parameters:
    
    endTime - endTime or null for none
  - getIsPinned
```
public Boolean getIsPinned()
```
    Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.
    
    Returns:
    
    value or null for none
  - setIsPinned
```
public GoogleCloudDiscoveryengineV1Session setIsPinned(Boolean isPinned)
```
    Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.
    
    Parameters:
    
    isPinned - isPinned or null for none
  - getLabels
```
public List<String> getLabels()
```
    Optional. The labels for the session. Can be set as filter in ListSessionsRequest.
    
    Returns:
    
    value or null for none
  - setLabels
```
public GoogleCloudDiscoveryengineV1Session setLabels(List<String> labels)
```
    Optional. The labels for the session. Can be set as filter in ListSessionsRequest.
    
    Parameters:
    
    labels - labels or null for none
  - getName
```
public String getName()
```
    Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions`
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleCloudDiscoveryengineV1Session setName(String name)
```
    Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions`
    
    Parameters:
    
    name - name or null for none
  - getStartTime
```
public String getStartTime()
```
    Output only. The time the session started.
    
    Returns:
    
    value or null for none
  - setStartTime
```
public GoogleCloudDiscoveryengineV1Session setStartTime(String startTime)
```
    Output only. The time the session started.
    
    Parameters:
    
    startTime - startTime or null for none
  - getState
```
public String getState()
```
    The state of the session.
    
    Returns:
    
    value or null for none
  - setState
```
public GoogleCloudDiscoveryengineV1Session setState(String state)
```
    The state of the session.
    
    Parameters:
    
    state - state or null for none
  - getTurns
```
public List<GoogleCloudDiscoveryengineV1SessionTurn> getTurns()
```
    Turns.
    
    Returns:
    
    value or null for none
  - setTurns
```
public GoogleCloudDiscoveryengineV1Session setTurns(List<GoogleCloudDiscoveryengineV1SessionTurn> turns)
```
    Turns.
    
    Parameters:
    
    turns - turns or null for none
  - getUserPseudoId
```
public String getUserPseudoId()
```
    A unique identifier for tracking users.
    
    Returns:
    
    value or null for none
  - setUserPseudoId
```
public GoogleCloudDiscoveryengineV1Session setUserPseudoId(String userPseudoId)
```
    A unique identifier for tracking users.
    
    Parameters:
    
    userPseudoId - userPseudoId or null for none
  - set
```
public GoogleCloudDiscoveryengineV1Session set(String fieldName,
                                               Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1Session clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1Session

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleCloudDiscoveryengineV1Session

Method Detail

getDisplayName

setDisplayName

getEndTime

setEndTime

getIsPinned

setIsPinned

getLabels

setLabels

getName

setName

getStartTime

setStartTime

getState

setState

getTurns

setTurns

getUserPseudoId

setUserPseudoId

set

clone