Package com.google.cloud.discoveryengine.v1beta

Class Session

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.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
 External session proto definition.
Protobuf type google.cloud.discoveryengine.v1beta.Session
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Session.Builder
    External session proto definition.
    static enum 
    Session.State
    Enumeration of the state of the session.
    static final class 
    Session.Turn
    Represents a turn, including a query from the user and a answer from service.
    static interface 
    Session.TurnOrBuilder
     

    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
    DISPLAY_NAME_FIELD_NUMBER
     
    static final int
    END_TIME_FIELD_NUMBER
     
    static final int
    IS_PINNED_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    START_TIME_FIELD_NUMBER
     
    static final int
    STATE_FIELD_NUMBER
     
    static final int
    TURNS_FIELD_NUMBER
     
    static final int
    USER_PSEUDO_ID_FIELD_NUMBER
     

    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
    equals(Object obj)
     
    static Session
    getDefaultInstance()
     
    Session
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getDisplayName()
    Optional.
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    Optional.
    com.google.protobuf.Timestamp
    getEndTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getEndTimeOrBuilder()
    Output only.
    boolean
    getIsPinned()
    Optional.
    String
    getName()
    Immutable.
    com.google.protobuf.ByteString
    getNameBytes()
    Immutable.
    com.google.protobuf.Parser<Session>
    getParserForType()
     
    int
    getSerializedSize()
     
    com.google.protobuf.Timestamp
    getStartTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getStartTimeOrBuilder()
    Output only.
    Session.State
    getState()
    The state of the session.
    int
    getStateValue()
    The state of the session.
    Session.Turn
    getTurns(int index)
    Turns.
    int
    getTurnsCount()
    Turns.
    List<Session.Turn>
    getTurnsList()
    Turns.
    Session.TurnOrBuilder
    getTurnsOrBuilder(int index)
    Turns.
    List<? extends Session.TurnOrBuilder>
    getTurnsOrBuilderList()
    Turns.
    String
    getUserPseudoId()
    A unique identifier for tracking users.
    com.google.protobuf.ByteString
    getUserPseudoIdBytes()
    A unique identifier for tracking users.
    boolean
    hasEndTime()
    Output only.
    int
    hashCode()
     
    boolean
    hasStartTime()
    Output only.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Session.Builder
    newBuilder()
     
    static Session.Builder
    newBuilder(Session prototype)
     
    Session.Builder
    newBuilderForType()
     
    protected Session.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    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(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 Session
    parseFrom(ByteBuffer data)
     
    static Session
    parseFrom(ByteBuffer data, 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.GeneratedMessage

    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, 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()

    • internalGetFieldAccessorTable

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

    • getName

      public String getName()
       Immutable. Fully qualified name
 `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getName in interface SessionOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Immutable. Fully qualified name
 `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getNameBytes in interface SessionOrBuilder
      Returns:
      The bytes for name.

    • 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];
      Specified by:
      getDisplayName in interface SessionOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.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];
      Specified by:
      getDisplayNameBytes in interface SessionOrBuilder
      Returns:
      The bytes for displayName.

    • getStateValue

      public int getStateValue()
       The state of the session.
      .google.cloud.discoveryengine.v1beta.Session.State state = 2;
      Specified by:
      getStateValue in interface SessionOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public Session.State getState()
       The state of the session.
      .google.cloud.discoveryengine.v1beta.Session.State state = 2;
      Specified by:
      getState in interface SessionOrBuilder
      Returns:
      The state.

    • getUserPseudoId

      public String getUserPseudoId()
       A unique identifier for tracking users.
      string user_pseudo_id = 3;
      Specified by:
      getUserPseudoId in interface SessionOrBuilder
      Returns:
      The userPseudoId.

    • getUserPseudoIdBytes

      public com.google.protobuf.ByteString getUserPseudoIdBytes()
       A unique identifier for tracking users.
      string user_pseudo_id = 3;
      Specified by:
      getUserPseudoIdBytes in interface SessionOrBuilder
      Returns:
      The bytes for userPseudoId.

    • getTurnsList

      public List<Session.Turn> getTurnsList()
       Turns.
      repeated .google.cloud.discoveryengine.v1beta.Session.Turn turns = 4;
      Specified by:
      getTurnsList in interface SessionOrBuilder

    • getTurnsOrBuilderList

      public List<? extends Session.TurnOrBuilder> getTurnsOrBuilderList()
       Turns.
      repeated .google.cloud.discoveryengine.v1beta.Session.Turn turns = 4;
      Specified by:
      getTurnsOrBuilderList in interface SessionOrBuilder

    • getTurnsCount

      public int getTurnsCount()
       Turns.
      repeated .google.cloud.discoveryengine.v1beta.Session.Turn turns = 4;
      Specified by:
      getTurnsCount in interface SessionOrBuilder

    • getTurns

      public Session.Turn getTurns(int index)
       Turns.
      repeated .google.cloud.discoveryengine.v1beta.Session.Turn turns = 4;
      Specified by:
      getTurns in interface SessionOrBuilder

    • getTurnsOrBuilder

      public Session.TurnOrBuilder getTurnsOrBuilder(int index)
       Turns.
      repeated .google.cloud.discoveryengine.v1beta.Session.Turn turns = 4;
      Specified by:
      getTurnsOrBuilder in interface SessionOrBuilder

    • hasStartTime

      public boolean hasStartTime()
       Output only. The time the session started.
      .google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasStartTime in interface SessionOrBuilder
      Returns:
      Whether the startTime field is set.

    • getStartTime

      public com.google.protobuf.Timestamp getStartTime()
       Output only. The time the session started.
      .google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStartTime in interface SessionOrBuilder
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       Output only. The time the session started.
      .google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStartTimeOrBuilder in interface SessionOrBuilder

    • hasEndTime

      public boolean hasEndTime()
       Output only. The time the session finished.
      .google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasEndTime in interface SessionOrBuilder
      Returns:
      Whether the endTime field is set.

    • getEndTime

      public com.google.protobuf.Timestamp getEndTime()
       Output only. The time the session finished.
      .google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEndTime in interface SessionOrBuilder
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
       Output only. The time the session finished.
      .google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEndTimeOrBuilder in interface SessionOrBuilder

    • 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];
      Specified by:
      getIsPinned in interface SessionOrBuilder
      Returns:
      The isPinned.

    • 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