Interface SessionOrBuilder (0.58.0)

public interface SessionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDisplayName()

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

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

Returns
Type Description
ByteString

The bytes for displayName.

getEndTime()

public abstract 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 abstract 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

getIsPinned()

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

Returns
Type Description
boolean

The isPinned.

getName()

public abstract String getName()

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

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

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

Returns
Type Description
ByteString

The bytes for name.

getStartTime()

public abstract 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 abstract 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 abstract Session.State getState()

The state of the session.

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

Returns
Type Description
Session.State

The state.

getStateValue()

public abstract int getStateValue()

The state of the session.

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

Returns
Type Description
int

The enum numeric value on the wire for state.

getTurns(int index)

public abstract Session.Turn getTurns(int index)

Turns.

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

Parameter
Name Description
index int
Returns
Type Description
Session.Turn

getTurnsCount()

public abstract int getTurnsCount()

Turns.

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

Returns
Type Description
int

getTurnsList()

public abstract List<Session.Turn> getTurnsList()

Turns.

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

Returns
Type Description
List<Turn>

getTurnsOrBuilder(int index)

public abstract Session.TurnOrBuilder getTurnsOrBuilder(int index)

Turns.

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

Parameter
Name Description
index int
Returns
Type Description
Session.TurnOrBuilder

getTurnsOrBuilderList()

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

Turns.

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

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

getUserPseudoId()

public abstract String getUserPseudoId()

A unique identifier for tracking users.

string user_pseudo_id = 3;

Returns
Type Description
String

The userPseudoId.

getUserPseudoIdBytes()

public abstract ByteString getUserPseudoIdBytes()

A unique identifier for tracking users.

string user_pseudo_id = 3;

Returns
Type Description
ByteString

The bytes for userPseudoId.

hasEndTime()

public abstract 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 abstract 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.