- 0.56.0 (latest)
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public interface SessionOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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. |