Send feedback Class SessionEntityType (0.40.0) Stay organized with collections Save and categorize content based on your preferences.
Version 0.40.0keyboard_arrow_down
public final class SessionEntityType extends GeneratedMessageV3 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.v3beta1.SessionEntityType
Inherited Members com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields ENTITIES_FIELD_NUMBER
public static final int ENTITIES_FIELD_NUMBER
Field Value Type Description int
ENTITY_OVERRIDE_MODE_FIELD_NUMBER
public static final int ENTITY_OVERRIDE_MODE_FIELD_NUMBER
Field Value Type Description int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value Type Description int
Static Methods getDefaultInstance()
public static SessionEntityType getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static SessionEntityType . Builder newBuilder ()
newBuilder(SessionEntityType )
public static SessionEntityType . Builder newBuilder ( SessionEntityType )
public static SessionEntityType parseDelimitedFrom ( InputStream input )
public static SessionEntityType parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static SessionEntityType parseFrom ( byte [] data )
Parameter Name Description data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SessionEntityType parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static SessionEntityType parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SessionEntityType parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static SessionEntityType parseFrom ( CodedInputStream input )
public static SessionEntityType parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static SessionEntityType parseFrom ( InputStream input )
public static SessionEntityType parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static SessionEntityType parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SessionEntityType parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<SessionEntityType> parser ()
Methods equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description obj
Object
Overrides getDefaultInstanceForType()
public SessionEntityType getDefaultInstanceForType ()
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.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter Name Description index
int
getEntitiesCount()
public int getEntitiesCount ()
Required. The collection of entities to override or supplement the custom entity type.
repeated .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
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.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Parameter Name Description index
int
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.v3beta1.EntityType.Entity entities = 4 [(.google.api.field_behavior) = REQUIRED];
Returns Type Description List <? extends com.google.cloud.dialogflow.cx.v3beta1.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.v3beta1.SessionEntityType.EntityOverrideMode entity_override_mode = 3 [(.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.cx.v3beta1.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 Type Description ByteString
The bytes for name.
getParserForType()
public Parser<SessionEntityType> getParserForType ()
Overrides getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
Overrides hashCode() Returns Type Description int
Overrides internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides isInitialized()
public final boolean isInitialized ()
Overrides newBuilderForType()
public SessionEntityType . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SessionEntityType . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides toBuilder()
public SessionEntityType . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-05 UTC.
Need to tell us more? [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-05 UTC."],[],[]]