Send feedback
Class Session (0.58.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latest keyboard_arrow_down
public final class Session extends GeneratedMessageV3 implements SessionOrBuilder
External session proto definition.
Protobuf type google.cloud.discoveryengine.v1.Session
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int
IS_PINNED_FIELD_NUMBER
public static final int IS_PINNED_FIELD_NUMBER
Field Value
Type Description
int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int
TURNS_FIELD_NUMBER
public static final int TURNS_FIELD_NUMBER
Field Value
Type Description
int
USER_PSEUDO_ID_FIELD_NUMBER
public static final int USER_PSEUDO_ID_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Session getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Session . Builder newBuilder ()
newBuilder(Session prototype)
public static Session . Builder newBuilder ( Session prototype )
Parameter
Name Description
prototypeSession
public static Session parseDelimitedFrom ( InputStream input )
public static Session parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Session parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Session parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Session parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Session parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Session parseFrom ( CodedInputStream input )
public static Session parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Session parseFrom ( InputStream input )
public static Session parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Session parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Session parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Session> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public Session getDefaultInstanceForType ()
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.
string display_name = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The displayName.
getDisplayNameBytes()
public ByteString getDisplayNameBytes ()
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.
string display_name = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for displayName.
getEndTime()
public Timestamp getEndTime ()
Output only. The time the session finished.
.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
Timestamp The endTime.
getEndTimeOrBuilder()
public TimestampOrBuilder getEndTimeOrBuilder ()
Output only. The time the session finished.
.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getIsPinned()
public boolean getIsPinned ()
Optional. Whether the session is pinned, pinned session will be displayed
on the top of the session list.
bool is_pinned = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean The isPinned.
getName()
Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Returns
Type Description
String The name.
getNameBytes()
public ByteString getNameBytes ()
Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Returns
Type Description
ByteString The bytes for name.
getParserForType()
public Parser<Session> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getStartTime()
public Timestamp getStartTime ()
Output only. The time the session started.
.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
Timestamp The startTime.
getStartTimeOrBuilder()
public TimestampOrBuilder getStartTimeOrBuilder ()
Output only. The time the session started.
.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState()
public Session . State getState ()
The state of the session.
.google.cloud.discoveryengine.v1.Session.State state = 2;
getStateValue()
public int getStateValue ()
The state of the session.
.google.cloud.discoveryengine.v1.Session.State state = 2;
Returns
Type Description
int The enum numeric value on the wire for state.
getTurns(int index)
public Session . Turn getTurns ( int index )
Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
Parameter
Name Description
indexint
getTurnsCount()
public int getTurnsCount ()
Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
Returns
Type Description
int
getTurnsList()
public List<Session . Turn > getTurnsList ()
Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
getTurnsOrBuilder(int index)
public Session . TurnOrBuilder getTurnsOrBuilder ( int index )
Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
Parameter
Name Description
indexint
getTurnsOrBuilderList()
public List <? extends Session . TurnOrBuilder > getTurnsOrBuilderList ()
Turns.
repeated .google.cloud.discoveryengine.v1.Session.Turn turns = 4;
Returns
Type Description
List <? extends com.google.cloud.discoveryengine.v1.Session.TurnOrBuilder >
getUserPseudoId()
public String getUserPseudoId ()
A unique identifier for tracking users.
string user_pseudo_id = 3;
Returns
Type Description
String The userPseudoId.
getUserPseudoIdBytes()
public ByteString getUserPseudoIdBytes ()
A unique identifier for tracking users.
string user_pseudo_id = 3;
Returns
Type Description
ByteString The bytes for userPseudoId.
hasEndTime()
public boolean hasEndTime ()
Output only. The time the session finished.
.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
boolean Whether the endTime field is set.
hasStartTime()
public boolean hasStartTime ()
Output only. The time the session started.
.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
boolean Whether the startTime field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Session . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Session . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Session . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-16 UTC.
Need to tell us more?
[[["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-05-16 UTC."],[],[]]
