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
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];
| Name | Description |
| values | Iterable<? extends com.google.cloud.dialogflow.v2.EntityType.Entity>
|
Returns
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];
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];
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];
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];
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];
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];
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SessionEntityType.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public SessionEntityType build()
Returns
buildPartial()
public SessionEntityType buildPartial()
Returns
clear()
public SessionEntityType.Builder clear()
Returns
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];
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];
clearField(Descriptors.FieldDescriptor field)
public SessionEntityType.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
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];
clearOneof(Descriptors.OneofDescriptor oneof)
public SessionEntityType.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clone()
public SessionEntityType.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public SessionEntityType getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
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];
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];
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];
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];
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];
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];
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];
| Type | Description |
| 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];
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];
| Type | Description |
| int | The enum numeric value on the wire for entityOverrideMode.
|
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];
| Type | Description |
| 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];
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(SessionEntityType other)
public SessionEntityType.Builder mergeFrom(SessionEntityType other)
Parameter
Returns
public SessionEntityType.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public SessionEntityType.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SessionEntityType.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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];
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];
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];
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];
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];
| Name | Description |
| value | int
The enum numeric value on the wire for entityOverrideMode to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public SessionEntityType.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
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];
| Name | Description |
| value | String
The name to set.
|
Returns
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];
| Name | Description |
| value | ByteString
The bytes for name to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SessionEntityType.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final SessionEntityType.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
