Package com.google.cloud.aiplatform.v1

Class Feature

  • All Implemented Interfaces:
    FeatureOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Feature
extends com.google.protobuf.GeneratedMessageV3
implements FeatureOrBuilder
     Feature Metadata information that describes an attribute of an entity type.
 For example, apple is an entity type, and color is a feature that describes
 apple.
    Protobuf type google.cloud.aiplatform.v1.Feature
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Immutable. Name of the Feature.
 Format:
 `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`

 The last part feature is assigned by the client. The feature can be up to
 64 characters long and can consist only of ASCII Latin letters A-Z and a-z,
 underscore(_), and ASCII digits 0-9 starting with a letter. The value will
 be unique given an entity type.
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getName in interface FeatureOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Immutable. Name of the Feature.
 Format:
 `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`

 The last part feature is assigned by the client. The feature can be up to
 64 characters long and can consist only of ASCII Latin letters A-Z and a-z,
 underscore(_), and ASCII digits 0-9 starting with a letter. The value will
 be unique given an entity type.
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getNameBytes in interface FeatureOrBuilder
        Returns:
        The bytes for name.

      • getDescription

        public String getDescription()
         Description of the Feature.
        string description = 2;
        Specified by:
        getDescription in interface FeatureOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Description of the Feature.
        string description = 2;
        Specified by:
        getDescriptionBytes in interface FeatureOrBuilder
        Returns:
        The bytes for description.

      • getValueTypeValue

        public int getValueTypeValue()
         Required. Immutable. Type of Feature value.
        .google.cloud.aiplatform.v1.Feature.ValueType value_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getValueTypeValue in interface FeatureOrBuilder
        Returns:
        The enum numeric value on the wire for valueType.

      • getValueType

        public Feature.ValueType getValueType()
         Required. Immutable. Type of Feature value.
        .google.cloud.aiplatform.v1.Feature.ValueType value_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getValueType in interface FeatureOrBuilder
        Returns:
        The valueType.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Timestamp when this EntityType was created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface FeatureOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Timestamp when this EntityType was created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface FeatureOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp when this EntityType was created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface FeatureOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Timestamp when this EntityType was most recently updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface FeatureOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. Timestamp when this EntityType was most recently updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface FeatureOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Timestamp when this EntityType was most recently updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface FeatureOrBuilder

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: FeatureOrBuilder
         Optional. The labels with user-defined metadata to organize your Features.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
 No more than 64 user labels can be associated with one Feature (System
 labels are excluded)."
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable.
        map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsCount in interface FeatureOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Optional. The labels with user-defined metadata to organize your Features.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
 No more than 64 user labels can be associated with one Feature (System
 labels are excluded)."
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable.
        map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsLabels in interface FeatureOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Optional. The labels with user-defined metadata to organize your Features.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
 No more than 64 user labels can be associated with one Feature (System
 labels are excluded)."
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable.
        map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsMap in interface FeatureOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         Optional. The labels with user-defined metadata to organize your Features.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
 No more than 64 user labels can be associated with one Feature (System
 labels are excluded)."
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable.
        map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrDefault in interface FeatureOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Optional. The labels with user-defined metadata to organize your Features.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information on and examples of labels.
 No more than 64 user labels can be associated with one Feature (System
 labels are excluded)."
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable.
        map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrThrow in interface FeatureOrBuilder

      • getEtag

        public String getEtag()
         Used to perform a consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
        string etag = 7;
        Specified by:
        getEtag in interface FeatureOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         Used to perform a consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
        string etag = 7;
        Specified by:
        getEtagBytes in interface FeatureOrBuilder
        Returns:
        The bytes for etag.

      • getDisableMonitoring

        public boolean getDisableMonitoring()
         Optional. If not set, use the monitoring_config defined for the EntityType
 this Feature belongs to. Only Features with type
 ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL,
 STRING, DOUBLE or INT64 can enable monitoring.

 If set to true, all types of data monitoring are disabled despite the
 config on EntityType.
        bool disable_monitoring = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisableMonitoring in interface FeatureOrBuilder
        Returns:
        The disableMonitoring.

      • getMonitoringStatsAnomaliesList

        public List<Feature.MonitoringStatsAnomaly> getMonitoringStatsAnomaliesList()
         Output only. The list of historical stats and anomalies with specified
 objectives.
        repeated .google.cloud.aiplatform.v1.Feature.MonitoringStatsAnomaly monitoring_stats_anomalies = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMonitoringStatsAnomaliesList in interface FeatureOrBuilder

      • getMonitoringStatsAnomaliesCount

        public int getMonitoringStatsAnomaliesCount()
         Output only. The list of historical stats and anomalies with specified
 objectives.
        repeated .google.cloud.aiplatform.v1.Feature.MonitoringStatsAnomaly monitoring_stats_anomalies = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMonitoringStatsAnomaliesCount in interface FeatureOrBuilder

      • getMonitoringStatsAnomalies

        public Feature.MonitoringStatsAnomaly getMonitoringStatsAnomalies​(int index)
         Output only. The list of historical stats and anomalies with specified
 objectives.
        repeated .google.cloud.aiplatform.v1.Feature.MonitoringStatsAnomaly monitoring_stats_anomalies = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMonitoringStatsAnomalies in interface FeatureOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Feature parseFrom​(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Feature parseFrom​(ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Feature parseFrom​(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Feature parseFrom​(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Feature parseFrom​(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Feature parseFrom​(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Feature parseFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Feature.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Feature.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Feature.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Feature getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Feature> parser()

      • getParserForType

        public com.google.protobuf.Parser<Feature> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Feature getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder