Entity.Type (proto-google-cloud-language-v1 1.56.0 API)

java.lang.Object
- java.lang.Enum<Entity.Type>
- - com.google.cloud.language.v1.Entity.Type

All Implemented Interfaces:: com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Entity.Type>

Enclosing class:: Entity

public static enum Entity.Type
extends Enum<Entity.Type>
implements com.google.protobuf.ProtocolMessageEnum

 The type of the entity. For most entity types, the associated metadata is a
 Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`). The table
 below lists the associated fields for entities that have different
 metadata.

Protobuf enum google.cloud.language.v1.Entity.Type

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ADDRESS` Address<br><br> The metadata identifies the street number and locality plus whichever additional elements appear in the text:<ul> <li><code>street_number</code> – street number</li> <li><code>locality</code> – city or town</li> <li><code>street_name</code> – street/route name, if detected</li> <li><code>postal_code</code> – postal code, if detected</li> <li><code>country</code> – country, if detected</li> <li><code>broad_region</code> – administrative area, such as the state, if detected</li> <li><code>narrow_region</code> – smaller administrative area, such as county, if detected</li> <li><code>sublocality</code> – used in Asian addresses to demark a district within a city, if detected</li></ul>
`CONSUMER_GOOD` Consumer product
`DATE` Date<br><br> The metadata identifies the components of the date:<ul> <li><code>year</code> – four digit year, if detected</li> <li><code>month</code> – two digit month number, if detected</li> <li><code>day</code> – two digit day number, if detected</li></ul>
`EVENT` Event
`LOCATION` Location
`NUMBER` Number<br><br> The metadata is the number itself.
`ORGANIZATION` Organization
`OTHER` Other types of entities
`PERSON` Person
`PHONE_NUMBER` Phone number<br><br> The metadata lists the phone number, formatted according to local convention, plus whichever additional elements appear in the text:<ul> <li><code>number</code> – the actual number, broken down into sections as per local convention</li> <li><code>national_prefix</code> – country code, if detected</li> <li><code>area_code</code> – region or area code, if detected</li> <li><code>extension</code> – phone extension (to be dialed after connection), if detected</li></ul>
`PRICE` Price<br><br> The metadata identifies the <code>value</code> and <code>currency</code>.
`UNKNOWN` Unknown
`UNRECOGNIZED`
`WORK_OF_ART` Artwork

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ADDRESS_VALUE` Address<br><br> The metadata identifies the street number and locality plus whichever additional elements appear in the text:<ul> <li><code>street_number</code> – street number</li> <li><code>locality</code> – city or town</li> <li><code>street_name</code> – street/route name, if detected</li> <li><code>postal_code</code> – postal code, if detected</li> <li><code>country</code> – country, if detected</li> <li><code>broad_region</code> – administrative area, such as the state, if detected</li> <li><code>narrow_region</code> – smaller administrative area, such as county, if detected</li> <li><code>sublocality</code> – used in Asian addresses to demark a district within a city, if detected</li></ul>
`static int`	`CONSUMER_GOOD_VALUE` Consumer product
`static int`	`DATE_VALUE` Date<br><br> The metadata identifies the components of the date:<ul> <li><code>year</code> – four digit year, if detected</li> <li><code>month</code> – two digit month number, if detected</li> <li><code>day</code> – two digit day number, if detected</li></ul>
`static int`	`EVENT_VALUE` Event
`static int`	`LOCATION_VALUE` Location
`static int`	`NUMBER_VALUE` Number<br><br> The metadata is the number itself.
`static int`	`ORGANIZATION_VALUE` Organization
`static int`	`OTHER_VALUE` Other types of entities
`static int`	`PERSON_VALUE` Person
`static int`	`PHONE_NUMBER_VALUE` Phone number<br><br> The metadata lists the phone number, formatted according to local convention, plus whichever additional elements appear in the text:<ul> <li><code>number</code> – the actual number, broken down into sections as per local convention</li> <li><code>national_prefix</code> – country code, if detected</li> <li><code>area_code</code> – region or area code, if detected</li> <li><code>extension</code> – phone extension (to be dialed after connection), if detected</li></ul>
`static int`	`PRICE_VALUE` Price<br><br> The metadata identifies the <code>value</code> and <code>currency</code>.
`static int`	`UNKNOWN_VALUE` Unknown
`static int`	`WORK_OF_ART_VALUE` Artwork

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Entity.Type`	`forNumber(int value)`
`static com.google.protobuf.Descriptors.EnumDescriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.EnumDescriptor`	`getDescriptorForType()`
`int`	`getNumber()`
`com.google.protobuf.Descriptors.EnumValueDescriptor`	`getValueDescriptor()`
`static com.google.protobuf.Internal.EnumLiteMap<Entity.Type>`	`internalGetValueMap()`
`static Entity.Type`	`valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)`
`static Entity.Type`	`valueOf(int value)` Deprecated. Use `forNumber(int)` instead.
`static Entity.Type`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Entity.Type[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final Entity.Type UNKNOWN

 Unknown

UNKNOWN = 0;

PERSON

public static final Entity.Type PERSON

 Person

PERSON = 1;

LOCATION

public static final Entity.Type LOCATION

 Location

LOCATION = 2;

ORGANIZATION

public static final Entity.Type ORGANIZATION

 Organization

ORGANIZATION = 3;

EVENT

public static final Entity.Type EVENT

 Event

EVENT = 4;

WORK_OF_ART

public static final Entity.Type WORK_OF_ART

 Artwork

WORK_OF_ART = 5;

CONSUMER_GOOD

public static final Entity.Type CONSUMER_GOOD

 Consumer product

CONSUMER_GOOD = 6;

OTHER

public static final Entity.Type OTHER

 Other types of entities

OTHER = 7;

PHONE_NUMBER

public static final Entity.Type PHONE_NUMBER

 Phone number<br><br>
 The metadata lists the phone number, formatted according to local
 convention, plus whichever additional elements appear in the text:<ul>
 <li><code>number</code> &ndash; the actual number, broken down into
 sections as per local convention</li> <li><code>national_prefix</code>
 &ndash; country code, if detected</li> <li><code>area_code</code> &ndash;
 region or area code, if detected</li> <li><code>extension</code> &ndash;
 phone extension (to be dialed after connection), if detected</li></ul>

PHONE_NUMBER = 9;

ADDRESS

public static final Entity.Type ADDRESS

 Address<br><br>
 The metadata identifies the street number and locality plus whichever
 additional elements appear in the text:<ul>
 <li><code>street_number</code> &ndash; street number</li>
 <li><code>locality</code> &ndash; city or town</li>
 <li><code>street_name</code> &ndash; street/route name, if detected</li>
 <li><code>postal_code</code> &ndash; postal code, if detected</li>
 <li><code>country</code> &ndash; country, if detected</li>
 <li><code>broad_region</code> &ndash; administrative area, such as the
 state, if detected</li> <li><code>narrow_region</code> &ndash; smaller
 administrative area, such as county, if detected</li>
 <li><code>sublocality</code> &ndash; used in Asian addresses to demark a
 district within a city, if detected</li></ul>

ADDRESS = 10;

DATE

public static final Entity.Type DATE

 Date<br><br>
 The metadata identifies the components of the date:<ul>
 <li><code>year</code> &ndash; four digit year, if detected</li>
 <li><code>month</code> &ndash; two digit month number, if detected</li>
 <li><code>day</code> &ndash; two digit day number, if detected</li></ul>

DATE = 11;

NUMBER

public static final Entity.Type NUMBER

 Number<br><br>
 The metadata is the number itself.

NUMBER = 12;

PRICE

public static final Entity.Type PRICE

 Price<br><br>
 The metadata identifies the <code>value</code> and <code>currency</code>.

PRICE = 13;

UNRECOGNIZED

public static final Entity.Type UNRECOGNIZED

Field Detail

UNKNOWN_VALUE
```
public static final int UNKNOWN_VALUE
```
```
 Unknown
 
```
UNKNOWN = 0;
See Also:

Constant Field Values

PERSON_VALUE
```
public static final int PERSON_VALUE
```
```
 Person
 
```
PERSON = 1;
See Also:

Constant Field Values

LOCATION_VALUE
```
public static final int LOCATION_VALUE
```
```
 Location
 
```
LOCATION = 2;
See Also:

Constant Field Values

ORGANIZATION_VALUE
```
public static final int ORGANIZATION_VALUE
```
```
 Organization
 
```
ORGANIZATION = 3;
See Also:

Constant Field Values

EVENT_VALUE
```
public static final int EVENT_VALUE
```
```
 Event
 
```
EVENT = 4;
See Also:

Constant Field Values

WORK_OF_ART_VALUE
```
public static final int WORK_OF_ART_VALUE
```
```
 Artwork
 
```
WORK_OF_ART = 5;
See Also:

Constant Field Values

CONSUMER_GOOD_VALUE
```
public static final int CONSUMER_GOOD_VALUE
```
```
 Consumer product
 
```
CONSUMER_GOOD = 6;
See Also:

Constant Field Values

OTHER_VALUE

public static final int OTHER_VALUE

 Other types of entities

OTHER = 7;

See Also:: Constant Field Values

PHONE_NUMBER_VALUE

public static final int PHONE_NUMBER_VALUE

 Phone number<br><br>
 The metadata lists the phone number, formatted according to local
 convention, plus whichever additional elements appear in the text:<ul>
 <li><code>number</code> &ndash; the actual number, broken down into
 sections as per local convention</li> <li><code>national_prefix</code>
 &ndash; country code, if detected</li> <li><code>area_code</code> &ndash;
 region or area code, if detected</li> <li><code>extension</code> &ndash;
 phone extension (to be dialed after connection), if detected</li></ul>

PHONE_NUMBER = 9;

See Also:: Constant Field Values

ADDRESS_VALUE

public static final int ADDRESS_VALUE

 Address<br><br>
 The metadata identifies the street number and locality plus whichever
 additional elements appear in the text:<ul>
 <li><code>street_number</code> &ndash; street number</li>
 <li><code>locality</code> &ndash; city or town</li>
 <li><code>street_name</code> &ndash; street/route name, if detected</li>
 <li><code>postal_code</code> &ndash; postal code, if detected</li>
 <li><code>country</code> &ndash; country, if detected</li>
 <li><code>broad_region</code> &ndash; administrative area, such as the
 state, if detected</li> <li><code>narrow_region</code> &ndash; smaller
 administrative area, such as county, if detected</li>
 <li><code>sublocality</code> &ndash; used in Asian addresses to demark a
 district within a city, if detected</li></ul>

ADDRESS = 10;

See Also:: Constant Field Values

DATE_VALUE

public static final int DATE_VALUE

 Date<br><br>
 The metadata identifies the components of the date:<ul>
 <li><code>year</code> &ndash; four digit year, if detected</li>
 <li><code>month</code> &ndash; two digit month number, if detected</li>
 <li><code>day</code> &ndash; two digit day number, if detected</li></ul>

DATE = 11;

See Also:: Constant Field Values

NUMBER_VALUE

public static final int NUMBER_VALUE

 Number<br><br>
 The metadata is the number itself.

NUMBER = 12;

See Also:: Constant Field Values

PRICE_VALUE

public static final int PRICE_VALUE

 Price<br><br>
 The metadata identifies the <code>value</code> and <code>currency</code>.

PRICE = 13;

See Also:: Constant Field Values

Method Detail
- values
```
public static Entity.Type[] values()
```
  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Entity.Type c : Entity.Type.values())
    System.out.println(c);
```
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static Entity.Type valueOf(String name)
```
  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
  
  Parameters:
  
  name - the name of the enum constant to be returned.
  
  Returns:
  
  the enum constant with the specified name
  
  Throws:
  
  IllegalArgumentException - if this enum type has no constant with the specified name
  
  NullPointerException - if the argument is null
- getNumber
```
public final int getNumber()
```
  Specified by:
  
  getNumber in interface com.google.protobuf.Internal.EnumLite
  
  Specified by:
  
  getNumber in interface com.google.protobuf.ProtocolMessageEnum
- valueOf
```
@Deprecated
public static Entity.Type valueOf(int value)
```
  Deprecated. Use forNumber(int) instead.
- forNumber
```
public static Entity.Type forNumber(int value)
```
- internalGetValueMap
```
public static com.google.protobuf.Internal.EnumLiteMap<Entity.Type> internalGetValueMap()
```
- getValueDescriptor
```
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
```
  Specified by:
  
  getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum
- getDescriptorForType
```
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
```
  Specified by:
  
  getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum
- getDescriptor
```
public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
```
- valueOf
```
public static Entity.Type valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
```

Enum Entity.Type

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

UNKNOWN

PERSON

LOCATION

ORGANIZATION

EVENT

WORK_OF_ART

CONSUMER_GOOD

OTHER

PHONE_NUMBER

ADDRESS

DATE

NUMBER

PRICE

UNRECOGNIZED

Field Detail

UNKNOWN_VALUE

PERSON_VALUE

LOCATION_VALUE

ORGANIZATION_VALUE

EVENT_VALUE

WORK_OF_ART_VALUE

CONSUMER_GOOD_VALUE

OTHER_VALUE

PHONE_NUMBER_VALUE

ADDRESS_VALUE

DATE_VALUE

NUMBER_VALUE

PRICE_VALUE

Method Detail

values

valueOf

getNumber

valueOf

forNumber

internalGetValueMap

getValueDescriptor

getDescriptorForType

getDescriptor

valueOf