Send feedback
Class Session (3.65.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public final class Session extends GeneratedMessageV3 implements SessionOrBuilder
A session contains a set of actions between users and Vertex agents.
Protobuf type google.cloud.aiplatform.v1beta1.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
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int SESSION_STATE_FIELD_NUMBER
Field Value
Type Description
int
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int
public static final int USER_ID_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static Session getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static Session . Builder newBuilder ()
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 )
public static Session parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static Session parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static Session parseFrom ( ByteString data )
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 )
public static Session parseFrom ( ByteBuffer data )
public static Session parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<Session> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public Timestamp getCreateTime ()
Output only. Timestamp when the session was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
Timestamp The createTime.
public TimestampOrBuilder getCreateTimeOrBuilder ()
Output only. Timestamp when the session was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Session getDefaultInstanceForType ()
public String getDisplayName ()
Optional. The display name of the session.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The displayName.
public ByteString getDisplayNameBytes ()
Optional. The display name of the session.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for displayName.
Required. Identifier. The resource name of the session.
Format:
'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IDENTIFIER];
Returns
Type Description
String The name.
public ByteString getNameBytes ()
Required. Identifier. The resource name of the session.
Format:
'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IDENTIFIER];
Returns
Type Description
ByteString The bytes for name.
public Parser<Session> getParserForType ()
Overrides
public int getSerializedSize ()
Returns
Type Description
int
Overrides
public Struct getSessionState ()
Optional. Session specific memory which stores key conversation points.
.google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
Struct The sessionState.
public StructOrBuilder getSessionStateOrBuilder ()
Optional. Session specific memory which stores key conversation points.
.google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];
public Timestamp getUpdateTime ()
Output only. Timestamp when the session was updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
Timestamp The updateTime.
public TimestampOrBuilder getUpdateTimeOrBuilder ()
Output only. Timestamp when the session was updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public String getUserId ()
Required. Immutable. String id provided by the user
string user_id = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The userId.
public ByteString getUserIdBytes ()
Required. Immutable. String id provided by the user
string user_id = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for userId.
public boolean hasCreateTime ()
Output only. Timestamp when the session was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
boolean Whether the createTime field is set.
public boolean hasSessionState ()
Optional. Session specific memory which stores key conversation points.
.google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the sessionState field is set.
public boolean hasUpdateTime ()
Output only. Timestamp when the session was updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
boolean Whether the updateTime field is set.
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public Session . Builder newBuilderForType ()
protected Session . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public Session . Builder toBuilder ()
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-06-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-06-16 UTC."],[],[]]
