Class SessionEvent (3.64.0)

public final class SessionEvent extends GeneratedMessageV3 implements SessionEventOrBuilder

An event represents a message from either the user or agent.

Protobuf type google.cloud.aiplatform.v1beta1.SessionEvent

Static Fields

ACTIONS_FIELD_NUMBER

public static final int ACTIONS_FIELD_NUMBER
Field Value
Type Description
int

AUTHOR_FIELD_NUMBER

public static final int AUTHOR_FIELD_NUMBER
Field Value
Type Description
int

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER
Field Value
Type Description
int

ERROR_CODE_FIELD_NUMBER

public static final int ERROR_CODE_FIELD_NUMBER
Field Value
Type Description
int

ERROR_MESSAGE_FIELD_NUMBER

public static final int ERROR_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

EVENT_METADATA_FIELD_NUMBER

public static final int EVENT_METADATA_FIELD_NUMBER
Field Value
Type Description
int

INVOCATION_ID_FIELD_NUMBER

public static final int INVOCATION_ID_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

TIMESTAMP_FIELD_NUMBER

public static final int TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SessionEvent getDefaultInstance()
Returns
Type Description
SessionEvent

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SessionEvent.Builder newBuilder()
Returns
Type Description
SessionEvent.Builder

newBuilder(SessionEvent prototype)

public static SessionEvent.Builder newBuilder(SessionEvent prototype)
Parameter
Name Description
prototype SessionEvent
Returns
Type Description
SessionEvent.Builder

parseDelimitedFrom(InputStream input)

public static SessionEvent parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SessionEvent
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SessionEvent parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionEvent
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SessionEvent parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SessionEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SessionEvent parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SessionEvent parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SessionEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SessionEvent parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SessionEvent parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SessionEvent
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SessionEvent parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionEvent
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SessionEvent parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SessionEvent
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SessionEvent parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionEvent
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SessionEvent parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SessionEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SessionEvent parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionEvent
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SessionEvent> parser()
Returns
Type Description
Parser<SessionEvent>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getActions()

public EventActions getActions()

Optional. Actions executed by the agent.

.google.cloud.aiplatform.v1beta1.EventActions actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EventActions

The actions.

getActionsOrBuilder()

public EventActionsOrBuilder getActionsOrBuilder()

Optional. Actions executed by the agent.

.google.cloud.aiplatform.v1beta1.EventActions actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EventActionsOrBuilder

getAuthor()

public String getAuthor()

Required. The name of the agent that sent the event, or user.

string author = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The author.

getAuthorBytes()

public ByteString getAuthorBytes()

Required. The name of the agent that sent the event, or user.

string author = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for author.

getContent()

public Content getContent()

Optional. Content of the event provided by the author.

.google.cloud.aiplatform.v1beta1.Content content = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Content

The content.

getContentOrBuilder()

public ContentOrBuilder getContentOrBuilder()

Optional. Content of the event provided by the author.

.google.cloud.aiplatform.v1beta1.Content content = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ContentOrBuilder

getDefaultInstanceForType()

public SessionEvent getDefaultInstanceForType()
Returns
Type Description
SessionEvent

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];

Returns
Type Description
String

The errorCode.

getErrorCodeBytes()

public ByteString getErrorCodeBytes()

Optional. Error code if the response is an error. Code varies by model.

string error_code = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

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];

Returns
Type Description
String

The errorMessage.

getErrorMessageBytes()

public ByteString getErrorMessageBytes()

Optional. Error message if the response is an error.

string error_message = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for errorMessage.

getEventMetadata()

public EventMetadata getEventMetadata()

Optional. Metadata relating to this event.

.google.cloud.aiplatform.v1beta1.EventMetadata event_metadata = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EventMetadata

The eventMetadata.

getEventMetadataOrBuilder()

public EventMetadataOrBuilder getEventMetadataOrBuilder()

Optional. Metadata relating to this event.

.google.cloud.aiplatform.v1beta1.EventMetadata event_metadata = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EventMetadataOrBuilder

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];

Returns
Type Description
String

The invocationId.

getInvocationIdBytes()

public 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];

Returns
Type Description
ByteString

The bytes for invocationId.

getName()

public String getName()

Required. 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) = REQUIRED, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. 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) = REQUIRED, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<SessionEvent> getParserForType()
Returns
Type Description
Parser<SessionEvent>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTimestamp()

public Timestamp getTimestamp()

Required. Timestamp when the event was created on client side.

.google.protobuf.Timestamp timestamp = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Timestamp

The timestamp.

getTimestampOrBuilder()

public TimestampOrBuilder getTimestampOrBuilder()

Required. Timestamp when the event was created on client side.

.google.protobuf.Timestamp timestamp = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TimestampOrBuilder

hasActions()

public boolean hasActions()

Optional. Actions executed by the agent.

.google.cloud.aiplatform.v1beta1.EventActions actions = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the actions field is set.

hasContent()

public boolean hasContent()

Optional. Content of the event provided by the author.

.google.cloud.aiplatform.v1beta1.Content content = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the content field is set.

hasEventMetadata()

public boolean hasEventMetadata()

Optional. Metadata relating to this event.

.google.cloud.aiplatform.v1beta1.EventMetadata event_metadata = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the eventMetadata field is set.

hasTimestamp()

public boolean hasTimestamp()

Required. Timestamp when the event was created on client side.

.google.protobuf.Timestamp timestamp = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the timestamp field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SessionEvent.Builder newBuilderForType()
Returns
Type Description
SessionEvent.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SessionEvent.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SessionEvent.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SessionEvent.Builder toBuilder()
Returns
Type Description
SessionEvent.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException