public static final class SessionEntityType.Builder extends GeneratedMessageV3.Builder<SessionEntityType.Builder> implements SessionEntityTypeOrBuilder
Session entity types are referred to as User entity types and are
entities that are built for an individual user such as favorites,
preferences, playlists, and so on.
You can redefine a session entity type at the session level to extend or
replace a custom entity type at the user session level (we
refer to the entity types defined at the agent level as "custom entity
types").
Note: session entity types apply to all queries, regardless of the language.
For more information about entity types, see the Dialogflow
documentation.
Protobuf type google.cloud.dialogflow.cx.v3.SessionEntityType
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addAllEntities(Iterable<? extends EntityType.Entity> values)
public SessionEntityType.Builder addAllEntities(Iterable<? extends EntityType.Entity> values)
Required. The collection of entities to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name |
Description |
values |
Iterable<? extends com.google.cloud.dialogflow.cx.v3.EntityType.Entity>
|
Returns
addEntities(EntityType.Entity value)
public SessionEntityType.Builder addEntities(EntityType.Entity value)
Required. The collection of entities to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
addEntities(EntityType.Entity.Builder builderForValue)
public SessionEntityType.Builder addEntities(EntityType.Entity.Builder builderForValue)
Required. The collection of entities to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
addEntities(int index, EntityType.Entity value)
public SessionEntityType.Builder addEntities(int index, EntityType.Entity value)
Required. The collection of entities to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Parameters
Returns
addEntities(int index, EntityType.Entity.Builder builderForValue)
public SessionEntityType.Builder addEntities(int index, EntityType.Entity.Builder builderForValue)
Required. The collection of entities to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Parameters
Returns
addEntitiesBuilder()
public EntityType.Entity.Builder addEntitiesBuilder()
Required. The collection of entities to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Returns
addEntitiesBuilder(int index)
public EntityType.Entity.Builder addEntitiesBuilder(int index)
Required. The collection of entities to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name |
Description |
index |
int
|
Returns
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 to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Returns
clearEntityOverrideMode()
public SessionEntityType.Builder clearEntityOverrideMode()
Required. Indicates whether the additional data should override or supplement the
custom entity type definition.
.google.cloud.dialogflow.cx.v3.SessionEntityType.EntityOverrideMode entity_override_mode = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
clearField(Descriptors.FieldDescriptor field)
public SessionEntityType.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearName()
public SessionEntityType.Builder clearName()
Required. The unique identifier of the session entity type.
Format: projects/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type
ID>
or projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity
Type ID>
. If Environment ID
is not specified, we assume default 'draft'
environment.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
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
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getEntities(int index)
public EntityType.Entity getEntities(int index)
Required. The collection of entities to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name |
Description |
index |
int
|
Returns
getEntitiesBuilder(int index)
public EntityType.Entity.Builder getEntitiesBuilder(int index)
Required. The collection of entities to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name |
Description |
index |
int
|
Returns
getEntitiesBuilderList()
public List<EntityType.Entity.Builder> getEntitiesBuilderList()
Required. The collection of entities to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Returns
getEntitiesCount()
public int getEntitiesCount()
Required. The collection of entities to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Returns
getEntitiesList()
public List<EntityType.Entity> getEntitiesList()
Required. The collection of entities to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Returns
getEntitiesOrBuilder(int index)
public EntityType.EntityOrBuilder getEntitiesOrBuilder(int index)
Required. The collection of entities to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name |
Description |
index |
int
|
Returns
getEntitiesOrBuilderList()
public List<? extends EntityType.EntityOrBuilder> getEntitiesOrBuilderList()
Required. The collection of entities to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Returns
Type |
Description |
List<? extends com.google.cloud.dialogflow.cx.v3.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.cx.v3.SessionEntityType.EntityOverrideMode entity_override_mode = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
getEntityOverrideModeValue()
public int getEntityOverrideModeValue()
Required. Indicates whether the additional data should override or supplement the
custom entity type definition.
.google.cloud.dialogflow.cx.v3.SessionEntityType.EntityOverrideMode entity_override_mode = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
Type |
Description |
int |
The enum numeric value on the wire for entityOverrideMode.
|
getName()
Required. The unique identifier of the session entity type.
Format: projects/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type
ID>
or projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity
Type ID>
. If Environment ID
is not specified, we assume default 'draft'
environment.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. The unique identifier of the session entity type.
Format: projects/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type
ID>
or projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity
Type ID>
. If Environment ID
is not specified, we assume default 'draft'
environment.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
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 to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name |
Description |
index |
int
|
Returns
setEntities(int index, EntityType.Entity value)
public SessionEntityType.Builder setEntities(int index, EntityType.Entity value)
Required. The collection of entities to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Parameters
Returns
setEntities(int index, EntityType.Entity.Builder builderForValue)
public SessionEntityType.Builder setEntities(int index, EntityType.Entity.Builder builderForValue)
Required. The collection of entities to override or supplement the custom entity
type.
repeated .google.cloud.dialogflow.cx.v3.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Parameters
Returns
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.cx.v3.SessionEntityType.EntityOverrideMode entity_override_mode = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
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.cx.v3.SessionEntityType.EntityOverrideMode entity_override_mode = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter
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 the session entity type.
Format: projects/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type
ID>
or projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity
Type ID>
. If Environment ID
is not specified, we assume default 'draft'
environment.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name |
Description |
value |
String
The name to set.
|
Returns
setNameBytes(ByteString value)
public SessionEntityType.Builder setNameBytes(ByteString value)
Required. The unique identifier of the session entity type.
Format: projects/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type
ID>
or projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity
Type ID>
. If Environment ID
is not specified, we assume default 'draft'
environment.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter
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