Class Session.Builder (0.42.0)

public static final class Session.Builder extends GeneratedMessageV3.Builder<Session.Builder> implements SessionOrBuilder

External session proto definition.

Protobuf type google.cloud.discoveryengine.v1.Session

Implements

SessionOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllTurns(Iterable<? extends Session.Turn> values)

public Session.Builder addAllTurns(Iterable<? extends Session.Turn> values)

Turns.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1.Session.Turn>
Returns
Type Description
Session.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Session.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Session.Builder
Overrides

addTurns(Session.Turn value)

public Session.Builder addTurns(Session.Turn value)

Turns.

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

Parameter
Name Description
value Session.Turn
Returns
Type Description
Session.Builder

addTurns(Session.Turn.Builder builderForValue)

public Session.Builder addTurns(Session.Turn.Builder builderForValue)

Turns.

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

Parameter
Name Description
builderForValue Session.Turn.Builder
Returns
Type Description
Session.Builder

addTurns(int index, Session.Turn value)

public Session.Builder addTurns(int index, Session.Turn value)

Turns.

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

Parameters
Name Description
index int
value Session.Turn
Returns
Type Description
Session.Builder

addTurns(int index, Session.Turn.Builder builderForValue)

public Session.Builder addTurns(int index, Session.Turn.Builder builderForValue)

Turns.

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

Parameters
Name Description
index int
builderForValue Session.Turn.Builder
Returns
Type Description
Session.Builder

addTurnsBuilder()

public Session.Turn.Builder addTurnsBuilder()

Turns.

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

Returns
Type Description
Session.Turn.Builder

addTurnsBuilder(int index)

public Session.Turn.Builder addTurnsBuilder(int index)

Turns.

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

Parameter
Name Description
index int
Returns
Type Description
Session.Turn.Builder

build()

public Session build()
Returns
Type Description
Session

buildPartial()

public Session buildPartial()
Returns
Type Description
Session

clear()

public Session.Builder clear()
Returns
Type Description
Session.Builder
Overrides

clearEndTime()

public Session.Builder clearEndTime()

Output only. The time the session finished.

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

Returns
Type Description
Session.Builder

clearField(Descriptors.FieldDescriptor field)

public Session.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Session.Builder
Overrides

clearName()

public Session.Builder clearName()

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

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

Returns
Type Description
Session.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Session.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Session.Builder
Overrides

clearStartTime()

public Session.Builder clearStartTime()

Output only. The time the session started.

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

Returns
Type Description
Session.Builder

clearState()

public Session.Builder clearState()

The state of the session.

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

Returns
Type Description
Session.Builder

This builder for chaining.

clearTurns()

public Session.Builder clearTurns()

Turns.

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

Returns
Type Description
Session.Builder

clearUserPseudoId()

public Session.Builder clearUserPseudoId()

A unique identifier for tracking users.

string user_pseudo_id = 3;

Returns
Type Description
Session.Builder

This builder for chaining.

clone()

public Session.Builder clone()
Returns
Type Description
Session.Builder
Overrides

getDefaultInstanceForType()

public Session getDefaultInstanceForType()
Returns
Type Description
Session

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

Output only. The time the session finished.

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

Returns
Type Description
Builder

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

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Output only. The time the session started.

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

Returns
Type Description
Builder

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.v1.Session.State state = 2;

Returns
Type Description
Session.State

The state.

getStateValue()

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

getTurnsBuilder(int index)

public Session.Turn.Builder getTurnsBuilder(int index)

Turns.

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

Parameter
Name Description
index int
Returns
Type Description
Session.Turn.Builder

getTurnsBuilderList()

public List<Session.Turn.Builder> getTurnsBuilderList()

Turns.

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

Returns
Type Description
List<Builder>

getTurnsCount()

public int getTurnsCount()

Turns.

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

Returns
Type Description
int

getTurnsList()

public List<Session.Turn> getTurnsList()

Turns.

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

Returns
Type Description
List<Turn>

getTurnsOrBuilder(int index)

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEndTime(Timestamp value)

public Session.Builder mergeEndTime(Timestamp value)

Output only. The time the session finished.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Session.Builder

mergeFrom(Session other)

public Session.Builder mergeFrom(Session other)
Parameter
Name Description
other Session
Returns
Type Description
Session.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Session.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Session.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Session.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Session.Builder
Overrides

mergeStartTime(Timestamp value)

public Session.Builder mergeStartTime(Timestamp value)

Output only. The time the session started.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Session.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Session.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Session.Builder
Overrides

removeTurns(int index)

public Session.Builder removeTurns(int index)

Turns.

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

Parameter
Name Description
index int
Returns
Type Description
Session.Builder

setEndTime(Timestamp value)

public Session.Builder setEndTime(Timestamp value)

Output only. The time the session finished.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Session.Builder

setEndTime(Timestamp.Builder builderForValue)

public Session.Builder setEndTime(Timestamp.Builder builderForValue)

Output only. The time the session finished.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Session.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Session.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Session.Builder
Overrides

setName(String value)

public Session.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Session.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Session.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Session.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Session.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Session.Builder
Overrides

setStartTime(Timestamp value)

public Session.Builder setStartTime(Timestamp value)

Output only. The time the session started.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Session.Builder

setStartTime(Timestamp.Builder builderForValue)

public Session.Builder setStartTime(Timestamp.Builder builderForValue)

Output only. The time the session started.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Session.Builder

setState(Session.State value)

public Session.Builder setState(Session.State value)

The state of the session.

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

Parameter
Name Description
value Session.State

The state to set.

Returns
Type Description
Session.Builder

This builder for chaining.

setStateValue(int value)

public Session.Builder setStateValue(int value)

The state of the session.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
Session.Builder

This builder for chaining.

setTurns(int index, Session.Turn value)

public Session.Builder setTurns(int index, Session.Turn value)

Turns.

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

Parameters
Name Description
index int
value Session.Turn
Returns
Type Description
Session.Builder

setTurns(int index, Session.Turn.Builder builderForValue)

public Session.Builder setTurns(int index, Session.Turn.Builder builderForValue)

Turns.

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

Parameters
Name Description
index int
builderForValue Session.Turn.Builder
Returns
Type Description
Session.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Session.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Session.Builder
Overrides

setUserPseudoId(String value)

public Session.Builder setUserPseudoId(String value)

A unique identifier for tracking users.

string user_pseudo_id = 3;

Parameter
Name Description
value String

The userPseudoId to set.

Returns
Type Description
Session.Builder

This builder for chaining.

setUserPseudoIdBytes(ByteString value)

public Session.Builder setUserPseudoIdBytes(ByteString value)

A unique identifier for tracking users.

string user_pseudo_id = 3;

Parameter
Name Description
value ByteString

The bytes for userPseudoId to set.

Returns
Type Description
Session.Builder

This builder for chaining.