Package org.tensorflow.metadata.v0

Interface FeatureOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Feature, Feature.Builder
    public interface FeatureOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasName

        boolean hasName()
         The name of the feature.
        optional string name = 1;
        Returns:
        Whether the name field is set.

      • getName

        String getName()
         The name of the feature.
        optional string name = 1;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The name of the feature.
        optional string name = 1;
        Returns:
        The bytes for name.

      • hasDeprecated

        @Deprecated
boolean hasDeprecated()
        Deprecated.
         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.

      • getDeprecated

        @Deprecated
boolean getDeprecated()
        Deprecated.
         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.

      • hasPresence

        boolean hasPresence()
         Constraints on the presence of this feature in the examples.
        .tensorflow.metadata.v0.FeaturePresence presence = 14;
        Returns:
        Whether the presence field is set.

      • getPresence

        FeaturePresence getPresence()
         Constraints on the presence of this feature in the examples.
        .tensorflow.metadata.v0.FeaturePresence presence = 14;
        Returns:
        The presence.

      • getPresenceOrBuilder

        FeaturePresenceOrBuilder getPresenceOrBuilder()
         Constraints on the presence of this feature in the examples.
        .tensorflow.metadata.v0.FeaturePresence presence = 14;

      • hasGroupPresence

        boolean hasGroupPresence()
         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.

      • getGroupPresence

        FeaturePresenceWithinGroup getGroupPresence()
         Only used in the context of a "group" context, e.g., inside a sequence.
        .tensorflow.metadata.v0.FeaturePresenceWithinGroup group_presence = 17;
        Returns:
        The groupPresence.

      • getGroupPresenceOrBuilder

        FeaturePresenceWithinGroupOrBuilder getGroupPresenceOrBuilder()
         Only used in the context of a "group" context, e.g., inside a sequence.
        .tensorflow.metadata.v0.FeaturePresenceWithinGroup group_presence = 17;

      • hasShape

        boolean hasShape()
         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.

      • getShape

        FixedShape getShape()
         The feature has a fixed shape corresponding to a multi-dimensional
 tensor.
        .tensorflow.metadata.v0.FixedShape shape = 23;
        Returns:
        The shape.

      • getShapeOrBuilder

        FixedShapeOrBuilder getShapeOrBuilder()
         The feature has a fixed shape corresponding to a multi-dimensional
 tensor.
        .tensorflow.metadata.v0.FixedShape shape = 23;

      • hasValueCount

        boolean hasValueCount()
         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.

      • getValueCount

        ValueCount getValueCount()
         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.

      • getValueCountOrBuilder

        ValueCountOrBuilder getValueCountOrBuilder()
         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;

      • hasType

        boolean hasType()
         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.

      • getType

        FeatureType getType()
         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.

      • hasDomain

        boolean hasDomain()
         Reference to a domain defined at the schema level.
        string domain = 7;
        Returns:
        Whether the domain field is set.

      • getDomain

        String getDomain()
         Reference to a domain defined at the schema level.
        string domain = 7;
        Returns:
        The domain.

      • getDomainBytes

        com.google.protobuf.ByteString getDomainBytes()
         Reference to a domain defined at the schema level.
        string domain = 7;
        Returns:
        The bytes for domain.

      • hasIntDomain

        boolean hasIntDomain()
         Inline definitions of domains.
        .tensorflow.metadata.v0.IntDomain int_domain = 9;
        Returns:
        Whether the intDomain field is set.

      • getIntDomain

        IntDomain getIntDomain()
         Inline definitions of domains.
        .tensorflow.metadata.v0.IntDomain int_domain = 9;
        Returns:
        The intDomain.

      • getIntDomainOrBuilder

        IntDomainOrBuilder getIntDomainOrBuilder()
         Inline definitions of domains.
        .tensorflow.metadata.v0.IntDomain int_domain = 9;

      • hasFloatDomain

        boolean hasFloatDomain()
        .tensorflow.metadata.v0.FloatDomain float_domain = 10;
        Returns:
        Whether the floatDomain field is set.

      • getFloatDomain

        FloatDomain getFloatDomain()
        .tensorflow.metadata.v0.FloatDomain float_domain = 10;
        Returns:
        The floatDomain.

      • getFloatDomainOrBuilder

        FloatDomainOrBuilder getFloatDomainOrBuilder()
        .tensorflow.metadata.v0.FloatDomain float_domain = 10;

      • hasStringDomain

        boolean hasStringDomain()
        .tensorflow.metadata.v0.StringDomain string_domain = 11;
        Returns:
        Whether the stringDomain field is set.

      • getStringDomain

        StringDomain getStringDomain()
        .tensorflow.metadata.v0.StringDomain string_domain = 11;
        Returns:
        The stringDomain.

      • getStringDomainOrBuilder

        StringDomainOrBuilder getStringDomainOrBuilder()
        .tensorflow.metadata.v0.StringDomain string_domain = 11;

      • hasBoolDomain

        boolean hasBoolDomain()
        .tensorflow.metadata.v0.BoolDomain bool_domain = 13;
        Returns:
        Whether the boolDomain field is set.

      • getBoolDomain

        BoolDomain getBoolDomain()
        .tensorflow.metadata.v0.BoolDomain bool_domain = 13;
        Returns:
        The boolDomain.

      • getBoolDomainOrBuilder

        BoolDomainOrBuilder getBoolDomainOrBuilder()
        .tensorflow.metadata.v0.BoolDomain bool_domain = 13;

      • hasStructDomain

        boolean hasStructDomain()
        .tensorflow.metadata.v0.StructDomain struct_domain = 29;
        Returns:
        Whether the structDomain field is set.

      • getStructDomain

        StructDomain getStructDomain()
        .tensorflow.metadata.v0.StructDomain struct_domain = 29;
        Returns:
        The structDomain.

      • getStructDomainOrBuilder

        StructDomainOrBuilder getStructDomainOrBuilder()
        .tensorflow.metadata.v0.StructDomain struct_domain = 29;

      • hasNaturalLanguageDomain

        boolean hasNaturalLanguageDomain()
         Supported semantic domains.
        .tensorflow.metadata.v0.NaturalLanguageDomain natural_language_domain = 24;
        Returns:
        Whether the naturalLanguageDomain field is set.

      • getNaturalLanguageDomain

        NaturalLanguageDomain getNaturalLanguageDomain()
         Supported semantic domains.
        .tensorflow.metadata.v0.NaturalLanguageDomain natural_language_domain = 24;
        Returns:
        The naturalLanguageDomain.

      • getNaturalLanguageDomainOrBuilder

        NaturalLanguageDomainOrBuilder getNaturalLanguageDomainOrBuilder()
         Supported semantic domains.
        .tensorflow.metadata.v0.NaturalLanguageDomain natural_language_domain = 24;

      • hasImageDomain

        boolean hasImageDomain()
        .tensorflow.metadata.v0.ImageDomain image_domain = 25;
        Returns:
        Whether the imageDomain field is set.

      • getImageDomain

        ImageDomain getImageDomain()
        .tensorflow.metadata.v0.ImageDomain image_domain = 25;
        Returns:
        The imageDomain.

      • getImageDomainOrBuilder

        ImageDomainOrBuilder getImageDomainOrBuilder()
        .tensorflow.metadata.v0.ImageDomain image_domain = 25;

      • hasMidDomain

        boolean hasMidDomain()
        .tensorflow.metadata.v0.MIDDomain mid_domain = 26;
        Returns:
        Whether the midDomain field is set.

      • getMidDomain

        MIDDomain getMidDomain()
        .tensorflow.metadata.v0.MIDDomain mid_domain = 26;
        Returns:
        The midDomain.

      • getMidDomainOrBuilder

        MIDDomainOrBuilder getMidDomainOrBuilder()
        .tensorflow.metadata.v0.MIDDomain mid_domain = 26;

      • hasUrlDomain

        boolean hasUrlDomain()
        .tensorflow.metadata.v0.URLDomain url_domain = 27;
        Returns:
        Whether the urlDomain field is set.

      • getUrlDomain

        URLDomain getUrlDomain()
        .tensorflow.metadata.v0.URLDomain url_domain = 27;
        Returns:
        The urlDomain.

      • getUrlDomainOrBuilder

        URLDomainOrBuilder getUrlDomainOrBuilder()
        .tensorflow.metadata.v0.URLDomain url_domain = 27;

      • hasTimeDomain

        boolean hasTimeDomain()
        .tensorflow.metadata.v0.TimeDomain time_domain = 28;
        Returns:
        Whether the timeDomain field is set.

      • getTimeDomain

        TimeDomain getTimeDomain()
        .tensorflow.metadata.v0.TimeDomain time_domain = 28;
        Returns:
        The timeDomain.

      • getTimeDomainOrBuilder

        TimeDomainOrBuilder getTimeDomainOrBuilder()
        .tensorflow.metadata.v0.TimeDomain time_domain = 28;

      • hasTimeOfDayDomain

        boolean hasTimeOfDayDomain()
        .tensorflow.metadata.v0.TimeOfDayDomain time_of_day_domain = 30;
        Returns:
        Whether the timeOfDayDomain field is set.

      • getTimeOfDayDomain

        TimeOfDayDomain getTimeOfDayDomain()
        .tensorflow.metadata.v0.TimeOfDayDomain time_of_day_domain = 30;
        Returns:
        The timeOfDayDomain.

      • getTimeOfDayDomainOrBuilder

        TimeOfDayDomainOrBuilder getTimeOfDayDomainOrBuilder()
        .tensorflow.metadata.v0.TimeOfDayDomain time_of_day_domain = 30;

      • hasDistributionConstraints

        boolean hasDistributionConstraints()
         Constraints on the distribution of the feature values.
 Currently only supported for StringDomains.
 TODO(b/69473628): Extend functionality to other domain types.
        optional .tensorflow.metadata.v0.DistributionConstraints distribution_constraints = 15;
        Returns:
        Whether the distributionConstraints field is set.

      • getDistributionConstraints

        DistributionConstraints getDistributionConstraints()
         Constraints on the distribution of the feature values.
 Currently only supported for StringDomains.
 TODO(b/69473628): Extend functionality to other domain types.
        optional .tensorflow.metadata.v0.DistributionConstraints distribution_constraints = 15;
        Returns:
        The distributionConstraints.

      • getDistributionConstraintsOrBuilder

        DistributionConstraintsOrBuilder getDistributionConstraintsOrBuilder()
         Constraints on the distribution of the feature values.
 Currently only supported for StringDomains.
 TODO(b/69473628): Extend functionality to other domain types.
        optional .tensorflow.metadata.v0.DistributionConstraints distribution_constraints = 15;

      • hasAnnotation

        boolean hasAnnotation()
         Additional information about the feature for documentation purpose.
        optional .tensorflow.metadata.v0.Annotation annotation = 16;
        Returns:
        Whether the annotation field is set.

      • getAnnotation

        Annotation getAnnotation()
         Additional information about the feature for documentation purpose.
        optional .tensorflow.metadata.v0.Annotation annotation = 16;
        Returns:
        The annotation.

      • getAnnotationOrBuilder

        AnnotationOrBuilder getAnnotationOrBuilder()
         Additional information about the feature for documentation purpose.
        optional .tensorflow.metadata.v0.Annotation annotation = 16;

      • hasSkewComparator

        boolean hasSkewComparator()
         Tests comparing the distribution to the associated serving data.
        optional .tensorflow.metadata.v0.FeatureComparator skew_comparator = 18;
        Returns:
        Whether the skewComparator field is set.

      • getSkewComparator

        FeatureComparator getSkewComparator()
         Tests comparing the distribution to the associated serving data.
        optional .tensorflow.metadata.v0.FeatureComparator skew_comparator = 18;
        Returns:
        The skewComparator.

      • getSkewComparatorOrBuilder

        FeatureComparatorOrBuilder getSkewComparatorOrBuilder()
         Tests comparing the distribution to the associated serving data.
        optional .tensorflow.metadata.v0.FeatureComparator skew_comparator = 18;

      • hasDriftComparator

        boolean hasDriftComparator()
         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.

      • getDriftComparator

        FeatureComparator getDriftComparator()
         Tests comparing the distribution between two consecutive spans (e.g. days).
        optional .tensorflow.metadata.v0.FeatureComparator drift_comparator = 21;
        Returns:
        The driftComparator.

      • getDriftComparatorOrBuilder

        FeatureComparatorOrBuilder getDriftComparatorOrBuilder()
         Tests comparing the distribution between two consecutive spans (e.g. days).
        optional .tensorflow.metadata.v0.FeatureComparator drift_comparator = 21;

      • getInEnvironmentList

        List<String> getInEnvironmentList()
         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_environments) AND
 "foo" is not in not_in_environment.
 See Schema::default_environments.
        repeated string in_environment = 20;
        Returns:
        A list containing the inEnvironment.

      • getInEnvironmentCount

        int getInEnvironmentCount()
         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_environments) AND
 "foo" is not in not_in_environment.
 See Schema::default_environments.
        repeated string in_environment = 20;
        Returns:
        The count of inEnvironment.

      • getInEnvironment

        String getInEnvironment​(int index)
         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_environments) AND
 "foo" is not in not_in_environment.
 See Schema::default_environments.
        repeated string in_environment = 20;
        Parameters:
        index - The index of the element to return.
        Returns:
        The inEnvironment at the given index.

      • getInEnvironmentBytes

        com.google.protobuf.ByteString getInEnvironmentBytes​(int index)
         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_environments) AND
 "foo" is not in not_in_environment.
 See Schema::default_environments.
        repeated string in_environment = 20;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the inEnvironment at the given index.

      • getNotInEnvironmentList

        List<String> getNotInEnvironmentList()
         List of environments this feature is not present in.
 Should be disjoint from of in_environment.
 See Schema::default_environments and in_environment.
        repeated string not_in_environment = 19;
        Returns:
        A list containing the notInEnvironment.

      • getNotInEnvironmentCount

        int getNotInEnvironmentCount()
         List of environments this feature is not present in.
 Should be disjoint from of in_environment.
 See Schema::default_environments and in_environment.
        repeated string not_in_environment = 19;
        Returns:
        The count of notInEnvironment.

      • getNotInEnvironment

        String getNotInEnvironment​(int index)
         List of environments this feature is not present in.
 Should be disjoint from of in_environment.
 See Schema::default_environments and in_environment.
        repeated string not_in_environment = 19;
        Parameters:
        index - The index of the element to return.
        Returns:
        The notInEnvironment at the given index.

      • getNotInEnvironmentBytes

        com.google.protobuf.ByteString getNotInEnvironmentBytes​(int index)
         List of environments this feature is not present in.
 Should be disjoint from of in_environment.
 See Schema::default_environments and in_environment.
        repeated string not_in_environment = 19;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the notInEnvironment at the given index.

      • hasLifecycleStage

        boolean hasLifecycleStage()
         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.

      • getLifecycleStage

        LifecycleStage getLifecycleStage()
         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.