Class EntityType.Entity (0.53.0)

public static final class EntityType.Entity extends GeneratedMessageV3 implements EntityType.EntityOrBuilder

An entity entry for an associated entity type.

Protobuf type google.cloud.dialogflow.cx.v3beta1.EntityType.Entity

Static Fields

SYNONYMS_FIELD_NUMBER

public static final int SYNONYMS_FIELD_NUMBER
Field Value
Type Description
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EntityType.Entity getDefaultInstance()
Returns
Type Description
EntityType.Entity

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static EntityType.Entity.Builder newBuilder()
Returns
Type Description
EntityType.Entity.Builder

newBuilder(EntityType.Entity prototype)

public static EntityType.Entity.Builder newBuilder(EntityType.Entity prototype)
Parameter
Name Description
prototype EntityType.Entity
Returns
Type Description
EntityType.Entity.Builder

parseDelimitedFrom(InputStream input)

public static EntityType.Entity parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EntityType.Entity
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EntityType.Entity parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityType.Entity
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static EntityType.Entity parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
EntityType.Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EntityType.Entity parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityType.Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EntityType.Entity parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
EntityType.Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EntityType.Entity parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityType.Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EntityType.Entity parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
EntityType.Entity
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EntityType.Entity parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityType.Entity
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static EntityType.Entity parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EntityType.Entity
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EntityType.Entity parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityType.Entity
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static EntityType.Entity parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
EntityType.Entity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EntityType.Entity parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EntityType.Entity
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<EntityType.Entity> parser()
Returns
Type Description
Parser<Entity>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public EntityType.Entity getDefaultInstanceForType()
Returns
Type Description
EntityType.Entity

getParserForType()

public Parser<EntityType.Entity> getParserForType()
Returns
Type Description
Parser<Entity>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSynonyms(int index)

public String getSynonyms(int index)

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

  • This collection must contain exactly one synonym equal to value.

repeated string synonyms = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The synonyms at the given index.

getSynonymsBytes(int index)

public ByteString getSynonymsBytes(int index)

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

  • This collection must contain exactly one synonym equal to value.

repeated string synonyms = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the synonyms at the given index.

getSynonymsCount()

public int getSynonymsCount()

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

  • This collection must contain exactly one synonym equal to value.

repeated string synonyms = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of synonyms.

getSynonymsList()

public ProtocolStringList getSynonymsList()

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

  • This collection must contain exactly one synonym equal to value.

repeated string synonyms = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProtocolStringList

A list containing the synonyms.

getValue()

public String getValue()

Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions.

For KIND_MAP entity types:

  • A canonical value to be used in place of synonyms.

    For KIND_LIST entity types:

  • A string that can contain references to other entity types (with or without aliases).

string value = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The value.

getValueBytes()

public ByteString getValueBytes()

Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions.

For KIND_MAP entity types:

  • A canonical value to be used in place of synonyms.

    For KIND_LIST entity types:

  • A string that can contain references to other entity types (with or without aliases).

string value = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for value.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public EntityType.Entity.Builder newBuilderForType()
Returns
Type Description
EntityType.Entity.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected EntityType.Entity.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
EntityType.Entity.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public EntityType.Entity.Builder toBuilder()
Returns
Type Description
EntityType.Entity.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException