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
Static Fields
ENTITIES_FIELD_NUMBER
public static final int ENTITIES_FIELD_NUMBER
Field Value
ENTITY_OVERRIDE_MODE_FIELD_NUMBER
public static final int ENTITY_OVERRIDE_MODE_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static SessionEntityType getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static SessionEntityType.Builder newBuilder()
Returns
newBuilder(SessionEntityType prototype)
public static SessionEntityType.Builder newBuilder(SessionEntityType prototype)
Parameter
Returns
public static SessionEntityType parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static SessionEntityType parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SessionEntityType parseFrom(byte[] data)
Parameter
Name |
Description |
data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SessionEntityType parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SessionEntityType parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SessionEntityType parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SessionEntityType parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static SessionEntityType parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SessionEntityType parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static SessionEntityType parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SessionEntityType parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SessionEntityType parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<SessionEntityType> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public SessionEntityType getDefaultInstanceForType()
Returns
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
|
Returns
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
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];
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.v3beta1.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.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];
Returns
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
getParserForType()
public Parser<SessionEntityType> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public SessionEntityType.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SessionEntityType.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public SessionEntityType.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions