Class SessionEntityType.Builder (4.7.5)

public static final class SessionEntityType.Builder extends GeneratedMessageV3.Builder<SessionEntityType.Builder> implements SessionEntityTypeOrBuilder

A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes. For more information, see the session entity guide.

Protobuf type google.cloud.dialogflow.v2.SessionEntityType

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllEntities(Iterable<? extends EntityType.Entity> values)

public SessionEntityType.Builder addAllEntities(Iterable<? extends EntityType.Entity> values)

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.dialogflow.v2.EntityType.Entity>
Returns
TypeDescription
SessionEntityType.Builder

addEntities(EntityType.Entity value)

public SessionEntityType.Builder addEntities(EntityType.Entity value)

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueEntityType.Entity
Returns
TypeDescription
SessionEntityType.Builder

addEntities(EntityType.Entity.Builder builderForValue)

public SessionEntityType.Builder addEntities(EntityType.Entity.Builder builderForValue)

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueEntityType.Entity.Builder
Returns
TypeDescription
SessionEntityType.Builder

addEntities(int index, EntityType.Entity value)

public SessionEntityType.Builder addEntities(int index, EntityType.Entity value)

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
valueEntityType.Entity
Returns
TypeDescription
SessionEntityType.Builder

addEntities(int index, EntityType.Entity.Builder builderForValue)

public SessionEntityType.Builder addEntities(int index, EntityType.Entity.Builder builderForValue)

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
builderForValueEntityType.Entity.Builder
Returns
TypeDescription
SessionEntityType.Builder

addEntitiesBuilder()

public EntityType.Entity.Builder addEntitiesBuilder()

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
EntityType.Entity.Builder

addEntitiesBuilder(int index)

public EntityType.Entity.Builder addEntitiesBuilder(int index)

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
EntityType.Entity.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SessionEntityType.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SessionEntityType.Builder
Overrides

build()

public SessionEntityType build()
Returns
TypeDescription
SessionEntityType

buildPartial()

public SessionEntityType buildPartial()
Returns
TypeDescription
SessionEntityType

clear()

public SessionEntityType.Builder clear()
Returns
TypeDescription
SessionEntityType.Builder
Overrides

clearEntities()

public SessionEntityType.Builder clearEntities()

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
SessionEntityType.Builder

clearEntityOverrideMode()

public SessionEntityType.Builder clearEntityOverrideMode()

Required. Indicates whether the additional data should override or supplement the custom entity type definition.

.google.cloud.dialogflow.v2.SessionEntityType.EntityOverrideMode entity_override_mode = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
SessionEntityType.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SessionEntityType.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SessionEntityType.Builder
Overrides

clearName()

public SessionEntityType.Builder clearName()

Required. The unique identifier of this session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. <Entity Type Display Name> must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

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

Returns
TypeDescription
SessionEntityType.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SessionEntityType.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SessionEntityType.Builder
Overrides

clone()

public SessionEntityType.Builder clone()
Returns
TypeDescription
SessionEntityType.Builder
Overrides

getDefaultInstanceForType()

public SessionEntityType getDefaultInstanceForType()
Returns
TypeDescription
SessionEntityType

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEntities(int index)

public EntityType.Entity getEntities(int index)

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
EntityType.Entity

getEntitiesBuilder(int index)

public EntityType.Entity.Builder getEntitiesBuilder(int index)

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
EntityType.Entity.Builder

getEntitiesBuilderList()

public List<EntityType.Entity.Builder> getEntitiesBuilderList()

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<Builder>

getEntitiesCount()

public int getEntitiesCount()

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

getEntitiesList()

public List<EntityType.Entity> getEntitiesList()

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<Entity>

getEntitiesOrBuilder(int index)

public EntityType.EntityOrBuilder getEntitiesOrBuilder(int index)

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
EntityType.EntityOrBuilder

getEntitiesOrBuilderList()

public List<? extends EntityType.EntityOrBuilder> getEntitiesOrBuilderList()

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<? extends com.google.cloud.dialogflow.v2.EntityType.EntityOrBuilder>

getEntityOverrideMode()

public SessionEntityType.EntityOverrideMode getEntityOverrideMode()

Required. Indicates whether the additional data should override or supplement the custom entity type definition.

.google.cloud.dialogflow.v2.SessionEntityType.EntityOverrideMode entity_override_mode = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
SessionEntityType.EntityOverrideMode

The entityOverrideMode.

getEntityOverrideModeValue()

public int getEntityOverrideModeValue()

Required. Indicates whether the additional data should override or supplement the custom entity type definition.

.google.cloud.dialogflow.v2.SessionEntityType.EntityOverrideMode entity_override_mode = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The enum numeric value on the wire for entityOverrideMode.

getName()

public String getName()

Required. The unique identifier of this session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. <Entity Type Display Name> must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The unique identifier of this session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. <Entity Type Display Name> must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

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

Returns
TypeDescription
ByteString

The bytes for name.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SessionEntityType other)

public SessionEntityType.Builder mergeFrom(SessionEntityType other)
Parameter
NameDescription
otherSessionEntityType
Returns
TypeDescription
SessionEntityType.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SessionEntityType.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SessionEntityType.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SessionEntityType.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SessionEntityType.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SessionEntityType.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SessionEntityType.Builder
Overrides

removeEntities(int index)

public SessionEntityType.Builder removeEntities(int index)

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
SessionEntityType.Builder

setEntities(int index, EntityType.Entity value)

public SessionEntityType.Builder setEntities(int index, EntityType.Entity value)

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
valueEntityType.Entity
Returns
TypeDescription
SessionEntityType.Builder

setEntities(int index, EntityType.Entity.Builder builderForValue)

public SessionEntityType.Builder setEntities(int index, EntityType.Entity.Builder builderForValue)

Required. The collection of entities associated with this session entity type.

repeated .google.cloud.dialogflow.v2.EntityType.Entity entities = 3 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
builderForValueEntityType.Entity.Builder
Returns
TypeDescription
SessionEntityType.Builder

setEntityOverrideMode(SessionEntityType.EntityOverrideMode value)

public SessionEntityType.Builder setEntityOverrideMode(SessionEntityType.EntityOverrideMode value)

Required. Indicates whether the additional data should override or supplement the custom entity type definition.

.google.cloud.dialogflow.v2.SessionEntityType.EntityOverrideMode entity_override_mode = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueSessionEntityType.EntityOverrideMode

The entityOverrideMode to set.

Returns
TypeDescription
SessionEntityType.Builder

This builder for chaining.

setEntityOverrideModeValue(int value)

public SessionEntityType.Builder setEntityOverrideModeValue(int value)

Required. Indicates whether the additional data should override or supplement the custom entity type definition.

.google.cloud.dialogflow.v2.SessionEntityType.EntityOverrideMode entity_override_mode = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueint

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

Returns
TypeDescription
SessionEntityType.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SessionEntityType.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SessionEntityType.Builder
Overrides

setName(String value)

public SessionEntityType.Builder setName(String value)

Required. The unique identifier of this session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. <Entity Type Display Name> must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
SessionEntityType.Builder

This builder for chaining.

setNameBytes(ByteString value)

public SessionEntityType.Builder setNameBytes(ByteString value)

Required. The unique identifier of this session entity type. Format: projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. <Entity Type Display Name> must be the display name of an existing entity type in the same agent that will be overridden or supplemented.

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
SessionEntityType.Builder

This builder for chaining.

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

public SessionEntityType.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SessionEntityType.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SessionEntityType.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SessionEntityType.Builder
Overrides