Class Session (0.40.0)

public final class Session extends GeneratedMessageV3 implements SessionOrBuilder

External session proto definition.

Protobuf type google.cloud.discoveryengine.v1beta.Session

Implements

SessionOrBuilder

Static Fields

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TURNS_FIELD_NUMBER

public static final int TURNS_FIELD_NUMBER
Field Value
Type Description
int

USER_PSEUDO_ID_FIELD_NUMBER

public static final int USER_PSEUDO_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Session getDefaultInstance()
Returns
Type Description
Session

getDescriptor()

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

newBuilder()

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

newBuilder(Session prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Session getDefaultInstanceForType()
Returns
Type Description
Session

getEndTime()

public Timestamp getEndTime()

Output only. The time the session finished.

.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. The time the session finished.

.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getName()

public String getName()

Immutable. Fully qualified name project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. Fully qualified name project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

Output only. The time the session started.

.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. The time the session started.

.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getState()

public Session.State getState()

The state of the session.

.google.cloud.discoveryengine.v1beta.Session.State state = 2;

Returns
Type Description
Session.State

The state.

getStateValue()

public int getStateValue()

The state of the session.

.google.cloud.discoveryengine.v1beta.Session.State state = 2;

Returns
Type Description
int

The enum numeric value on the wire for state.

getTurns(int index)

public Session.Turn getTurns(int index)

Turns.

repeated .google.cloud.discoveryengine.v1beta.Session.Turn turns = 4;

Parameter
Name Description
index int
Returns
Type Description
Session.Turn

getTurnsCount()

public int getTurnsCount()

Turns.

repeated .google.cloud.discoveryengine.v1beta.Session.Turn turns = 4;

Returns
Type Description
int

getTurnsList()

public List<Session.Turn> getTurnsList()

Turns.

repeated .google.cloud.discoveryengine.v1beta.Session.Turn turns = 4;

Returns
Type Description
List<Turn>

getTurnsOrBuilder(int index)

public Session.TurnOrBuilder getTurnsOrBuilder(int index)

Turns.

repeated .google.cloud.discoveryengine.v1beta.Session.Turn turns = 4;

Parameter
Name Description
index int
Returns
Type Description
Session.TurnOrBuilder

getTurnsOrBuilderList()

public List<? extends Session.TurnOrBuilder> getTurnsOrBuilderList()

Turns.

repeated .google.cloud.discoveryengine.v1beta.Session.Turn turns = 4;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1beta.Session.TurnOrBuilder>

getUserPseudoId()

public String getUserPseudoId()

A unique identifier for tracking users.

string user_pseudo_id = 3;

Returns
Type Description
String

The userPseudoId.

getUserPseudoIdBytes()

public ByteString getUserPseudoIdBytes()

A unique identifier for tracking users.

string user_pseudo_id = 3;

Returns
Type Description
ByteString

The bytes for userPseudoId.

hasEndTime()

public boolean hasEndTime()

Output only. The time the session finished.

.google.protobuf.Timestamp end_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the endTime field is set.

hasStartTime()

public boolean hasStartTime()

Output only. The time the session started.

.google.protobuf.Timestamp start_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the startTime 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 Session.Builder newBuilderForType()
Returns
Type Description
Session.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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