- 4.54.0 (latest)
- 4.53.0
- 4.52.0
- 4.51.0
- 4.50.0
- 4.49.0
- 4.48.0
- 4.47.0
- 4.46.0
- 4.45.0
- 4.43.0
- 4.42.0
- 4.41.0
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.0
- 4.36.0
- 4.35.0
- 4.34.0
- 4.33.0
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.23.0
- 4.22.0
- 4.21.0
- 4.20.0
- 4.19.0
- 4.18.0
- 4.17.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.1
- 4.8.6
- 4.7.5
- 4.6.0
- 4.5.11
- 4.4.0
- 4.3.1
public final class SessionEntityType extends GeneratedMessageV3 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.v2beta1.SessionEntityType
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SessionEntityTypeImplements
SessionEntityTypeOrBuilderStatic 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()
Returns | |
---|---|
Type | Description |
SessionEntityType |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static SessionEntityType.Builder newBuilder()
Returns | |
---|---|
Type | Description |
SessionEntityType.Builder |
newBuilder(SessionEntityType prototype)
public static SessionEntityType.Builder newBuilder(SessionEntityType prototype)
Parameter | |
---|---|
Name | Description |
prototype |
SessionEntityType |
Returns | |
---|---|
Type | Description |
SessionEntityType.Builder |
parseDelimitedFrom(InputStream input)
public static SessionEntityType parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
SessionEntityType |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SessionEntityType parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SessionEntityType |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static SessionEntityType parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
SessionEntityType |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SessionEntityType parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SessionEntityType |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static SessionEntityType parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
SessionEntityType |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SessionEntityType parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SessionEntityType |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static SessionEntityType parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
SessionEntityType |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SessionEntityType parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SessionEntityType |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static SessionEntityType parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
SessionEntityType |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SessionEntityType parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SessionEntityType |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static SessionEntityType parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
SessionEntityType |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SessionEntityType parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SessionEntityType |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<SessionEntityType> parser()
Returns | |
---|---|
Type | Description |
Parser<SessionEntityType> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public SessionEntityType getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
SessionEntityType |
getEntities(int index)
public EntityType.Entity getEntities(int index)
Required. The collection of entities associated with this session entity type.
repeated .google.cloud.dialogflow.v2beta1.EntityType.Entity entities = 3;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
EntityType.Entity |
getEntitiesCount()
public int getEntitiesCount()
Required. The collection of entities associated with this session entity type.
repeated .google.cloud.dialogflow.v2beta1.EntityType.Entity entities = 3;
Returns | |
---|---|
Type | Description |
int |
getEntitiesList()
public List<EntityType.Entity> getEntitiesList()
Required. The collection of entities associated with this session entity type.
repeated .google.cloud.dialogflow.v2beta1.EntityType.Entity entities = 3;
Returns | |
---|---|
Type | Description |
List<Entity> |
getEntitiesOrBuilder(int index)
public EntityType.EntityOrBuilder getEntitiesOrBuilder(int index)
Required. The collection of entities associated with this session entity type.
repeated .google.cloud.dialogflow.v2beta1.EntityType.Entity entities = 3;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
EntityType.EntityOrBuilder |
getEntitiesOrBuilderList()
public List<? extends EntityType.EntityOrBuilder> getEntitiesOrBuilderList()
Required. The collection of entities associated with this session entity type.
repeated .google.cloud.dialogflow.v2beta1.EntityType.Entity entities = 3;
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.dialogflow.v2beta1.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.v2beta1.SessionEntityType.EntityOverrideMode entity_override_mode = 2;
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.v2beta1.SessionEntityType.EntityOverrideMode entity_override_mode = 2;
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for entityOverrideMode. |
getName()
public String getName()
Required. The unique identifier of this session entity type. Supported formats:
projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
projects/<Project ID>/locations/<Location ID>/agent/environments/ <Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
IfLocation ID
is not specified we assume default 'us' location. IfEnvironment ID
is not specified, we assume default 'draft' environment. IfUser 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;
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
Required. The unique identifier of this session entity type. Supported formats:
projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
projects/<Project ID>/locations/<Location ID>/agent/environments/ <Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>
IfLocation ID
is not specified we assume default 'us' location. IfEnvironment ID
is not specified, we assume default 'draft' environment. IfUser 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;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getParserForType()
public Parser<SessionEntityType> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<SessionEntityType> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns | |
---|---|
Type | Description |
UnknownFieldSet |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public SessionEntityType.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
SessionEntityType.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SessionEntityType.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
SessionEntityType.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public SessionEntityType.Builder toBuilder()
Returns | |
---|---|
Type | Description |
SessionEntityType.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |