Packages

final class Feature extends GeneratedMessageV3 with FeatureOrBuilder

Describes schema-level information about a specific feature.
NextID: 36

Protobuf type tensorflow.metadata.v0.Feature

Source
Feature.java
Linear Supertypes
FeatureOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Feature
  2. FeatureOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. def equals(obj: AnyRef): Boolean
    Definition Classes
    Feature → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  2. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  3. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  4. def getAnnotation(): Annotation

    Additional information about the feature for documentation purpose.


    Additional information about the feature for documentation purpose.

    optional .tensorflow.metadata.v0.Annotation annotation = 16;

    returns

    The annotation.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  5. def getAnnotationOrBuilder(): AnnotationOrBuilder

    Additional information about the feature for documentation purpose.


    Additional information about the feature for documentation purpose.

    optional .tensorflow.metadata.v0.Annotation annotation = 16;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  6. def getBoolDomain(): BoolDomain

    .tensorflow.metadata.v0.BoolDomain bool_domain = 13;

    .tensorflow.metadata.v0.BoolDomain bool_domain = 13;

    returns

    The boolDomain.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  7. def getBoolDomainOrBuilder(): BoolDomainOrBuilder

    .tensorflow.metadata.v0.BoolDomain bool_domain = 13;

    .tensorflow.metadata.v0.BoolDomain bool_domain = 13;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  8. def getDefaultInstanceForType(): Feature
    Definition Classes
    Feature → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  9. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  10. def getDistributionConstraints(): DistributionConstraints

    Constraints on the distribution of the feature values.
Only supported for StringDomains.


    Constraints on the distribution of the feature values.
Only supported for StringDomains.

    optional .tensorflow.metadata.v0.DistributionConstraints distribution_constraints = 15;

    returns

    The distributionConstraints.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  11. def getDistributionConstraintsOrBuilder(): DistributionConstraintsOrBuilder

    Constraints on the distribution of the feature values.
Only supported for StringDomains.


    Constraints on the distribution of the feature values.
Only supported for StringDomains.

    optional .tensorflow.metadata.v0.DistributionConstraints distribution_constraints = 15;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  12. def getDomain(): String

    Reference to a domain defined at the schema level.
NOTE THAT TFDV ONLY SUPPORTS STRING DOMAINS AT THE TOP LEVEL.
TODO(b/63664182): Support this.


    Reference to a domain defined at the schema level.
NOTE THAT TFDV ONLY SUPPORTS STRING DOMAINS AT THE TOP LEVEL.
TODO(b/63664182): Support this.

    string domain = 7;

    returns

    The domain.

    Definition Classes
    Feature → FeatureOrBuilder
  13. def getDomainBytes(): ByteString

    Reference to a domain defined at the schema level.
NOTE THAT TFDV ONLY SUPPORTS STRING DOMAINS AT THE TOP LEVEL.
TODO(b/63664182): Support this.


    Reference to a domain defined at the schema level.
NOTE THAT TFDV ONLY SUPPORTS STRING DOMAINS AT THE TOP LEVEL.
TODO(b/63664182): Support this.

    string domain = 7;

    returns

    The bytes for domain.

    Definition Classes
    Feature → FeatureOrBuilder
  14. def getDomainInfoCase(): DomainInfoCase
    Definition Classes
    Feature → FeatureOrBuilder
  15. def getDriftComparator(): FeatureComparator

    Tests comparing the distribution between two consecutive spans (e.g. days).


    Tests comparing the distribution between two consecutive spans (e.g. days).

    optional .tensorflow.metadata.v0.FeatureComparator drift_comparator = 21;

    returns

    The driftComparator.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  16. def getDriftComparatorOrBuilder(): FeatureComparatorOrBuilder

    Tests comparing the distribution between two consecutive spans (e.g. days).


    Tests comparing the distribution between two consecutive spans (e.g. days).

    optional .tensorflow.metadata.v0.FeatureComparator drift_comparator = 21;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  17. def getField(field: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  18. def getFloatDomain(): FloatDomain

    .tensorflow.metadata.v0.FloatDomain float_domain = 10;

    .tensorflow.metadata.v0.FloatDomain float_domain = 10;

    returns

    The floatDomain.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  19. def getFloatDomainOrBuilder(): FloatDomainOrBuilder

    .tensorflow.metadata.v0.FloatDomain float_domain = 10;

    .tensorflow.metadata.v0.FloatDomain float_domain = 10;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  20. def getGroupPresence(): FeaturePresenceWithinGroup

    Only used in the context of a "group" context, e.g., inside a sequence.


    Only used in the context of a "group" context, e.g., inside a sequence.

    .tensorflow.metadata.v0.FeaturePresenceWithinGroup group_presence = 17;

    returns

    The groupPresence.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  21. def getGroupPresenceOrBuilder(): FeaturePresenceWithinGroupOrBuilder

    Only used in the context of a "group" context, e.g., inside a sequence.


    Only used in the context of a "group" context, e.g., inside a sequence.

    .tensorflow.metadata.v0.FeaturePresenceWithinGroup group_presence = 17;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  22. def getImageDomain(): ImageDomain

    .tensorflow.metadata.v0.ImageDomain image_domain = 25;

    .tensorflow.metadata.v0.ImageDomain image_domain = 25;

    returns

    The imageDomain.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  23. def getImageDomainOrBuilder(): ImageDomainOrBuilder

    .tensorflow.metadata.v0.ImageDomain image_domain = 25;

    .tensorflow.metadata.v0.ImageDomain image_domain = 25;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  24. def getInEnvironment(index: Int): String

    List of environments this feature is present in.
Should be disjoint from not_in_environment.
This feature is in environment "foo" if:
("foo" is in in_environment or default_environment) AND
"foo" is not in not_in_environment.
See Schema::default_environment.


    List of environments this feature is present in.
Should be disjoint from not_in_environment.
This feature is in environment "foo" if:
("foo" is in in_environment or default_environment) AND
"foo" is not in not_in_environment.
See Schema::default_environment.

    repeated string in_environment = 20;

    index

    The index of the element to return.

    returns

    The inEnvironment at the given index.

    Definition Classes
    Feature → FeatureOrBuilder
  25. def getInEnvironmentBytes(index: Int): ByteString

    List of environments this feature is present in.
Should be disjoint from not_in_environment.
This feature is in environment "foo" if:
("foo" is in in_environment or default_environment) AND
"foo" is not in not_in_environment.
See Schema::default_environment.


    List of environments this feature is present in.
Should be disjoint from not_in_environment.
This feature is in environment "foo" if:
("foo" is in in_environment or default_environment) AND
"foo" is not in not_in_environment.
See Schema::default_environment.

    repeated string in_environment = 20;

    index

    The index of the value to return.

    returns

    The bytes of the inEnvironment at the given index.

    Definition Classes
    Feature → FeatureOrBuilder
  26. def getInEnvironmentCount(): Int

    List of environments this feature is present in.
Should be disjoint from not_in_environment.
This feature is in environment "foo" if:
("foo" is in in_environment or default_environment) AND
"foo" is not in not_in_environment.
See Schema::default_environment.


    List of environments this feature is present in.
Should be disjoint from not_in_environment.
This feature is in environment "foo" if:
("foo" is in in_environment or default_environment) AND
"foo" is not in not_in_environment.
See Schema::default_environment.

    repeated string in_environment = 20;

    returns

    The count of inEnvironment.

    Definition Classes
    Feature → FeatureOrBuilder
  27. def getInEnvironmentList(): ProtocolStringList

    List of environments this feature is present in.
Should be disjoint from not_in_environment.
This feature is in environment "foo" if:
("foo" is in in_environment or default_environment) AND
"foo" is not in not_in_environment.
See Schema::default_environment.


    List of environments this feature is present in.
Should be disjoint from not_in_environment.
This feature is in environment "foo" if:
("foo" is in in_environment or default_environment) AND
"foo" is not in not_in_environment.
See Schema::default_environment.

    repeated string in_environment = 20;

    returns

    A list containing the inEnvironment.

    Definition Classes
    Feature → FeatureOrBuilder
  28. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  29. def getIntDomain(): IntDomain

    Inline definitions of domains.


    Inline definitions of domains.

    .tensorflow.metadata.v0.IntDomain int_domain = 9;

    returns

    The intDomain.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  30. def getIntDomainOrBuilder(): IntDomainOrBuilder

    Inline definitions of domains.


    Inline definitions of domains.

    .tensorflow.metadata.v0.IntDomain int_domain = 9;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  31. def getLifecycleStage(): LifecycleStage

    The lifecycle stage of a feature. It can also apply to its descendants.
i.e., if a struct is DEPRECATED, its children are implicitly deprecated.


    The lifecycle stage of a feature. It can also apply to its descendants.
i.e., if a struct is DEPRECATED, its children are implicitly deprecated.

    optional .tensorflow.metadata.v0.LifecycleStage lifecycle_stage = 22;

    returns

    The lifecycleStage.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  32. def getMidDomain(): MIDDomain

    .tensorflow.metadata.v0.MIDDomain mid_domain = 26;

    .tensorflow.metadata.v0.MIDDomain mid_domain = 26;

    returns

    The midDomain.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  33. def getMidDomainOrBuilder(): MIDDomainOrBuilder

    .tensorflow.metadata.v0.MIDDomain mid_domain = 26;

    .tensorflow.metadata.v0.MIDDomain mid_domain = 26;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  34. def getName(): String

    The name of the feature.


    The name of the feature.

    optional string name = 1;

    returns

    The name.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  35. def getNameBytes(): ByteString

    The name of the feature.


    The name of the feature.

    optional string name = 1;

    returns

    The bytes for name.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  36. def getNaturalLanguageDomain(): NaturalLanguageDomain

    Supported semantic domains.


    Supported semantic domains.

    .tensorflow.metadata.v0.NaturalLanguageDomain natural_language_domain = 24;

    returns

    The naturalLanguageDomain.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  37. def getNaturalLanguageDomainOrBuilder(): NaturalLanguageDomainOrBuilder

    Supported semantic domains.


    Supported semantic domains.

    .tensorflow.metadata.v0.NaturalLanguageDomain natural_language_domain = 24;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  38. def getNotInEnvironment(index: Int): String

    List of environments this feature is not present in.
Should be disjoint from of in_environment.
See Schema::default_environment and in_environment.


    List of environments this feature is not present in.
Should be disjoint from of in_environment.
See Schema::default_environment and in_environment.

    repeated string not_in_environment = 19;

    index

    The index of the element to return.

    returns

    The notInEnvironment at the given index.

    Definition Classes
    Feature → FeatureOrBuilder
  39. def getNotInEnvironmentBytes(index: Int): ByteString

    List of environments this feature is not present in.
Should be disjoint from of in_environment.
See Schema::default_environment and in_environment.


    List of environments this feature is not present in.
Should be disjoint from of in_environment.
See Schema::default_environment and in_environment.

    repeated string not_in_environment = 19;

    index

    The index of the value to return.

    returns

    The bytes of the notInEnvironment at the given index.

    Definition Classes
    Feature → FeatureOrBuilder
  40. def getNotInEnvironmentCount(): Int

    List of environments this feature is not present in.
Should be disjoint from of in_environment.
See Schema::default_environment and in_environment.


    List of environments this feature is not present in.
Should be disjoint from of in_environment.
See Schema::default_environment and in_environment.

    repeated string not_in_environment = 19;

    returns

    The count of notInEnvironment.

    Definition Classes
    Feature → FeatureOrBuilder
  41. def getNotInEnvironmentList(): ProtocolStringList

    List of environments this feature is not present in.
Should be disjoint from of in_environment.
See Schema::default_environment and in_environment.


    List of environments this feature is not present in.
Should be disjoint from of in_environment.
See Schema::default_environment and in_environment.

    repeated string not_in_environment = 19;

    returns

    A list containing the notInEnvironment.

    Definition Classes
    Feature → FeatureOrBuilder
  42. def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  43. def getParserForType(): Parser[Feature]
    Definition Classes
    Feature → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  44. def getPresence(): FeaturePresence

    Constraints on the presence of this feature in the examples.


    Constraints on the presence of this feature in the examples.

    .tensorflow.metadata.v0.FeaturePresence presence = 14;

    returns

    The presence.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  45. def getPresenceConstraintsCase(): PresenceConstraintsCase
    Definition Classes
    Feature → FeatureOrBuilder
  46. def getPresenceOrBuilder(): FeaturePresenceOrBuilder

    Constraints on the presence of this feature in the examples.


    Constraints on the presence of this feature in the examples.

    .tensorflow.metadata.v0.FeaturePresence presence = 14;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  47. def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  48. def getRepeatedFieldCount(field: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  49. def getSequenceMetadata(): SequenceMetadata

    This field specifies if this feature could be treated as a sequence
feature which has meaningful element order.


    This field specifies if this feature could be treated as a sequence
feature which has meaningful element order.

    optional .tensorflow.metadata.v0.SequenceMetadata sequence_metadata = 35;

    returns

    The sequenceMetadata.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  50. def getSequenceMetadataOrBuilder(): SequenceMetadataOrBuilder

    This field specifies if this feature could be treated as a sequence
feature which has meaningful element order.


    This field specifies if this feature could be treated as a sequence
feature which has meaningful element order.

    optional .tensorflow.metadata.v0.SequenceMetadata sequence_metadata = 35;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  51. def getSerializedSize(): Int
    Definition Classes
    Feature → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  52. def getShape(): FixedShape

    The feature has a fixed shape corresponding to a multi-dimensional
tensor.


    The feature has a fixed shape corresponding to a multi-dimensional
tensor.

    .tensorflow.metadata.v0.FixedShape shape = 23;

    returns

    The shape.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  53. def getShapeOrBuilder(): FixedShapeOrBuilder

    The feature has a fixed shape corresponding to a multi-dimensional
tensor.


    The feature has a fixed shape corresponding to a multi-dimensional
tensor.

    .tensorflow.metadata.v0.FixedShape shape = 23;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  54. def getShapeTypeCase(): ShapeTypeCase
    Definition Classes
    Feature → FeatureOrBuilder
  55. def getSkewComparator(): FeatureComparator

    Tests comparing the distribution to the associated serving data.


    Tests comparing the distribution to the associated serving data.

    optional .tensorflow.metadata.v0.FeatureComparator skew_comparator = 18;

    returns

    The skewComparator.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  56. def getSkewComparatorOrBuilder(): FeatureComparatorOrBuilder

    Tests comparing the distribution to the associated serving data.


    Tests comparing the distribution to the associated serving data.

    optional .tensorflow.metadata.v0.FeatureComparator skew_comparator = 18;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  57. def getStringDomain(): StringDomain

    .tensorflow.metadata.v0.StringDomain string_domain = 11;

    .tensorflow.metadata.v0.StringDomain string_domain = 11;

    returns

    The stringDomain.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  58. def getStringDomainOrBuilder(): StringDomainOrBuilder

    .tensorflow.metadata.v0.StringDomain string_domain = 11;

    .tensorflow.metadata.v0.StringDomain string_domain = 11;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  59. def getStructDomain(): StructDomain

    .tensorflow.metadata.v0.StructDomain struct_domain = 29;

    .tensorflow.metadata.v0.StructDomain struct_domain = 29;

    returns

    The structDomain.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  60. def getStructDomainOrBuilder(): StructDomainOrBuilder

    .tensorflow.metadata.v0.StructDomain struct_domain = 29;

    .tensorflow.metadata.v0.StructDomain struct_domain = 29;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  61. def getTimeDomain(): TimeDomain

    .tensorflow.metadata.v0.TimeDomain time_domain = 28;

    .tensorflow.metadata.v0.TimeDomain time_domain = 28;

    returns

    The timeDomain.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  62. def getTimeDomainOrBuilder(): TimeDomainOrBuilder

    .tensorflow.metadata.v0.TimeDomain time_domain = 28;

    .tensorflow.metadata.v0.TimeDomain time_domain = 28;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  63. def getTimeOfDayDomain(): TimeOfDayDomain

    .tensorflow.metadata.v0.TimeOfDayDomain time_of_day_domain = 30;

    .tensorflow.metadata.v0.TimeOfDayDomain time_of_day_domain = 30;

    returns

    The timeOfDayDomain.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  64. def getTimeOfDayDomainOrBuilder(): TimeOfDayDomainOrBuilder

    .tensorflow.metadata.v0.TimeOfDayDomain time_of_day_domain = 30;

    .tensorflow.metadata.v0.TimeOfDayDomain time_of_day_domain = 30;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  65. def getType(): FeatureType

    Physical type of the feature's values.
Note that you can have:
type: BYTES
int_domain: {
  min: 0
  max: 3
}
This would be a field that is syntactically BYTES (i.e. strings), but
semantically an int, i.e. it would be "0", "1", "2", or "3".


    Physical type of the feature's values.
Note that you can have:
type: BYTES
int_domain: {
  min: 0
  max: 3
}
This would be a field that is syntactically BYTES (i.e. strings), but
semantically an int, i.e. it would be "0", "1", "2", or "3".

    optional .tensorflow.metadata.v0.FeatureType type = 6;

    returns

    The type.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  66. def getUniqueConstraints(): UniqueConstraints

    Constraints on the number of unique values for a given feature.
This is supported for string and categorical features only.


    Constraints on the number of unique values for a given feature.
This is supported for string and categorical features only.

    optional .tensorflow.metadata.v0.UniqueConstraints unique_constraints = 31;

    returns

    The uniqueConstraints.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  67. def getUniqueConstraintsOrBuilder(): UniqueConstraintsOrBuilder

    Constraints on the number of unique values for a given feature.
This is supported for string and categorical features only.


    Constraints on the number of unique values for a given feature.
This is supported for string and categorical features only.

    optional .tensorflow.metadata.v0.UniqueConstraints unique_constraints = 31;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  68. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  69. def getUrlDomain(): URLDomain

    .tensorflow.metadata.v0.URLDomain url_domain = 27;

    .tensorflow.metadata.v0.URLDomain url_domain = 27;

    returns

    The urlDomain.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  70. def getUrlDomainOrBuilder(): URLDomainOrBuilder

    .tensorflow.metadata.v0.URLDomain url_domain = 27;

    .tensorflow.metadata.v0.URLDomain url_domain = 27;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  71. def getValidationDerivedSource(): DerivedFeatureSource

    If set, indicates that that this feature is derived, and stores metadata
about its source. If this field is set, this feature should have a
disabled stage (PLANNED, ALPHA, DEPRECATED, DISABLED, DEBUG_ONLY), or
lifecycle_stage VALIDATION_DERIVED.
Experimental and subject to change.


    If set, indicates that that this feature is derived, and stores metadata
about its source. If this field is set, this feature should have a
disabled stage (PLANNED, ALPHA, DEPRECATED, DISABLED, DEBUG_ONLY), or
lifecycle_stage VALIDATION_DERIVED.
Experimental and subject to change.

    optional .tensorflow.metadata.v0.DerivedFeatureSource validation_derived_source = 34;

    returns

    The validationDerivedSource.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  72. def getValidationDerivedSourceOrBuilder(): DerivedFeatureSourceOrBuilder

    If set, indicates that that this feature is derived, and stores metadata
about its source. If this field is set, this feature should have a
disabled stage (PLANNED, ALPHA, DEPRECATED, DISABLED, DEBUG_ONLY), or
lifecycle_stage VALIDATION_DERIVED.
Experimental and subject to change.


    If set, indicates that that this feature is derived, and stores metadata
about its source. If this field is set, this feature should have a
disabled stage (PLANNED, ALPHA, DEPRECATED, DISABLED, DEBUG_ONLY), or
lifecycle_stage VALIDATION_DERIVED.
Experimental and subject to change.

    optional .tensorflow.metadata.v0.DerivedFeatureSource validation_derived_source = 34;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  73. def getValueCount(): ValueCount

    The feature doesn't have a well defined shape. All we know are limits on
the minimum and maximum number of values.


    The feature doesn't have a well defined shape. All we know are limits on
the minimum and maximum number of values.

    .tensorflow.metadata.v0.ValueCount value_count = 5;

    returns

    The valueCount.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  74. def getValueCountOrBuilder(): ValueCountOrBuilder

    The feature doesn't have a well defined shape. All we know are limits on
the minimum and maximum number of values.


    The feature doesn't have a well defined shape. All we know are limits on
the minimum and maximum number of values.

    .tensorflow.metadata.v0.ValueCount value_count = 5;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  75. def getValueCounts(): ValueCountList

    Captures the same information as value_count but for features with
nested values. A ValueCount is provided for each nest level.


    Captures the same information as value_count but for features with
nested values. A ValueCount is provided for each nest level.

    .tensorflow.metadata.v0.ValueCountList value_counts = 32;

    returns

    The valueCounts.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  76. def getValueCountsOrBuilder(): ValueCountListOrBuilder

    Captures the same information as value_count but for features with
nested values. A ValueCount is provided for each nest level.


    Captures the same information as value_count but for features with
nested values. A ValueCount is provided for each nest level.

    .tensorflow.metadata.v0.ValueCountList value_counts = 32;

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  77. def hasAnnotation(): Boolean

    Additional information about the feature for documentation purpose.


    Additional information about the feature for documentation purpose.

    optional .tensorflow.metadata.v0.Annotation annotation = 16;

    returns

    Whether the annotation field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  78. def hasBoolDomain(): Boolean

    .tensorflow.metadata.v0.BoolDomain bool_domain = 13;

    .tensorflow.metadata.v0.BoolDomain bool_domain = 13;

    returns

    Whether the boolDomain field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  79. def hasDistributionConstraints(): Boolean

    Constraints on the distribution of the feature values.
Only supported for StringDomains.


    Constraints on the distribution of the feature values.
Only supported for StringDomains.

    optional .tensorflow.metadata.v0.DistributionConstraints distribution_constraints = 15;

    returns

    Whether the distributionConstraints field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  80. def hasDomain(): Boolean

    Reference to a domain defined at the schema level.
NOTE THAT TFDV ONLY SUPPORTS STRING DOMAINS AT THE TOP LEVEL.
TODO(b/63664182): Support this.


    Reference to a domain defined at the schema level.
NOTE THAT TFDV ONLY SUPPORTS STRING DOMAINS AT THE TOP LEVEL.
TODO(b/63664182): Support this.

    string domain = 7;

    returns

    Whether the domain field is set.

    Definition Classes
    Feature → FeatureOrBuilder
  81. def hasDriftComparator(): Boolean

    Tests comparing the distribution between two consecutive spans (e.g. days).


    Tests comparing the distribution between two consecutive spans (e.g. days).

    optional .tensorflow.metadata.v0.FeatureComparator drift_comparator = 21;

    returns

    Whether the driftComparator field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  82. def hasField(field: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  83. def hasFloatDomain(): Boolean

    .tensorflow.metadata.v0.FloatDomain float_domain = 10;

    .tensorflow.metadata.v0.FloatDomain float_domain = 10;

    returns

    Whether the floatDomain field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  84. def hasGroupPresence(): Boolean

    Only used in the context of a "group" context, e.g., inside a sequence.


    Only used in the context of a "group" context, e.g., inside a sequence.

    .tensorflow.metadata.v0.FeaturePresenceWithinGroup group_presence = 17;

    returns

    Whether the groupPresence field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  85. def hasImageDomain(): Boolean

    .tensorflow.metadata.v0.ImageDomain image_domain = 25;

    .tensorflow.metadata.v0.ImageDomain image_domain = 25;

    returns

    Whether the imageDomain field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  86. def hasIntDomain(): Boolean

    Inline definitions of domains.


    Inline definitions of domains.

    .tensorflow.metadata.v0.IntDomain int_domain = 9;

    returns

    Whether the intDomain field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  87. def hasLifecycleStage(): Boolean

    The lifecycle stage of a feature. It can also apply to its descendants.
i.e., if a struct is DEPRECATED, its children are implicitly deprecated.


    The lifecycle stage of a feature. It can also apply to its descendants.
i.e., if a struct is DEPRECATED, its children are implicitly deprecated.

    optional .tensorflow.metadata.v0.LifecycleStage lifecycle_stage = 22;

    returns

    Whether the lifecycleStage field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  88. def hasMidDomain(): Boolean

    .tensorflow.metadata.v0.MIDDomain mid_domain = 26;

    .tensorflow.metadata.v0.MIDDomain mid_domain = 26;

    returns

    Whether the midDomain field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  89. def hasName(): Boolean

    The name of the feature.


    The name of the feature.

    optional string name = 1;

    returns

    Whether the name field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  90. def hasNaturalLanguageDomain(): Boolean

    Supported semantic domains.


    Supported semantic domains.

    .tensorflow.metadata.v0.NaturalLanguageDomain natural_language_domain = 24;

    returns

    Whether the naturalLanguageDomain field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  91. def hasOneof(oneof: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  92. def hasPresence(): Boolean

    Constraints on the presence of this feature in the examples.


    Constraints on the presence of this feature in the examples.

    .tensorflow.metadata.v0.FeaturePresence presence = 14;

    returns

    Whether the presence field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  93. def hasSequenceMetadata(): Boolean

    This field specifies if this feature could be treated as a sequence
feature which has meaningful element order.


    This field specifies if this feature could be treated as a sequence
feature which has meaningful element order.

    optional .tensorflow.metadata.v0.SequenceMetadata sequence_metadata = 35;

    returns

    Whether the sequenceMetadata field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  94. def hasShape(): Boolean

    The feature has a fixed shape corresponding to a multi-dimensional
tensor.


    The feature has a fixed shape corresponding to a multi-dimensional
tensor.

    .tensorflow.metadata.v0.FixedShape shape = 23;

    returns

    Whether the shape field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  95. def hasSkewComparator(): Boolean

    Tests comparing the distribution to the associated serving data.


    Tests comparing the distribution to the associated serving data.

    optional .tensorflow.metadata.v0.FeatureComparator skew_comparator = 18;

    returns

    Whether the skewComparator field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  96. def hasStringDomain(): Boolean

    .tensorflow.metadata.v0.StringDomain string_domain = 11;

    .tensorflow.metadata.v0.StringDomain string_domain = 11;

    returns

    Whether the stringDomain field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  97. def hasStructDomain(): Boolean

    .tensorflow.metadata.v0.StructDomain struct_domain = 29;

    .tensorflow.metadata.v0.StructDomain struct_domain = 29;

    returns

    Whether the structDomain field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  98. def hasTimeDomain(): Boolean

    .tensorflow.metadata.v0.TimeDomain time_domain = 28;

    .tensorflow.metadata.v0.TimeDomain time_domain = 28;

    returns

    Whether the timeDomain field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  99. def hasTimeOfDayDomain(): Boolean

    .tensorflow.metadata.v0.TimeOfDayDomain time_of_day_domain = 30;

    .tensorflow.metadata.v0.TimeOfDayDomain time_of_day_domain = 30;

    returns

    Whether the timeOfDayDomain field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  100. def hasType(): Boolean

    Physical type of the feature's values.
Note that you can have:
type: BYTES
int_domain: {
  min: 0
  max: 3
}
This would be a field that is syntactically BYTES (i.e. strings), but
semantically an int, i.e. it would be "0", "1", "2", or "3".


    Physical type of the feature's values.
Note that you can have:
type: BYTES
int_domain: {
  min: 0
  max: 3
}
This would be a field that is syntactically BYTES (i.e. strings), but
semantically an int, i.e. it would be "0", "1", "2", or "3".

    optional .tensorflow.metadata.v0.FeatureType type = 6;

    returns

    Whether the type field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  101. def hasUniqueConstraints(): Boolean

    Constraints on the number of unique values for a given feature.
This is supported for string and categorical features only.


    Constraints on the number of unique values for a given feature.
This is supported for string and categorical features only.

    optional .tensorflow.metadata.v0.UniqueConstraints unique_constraints = 31;

    returns

    Whether the uniqueConstraints field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  102. def hasUrlDomain(): Boolean

    .tensorflow.metadata.v0.URLDomain url_domain = 27;

    .tensorflow.metadata.v0.URLDomain url_domain = 27;

    returns

    Whether the urlDomain field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  103. def hasValidationDerivedSource(): Boolean

    If set, indicates that that this feature is derived, and stores metadata
about its source. If this field is set, this feature should have a
disabled stage (PLANNED, ALPHA, DEPRECATED, DISABLED, DEBUG_ONLY), or
lifecycle_stage VALIDATION_DERIVED.
Experimental and subject to change.


    If set, indicates that that this feature is derived, and stores metadata
about its source. If this field is set, this feature should have a
disabled stage (PLANNED, ALPHA, DEPRECATED, DISABLED, DEBUG_ONLY), or
lifecycle_stage VALIDATION_DERIVED.
Experimental and subject to change.

    optional .tensorflow.metadata.v0.DerivedFeatureSource validation_derived_source = 34;

    returns

    Whether the validationDerivedSource field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  104. def hasValueCount(): Boolean

    The feature doesn't have a well defined shape. All we know are limits on
the minimum and maximum number of values.


    The feature doesn't have a well defined shape. All we know are limits on
the minimum and maximum number of values.

    .tensorflow.metadata.v0.ValueCount value_count = 5;

    returns

    Whether the valueCount field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  105. def hasValueCounts(): Boolean

    Captures the same information as value_count but for features with
nested values. A ValueCount is provided for each nest level.


    Captures the same information as value_count but for features with
nested values. A ValueCount is provided for each nest level.

    .tensorflow.metadata.v0.ValueCountList value_counts = 32;

    returns

    Whether the valueCounts field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override()
  106. def hashCode(): Int
    Definition Classes
    Feature → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  107. final def isInitialized(): Boolean
    Definition Classes
    Feature → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  108. def newBuilderForType(): Builder
    Definition Classes
    Feature → Message → MessageLite
    Annotations
    @Override()
  109. def toBuilder(): Builder
    Definition Classes
    Feature → Message → MessageLite
    Annotations
    @Override()
  110. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  111. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  112. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  113. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  114. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    Feature → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  115. def writeTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Deprecated Value Members

  1. def getDeprecated(): Boolean

    This field is no longer supported. Instead, use:
lifecycle_stage: DEPRECATED
TODO(b/111450258): remove this.


    This field is no longer supported. Instead, use:
lifecycle_stage: DEPRECATED
TODO(b/111450258): remove this.

    optional bool deprecated = 2 [deprecated = true];

    returns

    The deprecated.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated
  2. def hasDeprecated(): Boolean

    This field is no longer supported. Instead, use:
lifecycle_stage: DEPRECATED
TODO(b/111450258): remove this.


    This field is no longer supported. Instead, use:
lifecycle_stage: DEPRECATED
TODO(b/111450258): remove this.

    optional bool deprecated = 2 [deprecated = true];

    returns

    Whether the deprecated field is set.

    Definition Classes
    Feature → FeatureOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated