Package com.google.cloud.aiplatform.v1

Class SessionEvent

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.SessionEvent
All Implemented Interfaces:
SessionEventOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SessionEvent extends com.google.protobuf.GeneratedMessage implements SessionEventOrBuilder
 An event represents a message from either the user or agent.
Protobuf type google.cloud.aiplatform.v1.SessionEvent
See Also:

  • 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()
       Identifier. The resource name of the event.
 Format:`projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface SessionEventOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. The resource name of the event.
 Format:`projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}/events/{event}`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface SessionEventOrBuilder
      Returns:
      The bytes for name.

    • getAuthor

      public String getAuthor()
       Required. The name of the agent that sent the event, or user.
      string author = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAuthor in interface SessionEventOrBuilder
      Returns:
      The author.

    • getAuthorBytes

      public com.google.protobuf.ByteString getAuthorBytes()
       Required. The name of the agent that sent the event, or user.
      string author = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAuthorBytes in interface SessionEventOrBuilder
      Returns:
      The bytes for author.

    • hasContent

      public boolean hasContent()
       Optional. Content of the event provided by the author.
      .google.cloud.aiplatform.v1.Content content = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasContent in interface SessionEventOrBuilder
      Returns:
      Whether the content field is set.

    • getContent

      public Content getContent()
       Optional. Content of the event provided by the author.
      .google.cloud.aiplatform.v1.Content content = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContent in interface SessionEventOrBuilder
      Returns:
      The content.

    • getContentOrBuilder

      public ContentOrBuilder getContentOrBuilder()
       Optional. Content of the event provided by the author.
      .google.cloud.aiplatform.v1.Content content = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContentOrBuilder in interface SessionEventOrBuilder

    • getInvocationId

      public String getInvocationId()
       Required. The invocation id of the event, multiple events can have the same
 invocation id.
      string invocation_id = 5 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getInvocationId in interface SessionEventOrBuilder
      Returns:
      The invocationId.

    • getInvocationIdBytes

      public com.google.protobuf.ByteString getInvocationIdBytes()
       Required. The invocation id of the event, multiple events can have the same
 invocation id.
      string invocation_id = 5 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getInvocationIdBytes in interface SessionEventOrBuilder
      Returns:
      The bytes for invocationId.

    • hasActions

      public boolean hasActions()
       Optional. Actions executed by the agent.
      .google.cloud.aiplatform.v1.EventActions actions = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasActions in interface SessionEventOrBuilder
      Returns:
      Whether the actions field is set.

    • getActions

      public EventActions getActions()
       Optional. Actions executed by the agent.
      .google.cloud.aiplatform.v1.EventActions actions = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getActions in interface SessionEventOrBuilder
      Returns:
      The actions.

    • getActionsOrBuilder

      public EventActionsOrBuilder getActionsOrBuilder()
       Optional. Actions executed by the agent.
      .google.cloud.aiplatform.v1.EventActions actions = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getActionsOrBuilder in interface SessionEventOrBuilder

    • hasTimestamp

      public boolean hasTimestamp()
       Required. Timestamp when the event was created on client side.
      .google.protobuf.Timestamp timestamp = 8 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasTimestamp in interface SessionEventOrBuilder
      Returns:
      Whether the timestamp field is set.

    • getTimestamp

      public com.google.protobuf.Timestamp getTimestamp()
       Required. Timestamp when the event was created on client side.
      .google.protobuf.Timestamp timestamp = 8 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getTimestamp in interface SessionEventOrBuilder
      Returns:
      The timestamp.

    • getTimestampOrBuilder

      public com.google.protobuf.TimestampOrBuilder getTimestampOrBuilder()
       Required. Timestamp when the event was created on client side.
      .google.protobuf.Timestamp timestamp = 8 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getTimestampOrBuilder in interface SessionEventOrBuilder

    • getErrorCode

      public String getErrorCode()
       Optional. Error code if the response is an error. Code varies by model.
      string error_code = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getErrorCode in interface SessionEventOrBuilder
      Returns:
      The errorCode.

    • getErrorCodeBytes

      public com.google.protobuf.ByteString getErrorCodeBytes()
       Optional. Error code if the response is an error. Code varies by model.
      string error_code = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getErrorCodeBytes in interface SessionEventOrBuilder
      Returns:
      The bytes for errorCode.

    • getErrorMessage

      public String getErrorMessage()
       Optional. Error message if the response is an error.
      string error_message = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getErrorMessage in interface SessionEventOrBuilder
      Returns:
      The errorMessage.

    • getErrorMessageBytes

      public com.google.protobuf.ByteString getErrorMessageBytes()
       Optional. Error message if the response is an error.
      string error_message = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getErrorMessageBytes in interface SessionEventOrBuilder
      Returns:
      The bytes for errorMessage.

    • hasEventMetadata

      public boolean hasEventMetadata()
       Optional. Metadata relating to this event.
      .google.cloud.aiplatform.v1.EventMetadata event_metadata = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasEventMetadata in interface SessionEventOrBuilder
      Returns:
      Whether the eventMetadata field is set.

    • getEventMetadata

      public EventMetadata getEventMetadata()
       Optional. Metadata relating to this event.
      .google.cloud.aiplatform.v1.EventMetadata event_metadata = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEventMetadata in interface SessionEventOrBuilder
      Returns:
      The eventMetadata.

    • getEventMetadataOrBuilder

      public EventMetadataOrBuilder getEventMetadataOrBuilder()
       Optional. Metadata relating to this event.
      .google.cloud.aiplatform.v1.EventMetadata event_metadata = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEventMetadataOrBuilder in interface SessionEventOrBuilder

    • hasRawEvent

      public boolean hasRawEvent()
       Optional. Weakly typed raw event data in proto struct format.
      .google.protobuf.Struct raw_event = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasRawEvent in interface SessionEventOrBuilder
      Returns:
      Whether the rawEvent field is set.

    • getRawEvent

      public com.google.protobuf.Struct getRawEvent()
       Optional. Weakly typed raw event data in proto struct format.
      .google.protobuf.Struct raw_event = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRawEvent in interface SessionEventOrBuilder
      Returns:
      The rawEvent.

    • getRawEventOrBuilder

      public com.google.protobuf.StructOrBuilder getRawEventOrBuilder()
       Optional. Weakly typed raw event data in proto struct format.
      .google.protobuf.Struct raw_event = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRawEventOrBuilder in interface SessionEventOrBuilder

    • 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 SessionEvent parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SessionEvent parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SessionEvent parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SessionEvent parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SessionEvent parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SessionEvent parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SessionEvent parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SessionEvent parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SessionEvent parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SessionEvent parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SessionEvent parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SessionEvent parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SessionEvent.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SessionEvent.Builder newBuilder()

    • newBuilder

      public static SessionEvent.Builder newBuilder(SessionEvent prototype)

    • toBuilder

      public SessionEvent.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SessionEvent.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SessionEvent getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SessionEvent> parser()

    • getParserForType

      public com.google.protobuf.Parser<SessionEvent> 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 SessionEvent getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder