com.google.cloud.discoveryengine.v1alpha

Interface SessionOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Session, Session.Builder

public interface SessionOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Timestamp	getEndTime() Output only.
com.google.protobuf.TimestampOrBuilder	getEndTimeOrBuilder() Output only.
String	getName() Immutable.
com.google.protobuf.ByteString	getNameBytes() Immutable.
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.
boolean	hasStartTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

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

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

Returns:

The name.

getNameBytes

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

Returns:

The bytes for name.

getStateValue

int getStateValue()

 The state of the session.
 

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

Returns:

The enum numeric value on the wire for state.

getState

Session.State getState()

 The state of the session.
 

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

Returns:

The state.

getUserPseudoId

String getUserPseudoId()

 A unique identifier for tracking users.
 

string user_pseudo_id = 3;

Returns:

The userPseudoId.

getUserPseudoIdBytes

com.google.protobuf.ByteString getUserPseudoIdBytes()

 A unique identifier for tracking users.
 

string user_pseudo_id = 3;

Returns:

The bytes for userPseudoId.

getTurnsList

List<Session.Turn> getTurnsList()

 Turns.
 

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

getTurns

Session.Turn getTurns(int index)

 Turns.
 

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

getTurnsCount

int getTurnsCount()

 Turns.
 

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

getTurnsOrBuilderList

List<? extends Session.TurnOrBuilder> getTurnsOrBuilderList()

 Turns.
 

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

getTurnsOrBuilder

Session.TurnOrBuilder getTurnsOrBuilder(int index)

 Turns.
 

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

hasStartTime

boolean hasStartTime()

 Output only. The time the session started.
 

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

Returns:

Whether the startTime field is set.

getStartTime

com.google.protobuf.Timestamp getStartTime()

 Output only. The time the session started.
 

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

Returns:

The startTime.

getStartTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

 Output only. The time the session started.
 

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

hasEndTime

boolean hasEndTime()

 Output only. The time the session finished.
 

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

Returns:

Whether the endTime field is set.

getEndTime

com.google.protobuf.Timestamp getEndTime()

 Output only. The time the session finished.
 

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

Returns:

The endTime.

getEndTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()

 Output only. The time the session finished.
 

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