RuntimeEntityInterpretation (ibm-watson 8.5.0 API)

java.lang.Object
- com.ibm.cloud.sdk.core.service.model.GenericModel
- - com.ibm.watson.assistant.v2.model.RuntimeEntityInterpretation

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel
```
public class RuntimeEntityInterpretation
extends com.ibm.cloud.sdk.core.service.model.GenericModel
```
RuntimeEntityInterpretation.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RuntimeEntityInterpretation.Builder` Builder.
`static interface`	`RuntimeEntityInterpretation.Granularity` The precision or duration of a time range specified by a recognized `@sys-time` or `@sys-date` entity.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`calendarType`
`protected java.lang.String`	`datetimeLink`
`protected java.lang.String`	`festival`
`protected java.lang.String`	`granularity`
`protected java.lang.Double`	`numericValue`
`protected java.lang.String`	`partOfDay`
`protected java.lang.String`	`rangeLink`
`protected java.lang.String`	`rangeModifier`
`protected java.lang.Double`	`relativeDay`
`protected java.lang.Double`	`relativeHour`
`protected java.lang.Double`	`relativeMinute`
`protected java.lang.Double`	`relativeMonth`
`protected java.lang.Double`	`relativeSecond`
`protected java.lang.Double`	`relativeWeek`
`protected java.lang.Double`	`relativeWeekend`
`protected java.lang.Double`	`relativeYear`
`protected java.lang.Double`	`specificDay`
`protected java.lang.String`	`specificDayOfWeek`
`protected java.lang.Double`	`specificHour`
`protected java.lang.Double`	`specificMinute`
`protected java.lang.Double`	`specificMonth`
`protected java.lang.Double`	`specificQuarter`
`protected java.lang.Double`	`specificSecond`
`protected java.lang.Double`	`specificYear`
`protected java.lang.String`	`subtype`
`protected java.lang.String`	`timezone`

Constructor Summary

Constructors
Modifier Constructor and Description

protected RuntimeEntityInterpretation(RuntimeEntityInterpretation.Builder builder)

Constructors
Modifier	Constructor and Description
`protected`	`RuntimeEntityInterpretation(RuntimeEntityInterpretation.Builder builder)`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`calendarType()` Gets the calendarType.
`java.lang.String`	`datetimeLink()` Gets the datetimeLink.
`java.lang.String`	`festival()` Gets the festival.
`java.lang.String`	`granularity()` Gets the granularity.
`RuntimeEntityInterpretation.Builder`	`newBuilder()` New builder.
`java.lang.Double`	`numericValue()` Gets the numericValue.
`java.lang.String`	`partOfDay()` Gets the partOfDay.
`java.lang.String`	`rangeLink()` Gets the rangeLink.
`java.lang.String`	`rangeModifier()` Gets the rangeModifier.
`java.lang.Double`	`relativeDay()` Gets the relativeDay.
`java.lang.Double`	`relativeHour()` Gets the relativeHour.
`java.lang.Double`	`relativeMinute()` Gets the relativeMinute.
`java.lang.Double`	`relativeMonth()` Gets the relativeMonth.
`java.lang.Double`	`relativeSecond()` Gets the relativeSecond.
`java.lang.Double`	`relativeWeek()` Gets the relativeWeek.
`java.lang.Double`	`relativeWeekend()` Gets the relativeWeekend.
`java.lang.Double`	`relativeYear()` Gets the relativeYear.
`java.lang.Double`	`specificDay()` Gets the specificDay.
`java.lang.String`	`specificDayOfWeek()` Gets the specificDayOfWeek.
`java.lang.Double`	`specificHour()` Gets the specificHour.
`java.lang.Double`	`specificMinute()` Gets the specificMinute.
`java.lang.Double`	`specificMonth()` Gets the specificMonth.
`java.lang.Double`	`specificQuarter()` Gets the specificQuarter.
`java.lang.Double`	`specificSecond()` Gets the specificSecond.
`java.lang.Double`	`specificYear()` Gets the specificYear.
`java.lang.String`	`subtype()` Gets the subtype.
`java.lang.String`	`timezone()` Gets the timezone.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel
equals, hashCode, toString

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

- Field Detail
  - calendarType
```
@SerializedName(value="calendar_type")
protected java.lang.String calendarType
```
  - datetimeLink
```
@SerializedName(value="datetime_link")
protected java.lang.String datetimeLink
```
  - festival
```
protected java.lang.String festival
```
  - granularity
```
protected java.lang.String granularity
```
  - rangeLink
```
@SerializedName(value="range_link")
protected java.lang.String rangeLink
```
  - rangeModifier
```
@SerializedName(value="range_modifier")
protected java.lang.String rangeModifier
```
  - relativeDay
```
@SerializedName(value="relative_day")
protected java.lang.Double relativeDay
```
  - relativeMonth
```
@SerializedName(value="relative_month")
protected java.lang.Double relativeMonth
```
  - relativeWeek
```
@SerializedName(value="relative_week")
protected java.lang.Double relativeWeek
```
  - relativeWeekend
```
@SerializedName(value="relative_weekend")
protected java.lang.Double relativeWeekend
```
  - relativeYear
```
@SerializedName(value="relative_year")
protected java.lang.Double relativeYear
```
  - specificDay
```
@SerializedName(value="specific_day")
protected java.lang.Double specificDay
```
  - specificDayOfWeek
```
@SerializedName(value="specific_day_of_week")
protected java.lang.String specificDayOfWeek
```
  - specificMonth
```
@SerializedName(value="specific_month")
protected java.lang.Double specificMonth
```
  - specificQuarter
```
@SerializedName(value="specific_quarter")
protected java.lang.Double specificQuarter
```
  - specificYear
```
@SerializedName(value="specific_year")
protected java.lang.Double specificYear
```
  - numericValue
```
@SerializedName(value="numeric_value")
protected java.lang.Double numericValue
```
  - subtype
```
protected java.lang.String subtype
```
  - partOfDay
```
@SerializedName(value="part_of_day")
protected java.lang.String partOfDay
```
  - relativeHour
```
@SerializedName(value="relative_hour")
protected java.lang.Double relativeHour
```
  - relativeMinute
```
@SerializedName(value="relative_minute")
protected java.lang.Double relativeMinute
```
  - relativeSecond
```
@SerializedName(value="relative_second")
protected java.lang.Double relativeSecond
```
  - specificHour
```
@SerializedName(value="specific_hour")
protected java.lang.Double specificHour
```
  - specificMinute
```
@SerializedName(value="specific_minute")
protected java.lang.Double specificMinute
```
  - specificSecond
```
@SerializedName(value="specific_second")
protected java.lang.Double specificSecond
```
  - timezone
```
protected java.lang.String timezone
```
- Constructor Detail
  - RuntimeEntityInterpretation
```
protected RuntimeEntityInterpretation(RuntimeEntityInterpretation.Builder builder)
```
- Method Detail
  - newBuilder
```
public RuntimeEntityInterpretation.Builder newBuilder()
```
    New builder.
    
    Returns:
    a RuntimeEntityInterpretation builder
  - calendarType
```
public java.lang.String calendarType()
```
    Gets the calendarType.
    The calendar used to represent a recognized date (for example, `Gregorian`).
    
    Returns:
    the calendarType
  - datetimeLink
```
public java.lang.String datetimeLink()
```
    Gets the datetimeLink.
    A unique identifier used to associate a recognized time and date. If the user input contains a date and time that are mentioned together (for example, `Today at 5`, the same **datetime_link** value is returned for both the `@sys-date` and `@sys-time` entities).
    
    Returns:
    the datetimeLink
  - festival
```
public java.lang.String festival()
```
    Gets the festival.
    A locale-specific holiday name (such as `thanksgiving` or `christmas`). This property is included when a `@sys-date` entity is recognized based on a holiday name in the user input.
    
    Returns:
    the festival
  - granularity
```
public java.lang.String granularity()
```
    Gets the granularity.
    The precision or duration of a time range specified by a recognized `@sys-time` or `@sys-date` entity.
    
    Returns:
    the granularity
  - rangeLink
```
public java.lang.String rangeLink()
```
    Gets the rangeLink.
    A unique identifier used to associate multiple recognized `@sys-date`, `@sys-time`, or `@sys-number` entities that are recognized as a range of values in the user's input (for example, `from July 4 until July 14` or `from 20 to 25`).
    
    Returns:
    the rangeLink
  - rangeModifier
```
public java.lang.String rangeModifier()
```
    Gets the rangeModifier.
    The word in the user input that indicates that a `sys-date` or `sys-time` entity is part of an implied range where only one date or time is specified (for example, `since` or `until`).
    
    Returns:
    the rangeModifier
  - relativeDay
```
public java.lang.Double relativeDay()
```
    Gets the relativeDay.
    A recognized mention of a relative day, represented numerically as an offset from the current date (for example, `-1` for `yesterday` or `10` for `in ten days`).
    
    Returns:
    the relativeDay
  - relativeMonth
```
public java.lang.Double relativeMonth()
```
    Gets the relativeMonth.
    A recognized mention of a relative month, represented numerically as an offset from the current month (for example, `1` for `next month` or `-3` for `three months ago`).
    
    Returns:
    the relativeMonth
  - relativeWeek
```
public java.lang.Double relativeWeek()
```
    Gets the relativeWeek.
    A recognized mention of a relative week, represented numerically as an offset from the current week (for example, `2` for `in two weeks` or `-1` for `last week).
    
    Returns:
    the relativeWeek
  - relativeWeekend
```
public java.lang.Double relativeWeekend()
```
    Gets the relativeWeekend.
    A recognized mention of a relative date range for a weekend, represented numerically as an offset from the current weekend (for example, `0` for `this weekend` or `-1` for `last weekend`).
    
    Returns:
    the relativeWeekend
  - relativeYear
```
public java.lang.Double relativeYear()
```
    Gets the relativeYear.
    A recognized mention of a relative year, represented numerically as an offset from the current year (for example, `1` for `next year` or `-5` for `five years ago`).
    
    Returns:
    the relativeYear
  - specificDay
```
public java.lang.Double specificDay()
```
    Gets the specificDay.
    A recognized mention of a specific date, represented numerically as the date within the month (for example, `30` for `June 30`.).
    
    Returns:
    the specificDay
  - specificDayOfWeek
```
public java.lang.String specificDayOfWeek()
```
    Gets the specificDayOfWeek.
    A recognized mention of a specific day of the week as a lowercase string (for example, `monday`).
    
    Returns:
    the specificDayOfWeek
  - specificMonth
```
public java.lang.Double specificMonth()
```
    Gets the specificMonth.
    A recognized mention of a specific month, represented numerically (for example, `7` for `July`).
    
    Returns:
    the specificMonth
  - specificQuarter
```
public java.lang.Double specificQuarter()
```
    Gets the specificQuarter.
    A recognized mention of a specific quarter, represented numerically (for example, `3` for `the third quarter`).
    
    Returns:
    the specificQuarter
  - specificYear
```
public java.lang.Double specificYear()
```
    Gets the specificYear.
    A recognized mention of a specific year (for example, `2016`).
    
    Returns:
    the specificYear
  - numericValue
```
public java.lang.Double numericValue()
```
    Gets the numericValue.
    A recognized numeric value, represented as an integer or double.
    
    Returns:
    the numericValue
  - subtype
```
public java.lang.String subtype()
```
    Gets the subtype.
    The type of numeric value recognized in the user input (`integer` or `rational`).
    
    Returns:
    the subtype
  - partOfDay
```
public java.lang.String partOfDay()
```
    Gets the partOfDay.
    A recognized term for a time that was mentioned as a part of the day in the user's input (for example, `morning` or `afternoon`).
    
    Returns:
    the partOfDay
  - relativeHour
```
public java.lang.Double relativeHour()
```
    Gets the relativeHour.
    A recognized mention of a relative hour, represented numerically as an offset from the current hour (for example, `3` for `in three hours` or `-1` for `an hour ago`).
    
    Returns:
    the relativeHour
  - relativeMinute
```
public java.lang.Double relativeMinute()
```
    Gets the relativeMinute.
    A recognized mention of a relative time, represented numerically as an offset in minutes from the current time (for example, `5` for `in five minutes` or `-15` for `fifteen minutes ago`).
    
    Returns:
    the relativeMinute
  - relativeSecond
```
public java.lang.Double relativeSecond()
```
    Gets the relativeSecond.
    A recognized mention of a relative time, represented numerically as an offset in seconds from the current time (for example, `10` for `in ten seconds` or `-30` for `thirty seconds ago`).
    
    Returns:
    the relativeSecond
  - specificHour
```
public java.lang.Double specificHour()
```
    Gets the specificHour.
    A recognized specific hour mentioned as part of a time value (for example, `10` for `10:15 AM`.).
    
    Returns:
    the specificHour
  - specificMinute
```
public java.lang.Double specificMinute()
```
    Gets the specificMinute.
    A recognized specific minute mentioned as part of a time value (for example, `15` for `10:15 AM`.).
    
    Returns:
    the specificMinute
  - specificSecond
```
public java.lang.Double specificSecond()
```
    Gets the specificSecond.
    A recognized specific second mentioned as part of a time value (for example, `30` for `10:15:30 AM`.).
    
    Returns:
    the specificSecond
  - timezone
```
public java.lang.String timezone()
```
    Gets the timezone.
    A recognized time zone mentioned as part of a time value (for example, `EST`).
    
    Returns:
    the timezone

Class RuntimeEntityInterpretation

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

Methods inherited from class java.lang.Object

Field Detail

calendarType

datetimeLink

festival

granularity

rangeLink

rangeModifier

relativeDay

relativeMonth

relativeWeek

relativeWeekend

relativeYear

specificDay

specificDayOfWeek

specificMonth

specificQuarter

specificYear

numericValue

subtype

partOfDay

relativeHour

relativeMinute

relativeSecond

specificHour

specificMinute

specificSecond

timezone

Constructor Detail

RuntimeEntityInterpretation

Method Detail

newBuilder

calendarType

datetimeLink

festival

granularity

rangeLink

rangeModifier

relativeDay

relativeMonth

relativeWeek

relativeWeekend

relativeYear

specificDay

specificDayOfWeek

specificMonth

specificQuarter

specificYear

numericValue

subtype

partOfDay

relativeHour

relativeMinute

relativeSecond

specificHour

specificMinute

specificSecond

timezone