Session (proto-google-cloud-aiplatform-v1beta1 0.79.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.aiplatform.v1beta1.Session

All Implemented Interfaces:

SessionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class Session
extends com.google.protobuf.GeneratedMessageV3
implements SessionOrBuilder
```
```
 A session contains a set of actions between users and Vertex agents.
 
```
Protobuf type google.cloud.aiplatform.v1beta1.Session
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Session.Builder
A session contains a set of actions between users and Vertex agents.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Nested Classes
Modifier and Type	Class and Description
`static class`	`Session.Builder` A session contains a set of actions between users and Vertex agents.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CREATE_TIME_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`SESSION_STATE_FIELD_NUMBER`
`static int`	`UPDATE_TIME_FIELD_NUMBER`
`static int`	`USER_ID_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`com.google.protobuf.Timestamp`	`getCreateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getCreateTimeOrBuilder()` Output only.
`static Session`	`getDefaultInstance()`
`Session`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getDisplayName()` Optional.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` Optional.
`String`	`getName()` Required.
`com.google.protobuf.ByteString`	`getNameBytes()` Required.
`com.google.protobuf.Parser<Session>`	`getParserForType()`
`int`	`getSerializedSize()`
`com.google.protobuf.Struct`	`getSessionState()` Optional.
`com.google.protobuf.StructOrBuilder`	`getSessionStateOrBuilder()` Optional.
`com.google.protobuf.Timestamp`	`getUpdateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getUpdateTimeOrBuilder()` Output only.
`String`	`getUserId()` Required.
`com.google.protobuf.ByteString`	`getUserIdBytes()` Required.
`boolean`	`hasCreateTime()` Output only.
`int`	`hashCode()`
`boolean`	`hasSessionState()` Optional.
`boolean`	`hasUpdateTime()` Output only.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Session.Builder`	`newBuilder()`
`static Session.Builder`	`newBuilder(Session prototype)`
`Session.Builder`	`newBuilderForType()`
`protected Session.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Session`	`parseDelimitedFrom(InputStream input)`
`static Session`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Session`	`parseFrom(byte[] data)`
`static Session`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Session`	`parseFrom(ByteBuffer data)`
`static Session`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Session`	`parseFrom(com.google.protobuf.ByteString data)`
`static Session`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Session`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Session`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Session`	`parseFrom(InputStream input)`
`static Session`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Session>`	`parser()`
`Session.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

- Field Detail
  - NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - CREATE_TIME_FIELD_NUMBER
```
public static final int CREATE_TIME_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - UPDATE_TIME_FIELD_NUMBER
```
public static final int UPDATE_TIME_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - SESSION_STATE_FIELD_NUMBER
```
public static final int SESSION_STATE_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - USER_ID_FIELD_NUMBER
```
public static final int USER_ID_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - newInstance
```
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
```
    Overrides:
    
    newInstance in class com.google.protobuf.GeneratedMessageV3
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
  - getName
```
public String getName()
```
```
 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];
    Specified by:
    
    getName in interface SessionOrBuilder
    
    Returns:
    
    The name.
  - getNameBytes
```
public com.google.protobuf.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];
    Specified by:
    
    getNameBytes in interface SessionOrBuilder
    
    Returns:
    
    The bytes for name.
  - hasCreateTime
```
public boolean hasCreateTime()
```
```
 Output only. Timestamp when the session was created.
 
```
    .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    hasCreateTime in interface SessionOrBuilder
    
    Returns:
    
    Whether the createTime field is set.
  - getCreateTime
```
public com.google.protobuf.Timestamp getCreateTime()
```
```
 Output only. Timestamp when the session was created.
 
```
    .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getCreateTime in interface SessionOrBuilder
    
    Returns:
    
    The createTime.
  - getCreateTimeOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
```
```
 Output only. Timestamp when the session was created.
 
```
    .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getCreateTimeOrBuilder in interface SessionOrBuilder
  - hasUpdateTime
```
public boolean hasUpdateTime()
```
```
 Output only. Timestamp when the session was updated.
 
```
    .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    hasUpdateTime in interface SessionOrBuilder
    
    Returns:
    
    Whether the updateTime field is set.
  - getUpdateTime
```
public com.google.protobuf.Timestamp getUpdateTime()
```
```
 Output only. Timestamp when the session was updated.
 
```
    .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getUpdateTime in interface SessionOrBuilder
    
    Returns:
    
    The updateTime.
  - getUpdateTimeOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
```
```
 Output only. Timestamp when the session was updated.
 
```
    .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Specified by:
    
    getUpdateTimeOrBuilder in interface SessionOrBuilder
  - getDisplayName
```
public String getDisplayName()
```
```
 Optional. The display name of the session.
 
```
    string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getDisplayName in interface SessionOrBuilder
    
    Returns:
    
    The displayName.
  - getDisplayNameBytes
```
public com.google.protobuf.ByteString getDisplayNameBytes()
```
```
 Optional. The display name of the session.
 
```
    string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getDisplayNameBytes in interface SessionOrBuilder
    
    Returns:
    
    The bytes for displayName.
  - hasSessionState
```
public boolean hasSessionState()
```
```
 Optional. Session specific memory which stores key conversation points.
 
```
    .google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    hasSessionState in interface SessionOrBuilder
    
    Returns:
    
    Whether the sessionState field is set.
  - getSessionState
```
public com.google.protobuf.Struct getSessionState()
```
```
 Optional. Session specific memory which stores key conversation points.
 
```
    .google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getSessionState in interface SessionOrBuilder
    
    Returns:
    
    The sessionState.
  - getSessionStateOrBuilder
```
public com.google.protobuf.StructOrBuilder getSessionStateOrBuilder()
```
```
 Optional. Session specific memory which stores key conversation points.
 
```
    .google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getSessionStateOrBuilder in interface SessionOrBuilder
  - getUserId
```
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];
    Specified by:
    
    getUserId in interface SessionOrBuilder
    
    Returns:
    
    The userId.
  - getUserIdBytes
```
public com.google.protobuf.ByteString getUserIdBytes()
```
```
 Required. Immutable. String id provided by the user
 
```
    string user_id = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getUserIdBytes in interface SessionOrBuilder
    
    Returns:
    
    The bytes for userId.
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3
  - writeTo
```
public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException
```
    Specified by:
    
    writeTo in interface com.google.protobuf.MessageLite
    
    Overrides:
    
    writeTo in class com.google.protobuf.GeneratedMessageV3
    
    Throws:
    
    IOException
  - getSerializedSize
```
public int getSerializedSize()
```
    Specified by:
    
    getSerializedSize in interface com.google.protobuf.MessageLite
    
    Overrides:
    
    getSerializedSize in class com.google.protobuf.GeneratedMessageV3
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface com.google.protobuf.Message
    
    Overrides:
    
    equals in class com.google.protobuf.AbstractMessage
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface com.google.protobuf.Message
    
    Overrides:
    
    hashCode in class com.google.protobuf.AbstractMessage
  - parseFrom
```
public static Session parseFrom(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Session parseFrom(ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Session parseFrom(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Session parseFrom(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Session parseFrom(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Session parseFrom(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static Session parseFrom(InputStream input)
                         throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static Session parseFrom(InputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static Session parseDelimitedFrom(InputStream input)
                                  throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static Session parseDelimitedFrom(InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static Session parseFrom(com.google.protobuf.CodedInputStream input)
                         throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static Session parseFrom(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
```
    Throws:
    
    IOException
  - newBuilderForType
```
public Session.Builder newBuilderForType()
```
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.Message
    
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.MessageLite
  - newBuilder
```
public static Session.Builder newBuilder()
```
  - newBuilder
```
public static Session.Builder newBuilder(Session prototype)
```
  - toBuilder
```
public Session.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface com.google.protobuf.Message
    
    Specified by:
    
    toBuilder in interface com.google.protobuf.MessageLite
  - newBuilderForType
```
protected Session.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
```
    Specified by:
    
    newBuilderForType in class com.google.protobuf.GeneratedMessageV3
  - getDefaultInstance
```
public static Session getDefaultInstance()
```
  - parser
```
public static com.google.protobuf.Parser<Session> parser()
```
  - getParserForType
```
public com.google.protobuf.Parser<Session> getParserForType()
```
    Specified by:
    
    getParserForType in interface com.google.protobuf.Message
    
    Specified by:
    
    getParserForType in interface com.google.protobuf.MessageLite
    
    Overrides:
    
    getParserForType in class com.google.protobuf.GeneratedMessageV3
  - getDefaultInstanceForType
```
public Session getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

Class Session

Nested Class Summary

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

NAME_FIELD_NUMBER

CREATE_TIME_FIELD_NUMBER

UPDATE_TIME_FIELD_NUMBER

DISPLAY_NAME_FIELD_NUMBER

SESSION_STATE_FIELD_NUMBER

USER_ID_FIELD_NUMBER

Method Detail

newInstance

getDescriptor

internalGetFieldAccessorTable

getName

getNameBytes

hasCreateTime

getCreateTime

getCreateTimeOrBuilder

hasUpdateTime

getUpdateTime

getUpdateTimeOrBuilder

getDisplayName

getDisplayNameBytes

hasSessionState

getSessionState

getSessionStateOrBuilder

getUserId

getUserIdBytes

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

newBuilderForType

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType