org.tensorflow.metadata.v0.FeatureOrBuilder Maven / Gradle / Ivy
The newest version!
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: tensorflow_metadata/proto/v0/schema.proto
// Protobuf Java Version: 3.25.4
package org.tensorflow.metadata.v0;
public interface FeatureOrBuilder extends
// @@protoc_insertion_point(interface_extends:tensorflow.metadata.v0.Feature)
com.google.protobuf.MessageOrBuilder {
/**
*
* The name of the feature.
*
*
* optional string name = 1;
* @return Whether the name field is set.
*/
boolean hasName();
/**
*
* The name of the feature.
*
*
* optional string name = 1;
* @return The name.
*/
java.lang.String getName();
/**
*
* The name of the feature.
*
*
* optional string name = 1;
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
* This field is no longer supported. Instead, use:
* lifecycle_stage: DEPRECATED
* TODO(b/111450258): remove this.
*
*
* optional bool deprecated = 2 [deprecated = true];
* @deprecated tensorflow.metadata.v0.Feature.deprecated is deprecated.
* See tensorflow_metadata/proto/v0/schema.proto;l=153
* @return Whether the deprecated field is set.
*/
@java.lang.Deprecated boolean hasDeprecated();
/**
*
* This field is no longer supported. Instead, use:
* lifecycle_stage: DEPRECATED
* TODO(b/111450258): remove this.
*
*
* optional bool deprecated = 2 [deprecated = true];
* @deprecated tensorflow.metadata.v0.Feature.deprecated is deprecated.
* See tensorflow_metadata/proto/v0/schema.proto;l=153
* @return The deprecated.
*/
@java.lang.Deprecated boolean getDeprecated();
/**
*
* Constraints on the presence of this feature in the examples.
*
*
* .tensorflow.metadata.v0.FeaturePresence presence = 14;
* @return Whether the presence field is set.
*/
boolean hasPresence();
/**
*
* Constraints on the presence of this feature in the examples.
*
*
* .tensorflow.metadata.v0.FeaturePresence presence = 14;
* @return The presence.
*/
org.tensorflow.metadata.v0.FeaturePresence getPresence();
/**
*
* Constraints on the presence of this feature in the examples.
*
*
* .tensorflow.metadata.v0.FeaturePresence presence = 14;
*/
org.tensorflow.metadata.v0.FeaturePresenceOrBuilder getPresenceOrBuilder();
/**
*
* Only used in the context of a "group" context, e.g., inside a sequence.
*
*
* .tensorflow.metadata.v0.FeaturePresenceWithinGroup group_presence = 17;
* @return Whether the groupPresence field is set.
*/
boolean hasGroupPresence();
/**
*
* Only used in the context of a "group" context, e.g., inside a sequence.
*
*
* .tensorflow.metadata.v0.FeaturePresenceWithinGroup group_presence = 17;
* @return The groupPresence.
*/
org.tensorflow.metadata.v0.FeaturePresenceWithinGroup getGroupPresence();
/**
*
* Only used in the context of a "group" context, e.g., inside a sequence.
*
*
* .tensorflow.metadata.v0.FeaturePresenceWithinGroup group_presence = 17;
*/
org.tensorflow.metadata.v0.FeaturePresenceWithinGroupOrBuilder getGroupPresenceOrBuilder();
/**
*
* The feature has a fixed shape corresponding to a multi-dimensional
* tensor.
*
*
* .tensorflow.metadata.v0.FixedShape shape = 23;
* @return Whether the shape field is set.
*/
boolean hasShape();
/**
*
* The feature has a fixed shape corresponding to a multi-dimensional
* tensor.
*
*
* .tensorflow.metadata.v0.FixedShape shape = 23;
* @return The shape.
*/
org.tensorflow.metadata.v0.FixedShape getShape();
/**
*
* The feature has a fixed shape corresponding to a multi-dimensional
* tensor.
*
*
* .tensorflow.metadata.v0.FixedShape shape = 23;
*/
org.tensorflow.metadata.v0.FixedShapeOrBuilder getShapeOrBuilder();
/**
*
* 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;
* @return Whether the valueCount field is set.
*/
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;
* @return The valueCount.
*/
org.tensorflow.metadata.v0.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;
*/
org.tensorflow.metadata.v0.ValueCountOrBuilder getValueCountOrBuilder();
/**
*
* 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;
* @return Whether the valueCounts field is set.
*/
boolean hasValueCounts();
/**
*
* 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;
* @return The valueCounts.
*/
org.tensorflow.metadata.v0.ValueCountList getValueCounts();
/**
*
* 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;
*/
org.tensorflow.metadata.v0.ValueCountListOrBuilder getValueCountsOrBuilder();
/**
*
* 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;
* @return Whether the type field is set.
*/
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;
* @return The type.
*/
org.tensorflow.metadata.v0.FeatureType getType();
/**
*
* Reference to a domain defined at the schema level.
*
*
* string domain = 7;
* @return Whether the domain field is set.
*/
boolean hasDomain();
/**
*
* Reference to a domain defined at the schema level.
*
*
* string domain = 7;
* @return The domain.
*/
java.lang.String getDomain();
/**
*
* Reference to a domain defined at the schema level.
*
*
* string domain = 7;
* @return The bytes for domain.
*/
com.google.protobuf.ByteString
getDomainBytes();
/**
*
* Inline definitions of domains.
*
*
* .tensorflow.metadata.v0.IntDomain int_domain = 9;
* @return Whether the intDomain field is set.
*/
boolean hasIntDomain();
/**
*
* Inline definitions of domains.
*
*
* .tensorflow.metadata.v0.IntDomain int_domain = 9;
* @return The intDomain.
*/
org.tensorflow.metadata.v0.IntDomain getIntDomain();
/**
*
* Inline definitions of domains.
*
*
* .tensorflow.metadata.v0.IntDomain int_domain = 9;
*/
org.tensorflow.metadata.v0.IntDomainOrBuilder getIntDomainOrBuilder();
/**
* .tensorflow.metadata.v0.FloatDomain float_domain = 10;
* @return Whether the floatDomain field is set.
*/
boolean hasFloatDomain();
/**
* .tensorflow.metadata.v0.FloatDomain float_domain = 10;
* @return The floatDomain.
*/
org.tensorflow.metadata.v0.FloatDomain getFloatDomain();
/**
* .tensorflow.metadata.v0.FloatDomain float_domain = 10;
*/
org.tensorflow.metadata.v0.FloatDomainOrBuilder getFloatDomainOrBuilder();
/**
* .tensorflow.metadata.v0.StringDomain string_domain = 11;
* @return Whether the stringDomain field is set.
*/
boolean hasStringDomain();
/**
* .tensorflow.metadata.v0.StringDomain string_domain = 11;
* @return The stringDomain.
*/
org.tensorflow.metadata.v0.StringDomain getStringDomain();
/**
* .tensorflow.metadata.v0.StringDomain string_domain = 11;
*/
org.tensorflow.metadata.v0.StringDomainOrBuilder getStringDomainOrBuilder();
/**
* .tensorflow.metadata.v0.BoolDomain bool_domain = 13;
* @return Whether the boolDomain field is set.
*/
boolean hasBoolDomain();
/**
* .tensorflow.metadata.v0.BoolDomain bool_domain = 13;
* @return The boolDomain.
*/
org.tensorflow.metadata.v0.BoolDomain getBoolDomain();
/**
* .tensorflow.metadata.v0.BoolDomain bool_domain = 13;
*/
org.tensorflow.metadata.v0.BoolDomainOrBuilder getBoolDomainOrBuilder();
/**
* .tensorflow.metadata.v0.StructDomain struct_domain = 29;
* @return Whether the structDomain field is set.
*/
boolean hasStructDomain();
/**
* .tensorflow.metadata.v0.StructDomain struct_domain = 29;
* @return The structDomain.
*/
org.tensorflow.metadata.v0.StructDomain getStructDomain();
/**
* .tensorflow.metadata.v0.StructDomain struct_domain = 29;
*/
org.tensorflow.metadata.v0.StructDomainOrBuilder getStructDomainOrBuilder();
/**
*
* Supported semantic domains.
*
*
* .tensorflow.metadata.v0.NaturalLanguageDomain natural_language_domain = 24;
* @return Whether the naturalLanguageDomain field is set.
*/
boolean hasNaturalLanguageDomain();
/**
*
* Supported semantic domains.
*
*
* .tensorflow.metadata.v0.NaturalLanguageDomain natural_language_domain = 24;
* @return The naturalLanguageDomain.
*/
org.tensorflow.metadata.v0.NaturalLanguageDomain getNaturalLanguageDomain();
/**
*
* Supported semantic domains.
*
*
* .tensorflow.metadata.v0.NaturalLanguageDomain natural_language_domain = 24;
*/
org.tensorflow.metadata.v0.NaturalLanguageDomainOrBuilder getNaturalLanguageDomainOrBuilder();
/**
* .tensorflow.metadata.v0.ImageDomain image_domain = 25;
* @return Whether the imageDomain field is set.
*/
boolean hasImageDomain();
/**
* .tensorflow.metadata.v0.ImageDomain image_domain = 25;
* @return The imageDomain.
*/
org.tensorflow.metadata.v0.ImageDomain getImageDomain();
/**
* .tensorflow.metadata.v0.ImageDomain image_domain = 25;
*/
org.tensorflow.metadata.v0.ImageDomainOrBuilder getImageDomainOrBuilder();
/**
* .tensorflow.metadata.v0.MIDDomain mid_domain = 26;
* @return Whether the midDomain field is set.
*/
boolean hasMidDomain();
/**
* .tensorflow.metadata.v0.MIDDomain mid_domain = 26;
* @return The midDomain.
*/
org.tensorflow.metadata.v0.MIDDomain getMidDomain();
/**
* .tensorflow.metadata.v0.MIDDomain mid_domain = 26;
*/
org.tensorflow.metadata.v0.MIDDomainOrBuilder getMidDomainOrBuilder();
/**
* .tensorflow.metadata.v0.URLDomain url_domain = 27;
* @return Whether the urlDomain field is set.
*/
boolean hasUrlDomain();
/**
* .tensorflow.metadata.v0.URLDomain url_domain = 27;
* @return The urlDomain.
*/
org.tensorflow.metadata.v0.URLDomain getUrlDomain();
/**
* .tensorflow.metadata.v0.URLDomain url_domain = 27;
*/
org.tensorflow.metadata.v0.URLDomainOrBuilder getUrlDomainOrBuilder();
/**
* .tensorflow.metadata.v0.TimeDomain time_domain = 28;
* @return Whether the timeDomain field is set.
*/
boolean hasTimeDomain();
/**
* .tensorflow.metadata.v0.TimeDomain time_domain = 28;
* @return The timeDomain.
*/
org.tensorflow.metadata.v0.TimeDomain getTimeDomain();
/**
* .tensorflow.metadata.v0.TimeDomain time_domain = 28;
*/
org.tensorflow.metadata.v0.TimeDomainOrBuilder getTimeDomainOrBuilder();
/**
* .tensorflow.metadata.v0.TimeOfDayDomain time_of_day_domain = 30;
* @return Whether the timeOfDayDomain field is set.
*/
boolean hasTimeOfDayDomain();
/**
* .tensorflow.metadata.v0.TimeOfDayDomain time_of_day_domain = 30;
* @return The timeOfDayDomain.
*/
org.tensorflow.metadata.v0.TimeOfDayDomain getTimeOfDayDomain();
/**
* .tensorflow.metadata.v0.TimeOfDayDomain time_of_day_domain = 30;
*/
org.tensorflow.metadata.v0.TimeOfDayDomainOrBuilder getTimeOfDayDomainOrBuilder();
/**
*
* Constraints on the distribution of the feature values.
* Only supported for StringDomains.
*
*
* optional .tensorflow.metadata.v0.DistributionConstraints distribution_constraints = 15;
* @return Whether the distributionConstraints field is set.
*/
boolean hasDistributionConstraints();
/**
*
* Constraints on the distribution of the feature values.
* Only supported for StringDomains.
*
*
* optional .tensorflow.metadata.v0.DistributionConstraints distribution_constraints = 15;
* @return The distributionConstraints.
*/
org.tensorflow.metadata.v0.DistributionConstraints getDistributionConstraints();
/**
*
* Constraints on the distribution of the feature values.
* Only supported for StringDomains.
*
*
* optional .tensorflow.metadata.v0.DistributionConstraints distribution_constraints = 15;
*/
org.tensorflow.metadata.v0.DistributionConstraintsOrBuilder getDistributionConstraintsOrBuilder();
/**
*
* Additional information about the feature for documentation purpose.
*
*
* optional .tensorflow.metadata.v0.Annotation annotation = 16;
* @return Whether the annotation field is set.
*/
boolean hasAnnotation();
/**
*
* Additional information about the feature for documentation purpose.
*
*
* optional .tensorflow.metadata.v0.Annotation annotation = 16;
* @return The annotation.
*/
org.tensorflow.metadata.v0.Annotation getAnnotation();
/**
*
* Additional information about the feature for documentation purpose.
*
*
* optional .tensorflow.metadata.v0.Annotation annotation = 16;
*/
org.tensorflow.metadata.v0.AnnotationOrBuilder getAnnotationOrBuilder();
/**
*
* Tests comparing the distribution to the associated serving data.
*
*
* optional .tensorflow.metadata.v0.FeatureComparator skew_comparator = 18;
* @return Whether the skewComparator field is set.
*/
boolean hasSkewComparator();
/**
*
* Tests comparing the distribution to the associated serving data.
*
*
* optional .tensorflow.metadata.v0.FeatureComparator skew_comparator = 18;
* @return The skewComparator.
*/
org.tensorflow.metadata.v0.FeatureComparator getSkewComparator();
/**
*
* Tests comparing the distribution to the associated serving data.
*
*
* optional .tensorflow.metadata.v0.FeatureComparator skew_comparator = 18;
*/
org.tensorflow.metadata.v0.FeatureComparatorOrBuilder getSkewComparatorOrBuilder();
/**
*
* Tests comparing the distribution between two consecutive spans (e.g. days).
*
*
* optional .tensorflow.metadata.v0.FeatureComparator drift_comparator = 21;
* @return Whether the driftComparator field is set.
*/
boolean hasDriftComparator();
/**
*
* Tests comparing the distribution between two consecutive spans (e.g. days).
*
*
* optional .tensorflow.metadata.v0.FeatureComparator drift_comparator = 21;
* @return The driftComparator.
*/
org.tensorflow.metadata.v0.FeatureComparator getDriftComparator();
/**
*
* Tests comparing the distribution between two consecutive spans (e.g. days).
*
*
* optional .tensorflow.metadata.v0.FeatureComparator drift_comparator = 21;
*/
org.tensorflow.metadata.v0.FeatureComparatorOrBuilder getDriftComparatorOrBuilder();
/**
*
* 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;
* @return A list containing the inEnvironment.
*/
java.util.List
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_environment) AND
* "foo" is not in not_in_environment.
* See Schema::default_environment.
*
*
* repeated string in_environment = 20;
* @return The count of inEnvironment.
*/
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_environment) AND
* "foo" is not in not_in_environment.
* See Schema::default_environment.
*
*
* repeated string in_environment = 20;
* @param index The index of the element to return.
* @return The inEnvironment at the given index.
*/
java.lang.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_environment) AND
* "foo" is not in not_in_environment.
* See Schema::default_environment.
*
*
* repeated string in_environment = 20;
* @param index The index of the value to return.
* @return The bytes of the inEnvironment at the given index.
*/
com.google.protobuf.ByteString
getInEnvironmentBytes(int index);
/**
*
* 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;
* @return A list containing the notInEnvironment.
*/
java.util.List
getNotInEnvironmentList();
/**
*
* 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;
* @return The count of notInEnvironment.
*/
int getNotInEnvironmentCount();
/**
*
* 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;
* @param index The index of the element to return.
* @return The notInEnvironment at the given index.
*/
java.lang.String getNotInEnvironment(int index);
/**
*
* 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;
* @param index The index of the value to return.
* @return The bytes of the notInEnvironment at the given index.
*/
com.google.protobuf.ByteString
getNotInEnvironmentBytes(int index);
/**
*
* 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;
* @return Whether the lifecycleStage field is set.
*/
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;
* @return The lifecycleStage.
*/
org.tensorflow.metadata.v0.LifecycleStage getLifecycleStage();
/**
*
* 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;
* @return Whether the uniqueConstraints field is set.
*/
boolean hasUniqueConstraints();
/**
*
* 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;
* @return The uniqueConstraints.
*/
org.tensorflow.metadata.v0.UniqueConstraints getUniqueConstraints();
/**
*
* 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;
*/
org.tensorflow.metadata.v0.UniqueConstraintsOrBuilder getUniqueConstraintsOrBuilder();
/**
*
* 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;
* @return Whether the validationDerivedSource field is set.
*/
boolean hasValidationDerivedSource();
/**
*
* 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;
* @return The validationDerivedSource.
*/
org.tensorflow.metadata.v0.DerivedFeatureSource getValidationDerivedSource();
/**
*
* 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;
*/
org.tensorflow.metadata.v0.DerivedFeatureSourceOrBuilder getValidationDerivedSourceOrBuilder();
/**
*
* 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;
* @return Whether the sequenceMetadata field is set.
*/
boolean hasSequenceMetadata();
/**
*
* 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;
* @return The sequenceMetadata.
*/
org.tensorflow.metadata.v0.SequenceMetadata getSequenceMetadata();
/**
*
* 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;
*/
org.tensorflow.metadata.v0.SequenceMetadataOrBuilder getSequenceMetadataOrBuilder();
org.tensorflow.metadata.v0.Feature.PresenceConstraintsCase getPresenceConstraintsCase();
org.tensorflow.metadata.v0.Feature.ShapeTypeCase getShapeTypeCase();
org.tensorflow.metadata.v0.Feature.DomainInfoCase getDomainInfoCase();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy