Class Session

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.Session
All Implemented Interfaces:
SessionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class Session extends com.google.protobuf.GeneratedMessage implements SessionOrBuilder
 A session contains a set of actions between users and Vertex agents.
 
Protobuf type google.cloud.aiplatform.v1.Session
See Also:
  • Nested Class Summary

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

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    The labels with user-defined metadata to organize your Sessions.
    boolean
     
    com.google.protobuf.Timestamp
    Output only.
    com.google.protobuf.TimestampOrBuilder
    Output only.
    static Session
     
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    Optional.
    com.google.protobuf.ByteString
    Optional.
     
    com.google.protobuf.Timestamp
    Optional.
    com.google.protobuf.TimestampOrBuilder
    Optional.
    Deprecated.
    int
    The labels with user-defined metadata to organize your Sessions.
    The labels with user-defined metadata to organize your Sessions.
    getLabelsOrDefault(String key, String defaultValue)
    The labels with user-defined metadata to organize your Sessions.
    The labels with user-defined metadata to organize your Sessions.
    Identifier.
    com.google.protobuf.ByteString
    Identifier.
    com.google.protobuf.Parser<Session>
     
    int
     
    com.google.protobuf.Struct
    Optional.
    com.google.protobuf.StructOrBuilder
    Optional.
    com.google.protobuf.Duration
    Optional.
    com.google.protobuf.DurationOrBuilder
    Optional.
    com.google.protobuf.Timestamp
    Output only.
    com.google.protobuf.TimestampOrBuilder
    Output only.
    Required.
    com.google.protobuf.ByteString
    Required.
    boolean
    Output only.
    boolean
    Optional.
    int
     
    boolean
    Optional.
    boolean
    Optional.
    boolean
    Output only.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
     
    protected com.google.protobuf.MapFieldReflectionAccessor
     
    final boolean
     
     
    newBuilder(Session prototype)
     
     
    protected Session.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Session
     
    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(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
     
    static Session
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Session
     
    static Session
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Session>
     
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getExpirationCase

      public Session.ExpirationCase getExpirationCase()
      Specified by:
      getExpirationCase in interface SessionOrBuilder
    • hasExpireTime

      public boolean hasExpireTime()
       Optional. Timestamp of when this session is considered expired.
       This is *always* provided on output, regardless of what was sent
       on input.
       The minimum value is 24 hours from the time of creation.
       
      .google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasExpireTime in interface SessionOrBuilder
      Returns:
      Whether the expireTime field is set.
    • getExpireTime

      public com.google.protobuf.Timestamp getExpireTime()
       Optional. Timestamp of when this session is considered expired.
       This is *always* provided on output, regardless of what was sent
       on input.
       The minimum value is 24 hours from the time of creation.
       
      .google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExpireTime in interface SessionOrBuilder
      Returns:
      The expireTime.
    • getExpireTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
       Optional. Timestamp of when this session is considered expired.
       This is *always* provided on output, regardless of what was sent
       on input.
       The minimum value is 24 hours from the time of creation.
       
      .google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExpireTimeOrBuilder in interface SessionOrBuilder
    • hasTtl

      public boolean hasTtl()
       Optional. Input only. The TTL for this session.
       The minimum value is 24 hours.
       
      .google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      hasTtl in interface SessionOrBuilder
      Returns:
      Whether the ttl field is set.
    • getTtl

      public com.google.protobuf.Duration getTtl()
       Optional. Input only. The TTL for this session.
       The minimum value is 24 hours.
       
      .google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      getTtl in interface SessionOrBuilder
      Returns:
      The ttl.
    • getTtlOrBuilder

      public com.google.protobuf.DurationOrBuilder getTtlOrBuilder()
       Optional. Input only. The TTL for this session.
       The minimum value is 24 hours.
       
      .google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];
      Specified by:
      getTtlOrBuilder in interface SessionOrBuilder
    • getName

      public String getName()
       Identifier. The resource name of the session.
       Format:
       'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface SessionOrBuilder
      Returns:
      The name.
    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. The resource name of the session.
       Format:
       'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
       
      string name = 1 [(.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.
    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: SessionOrBuilder
       The labels with user-defined metadata to organize your Sessions.
      
       Label keys and values can be no longer than 64 characters
       (Unicode codepoints), can only contain lowercase letters, numeric
       characters, underscores and dashes. International characters are allowed.
      
       See https://goo.gl/xmQnxf for more information and examples of labels.
       
      map<string, string> labels = 8;
      Specified by:
      getLabelsCount in interface SessionOrBuilder
    • containsLabels

      public boolean containsLabels(String key)
       The labels with user-defined metadata to organize your Sessions.
      
       Label keys and values can be no longer than 64 characters
       (Unicode codepoints), can only contain lowercase letters, numeric
       characters, underscores and dashes. International characters are allowed.
      
       See https://goo.gl/xmQnxf for more information and examples of labels.
       
      map<string, string> labels = 8;
      Specified by:
      containsLabels in interface SessionOrBuilder
    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface SessionOrBuilder
    • getLabelsMap

      public Map<String,String> getLabelsMap()
       The labels with user-defined metadata to organize your Sessions.
      
       Label keys and values can be no longer than 64 characters
       (Unicode codepoints), can only contain lowercase letters, numeric
       characters, underscores and dashes. International characters are allowed.
      
       See https://goo.gl/xmQnxf for more information and examples of labels.
       
      map<string, string> labels = 8;
      Specified by:
      getLabelsMap in interface SessionOrBuilder
    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       The labels with user-defined metadata to organize your Sessions.
      
       Label keys and values can be no longer than 64 characters
       (Unicode codepoints), can only contain lowercase letters, numeric
       characters, underscores and dashes. International characters are allowed.
      
       See https://goo.gl/xmQnxf for more information and examples of labels.
       
      map<string, string> labels = 8;
      Specified by:
      getLabelsOrDefault in interface SessionOrBuilder
    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       The labels with user-defined metadata to organize your Sessions.
      
       Label keys and values can be no longer than 64 characters
       (Unicode codepoints), can only contain lowercase letters, numeric
       characters, underscores and dashes. International characters are allowed.
      
       See https://goo.gl/xmQnxf for more information and examples of labels.
       
      map<string, string> labels = 8;
      Specified by:
      getLabelsOrThrow in interface SessionOrBuilder
    • 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.GeneratedMessage
    • 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.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • 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.GeneratedMessage
    • getDefaultInstanceForType

      public Session getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder