- 0.66.0 (latest)
- 0.65.0
- 0.64.0
- 0.63.0
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.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.35.0
- 0.34.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.22.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.7
- 0.13.1
- 0.12.1
- 0.11.5
public static final class SessionEntityType.Builder extends GeneratedMessageV3.Builder<SessionEntityType.Builder> implements SessionEntityTypeOrBuilderSession 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SessionEntityType.BuilderImplements
SessionEntityTypeOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
EntityType.Entity |
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
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 | |
|---|---|
| Name | Description |
builderForValue |
EntityType.Entity.Builder |
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
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 | |
|---|---|
| Name | Description |
index |
int |
value |
EntityType.Entity |
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
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 | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
EntityType.Entity.Builder |
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
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 | |
|---|---|
| Type | Description |
EntityType.Entity.Builder |
|
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 | |
|---|---|
| Type | Description |
EntityType.Entity.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SessionEntityType.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
build()
public SessionEntityType build()| Returns | |
|---|---|
| Type | Description |
SessionEntityType |
|
buildPartial()
public SessionEntityType buildPartial()| Returns | |
|---|---|
| Type | Description |
SessionEntityType |
|
clear()
public SessionEntityType.Builder clear()| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
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 | |
|---|---|
| Type | Description |
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.cx.v3.SessionEntityType.EntityOverrideMode entity_override_mode = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public SessionEntityType.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
clearName()
public SessionEntityType.Builder clearName() Required. The unique identifier of the session entity type.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>
or
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>.
If Environment ID is not specified, we assume default 'draft'
environment.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public SessionEntityType.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
clone()
public SessionEntityType.Builder clone()| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
getDefaultInstanceForType()
public SessionEntityType getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SessionEntityType |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 | |
|---|---|
| Type | Description |
EntityType.Entity |
|
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 | |
|---|---|
| Type | Description |
EntityType.Entity.Builder |
|
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 | |
|---|---|
| Type | Description |
List<Builder> |
|
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 | |
|---|---|
| Type | Description |
int |
|
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 | |
|---|---|
| Type | Description |
List<Entity> |
|
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 | |
|---|---|
| Type | Description |
EntityType.EntityOrBuilder |
|
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 | |
|---|---|
| Type | Description |
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.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()
public String getName() Required. The unique identifier of the session entity type.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>
or
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>.
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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>
or
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>.
If Environment ID is not specified, we assume default 'draft'
environment.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(SessionEntityType other)
public SessionEntityType.Builder mergeFrom(SessionEntityType other)| Parameter | |
|---|---|
| Name | Description |
other |
SessionEntityType |
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SessionEntityType.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SessionEntityType.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SessionEntityType.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
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 | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
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 | |
|---|---|
| Name | Description |
index |
int |
value |
EntityType.Entity |
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
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 | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
EntityType.Entity.Builder |
| Returns | |
|---|---|
| Type | Description |
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.cx.v3.SessionEntityType.EntityOverrideMode entity_override_mode = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
SessionEntityType.EntityOverrideModeThe entityOverrideMode to set. |
| Returns | |
|---|---|
| Type | Description |
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.cx.v3.SessionEntityType.EntityOverrideMode entity_override_mode = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for entityOverrideMode to set. |
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public SessionEntityType.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
setName(String value)
public SessionEntityType.Builder setName(String value) Required. The unique identifier of the session entity type.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>
or
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>.
If Environment ID is not specified, we assume default 'draft'
environment.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public SessionEntityType.Builder setNameBytes(ByteString value) Required. The unique identifier of the session entity type.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>
or
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>/entityTypes/<EntityTypeID>.
If Environment ID is not specified, we assume default 'draft'
environment.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final SessionEntityType.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SessionEntityType.Builder |
|