Package com.google.cloud.aiplatform.v1

Class Feature

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.Feature
All Implemented Interfaces:
FeatureOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Feature extends com.google.protobuf.GeneratedMessage implements FeatureOrBuilder
 Feature Metadata information.
 For example, color is a feature that describes an apple.
Protobuf type google.cloud.aiplatform.v1.Feature
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • VALUE_TYPE_FIELD_NUMBER

      public static final int VALUE_TYPE_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • ETAG_FIELD_NUMBER

      public static final int ETAG_FIELD_NUMBER
      See Also:

    • DISABLE_MONITORING_FIELD_NUMBER

      public static final int DISABLE_MONITORING_FIELD_NUMBER
      See Also:

    • MONITORING_STATS_ANOMALIES_FIELD_NUMBER

      public static final int MONITORING_STATS_ANOMALIES_FIELD_NUMBER
      See Also:

    • VERSION_COLUMN_NAME_FIELD_NUMBER

      public static final int VERSION_COLUMN_NAME_FIELD_NUMBER
      See Also:

    • POINT_OF_CONTACT_FIELD_NUMBER

      public static final int POINT_OF_CONTACT_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getName

      public String getName()
       Immutable. Name of the Feature.
 Format:
 `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`
 `projects/{project}/locations/{location}/featureGroups/{feature_group}/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}`
 `projects/{project}/locations/{location}/featureGroups/{feature_group}/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()
       Immutable. Only applicable for Vertex AI Feature Store (Legacy).
 Type of Feature value.
      .google.cloud.aiplatform.v1.Feature.ValueType value_type = 3 [(.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()
       Immutable. Only applicable for Vertex AI Feature Store (Legacy).
 Type of Feature value.
      .google.cloud.aiplatform.v1.Feature.ValueType value_type = 3 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getValueType in interface FeatureOrBuilder
      Returns:
      The valueType.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Only applicable for Vertex AI Feature Store (Legacy).
 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. Only applicable for Vertex AI Feature Store (Legacy).
 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. Only applicable for Vertex AI Feature Store (Legacy).
 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. Only applicable for Vertex AI Feature Store (Legacy).
 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. Only applicable for Vertex AI Feature Store (Legacy).
 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. Only applicable for Vertex AI Feature Store (Legacy).
 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

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels 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. Only applicable for Vertex AI Feature Store (Legacy).
 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. Only applicable for Vertex AI Feature Store (Legacy).
 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

    • getMonitoringStatsAnomaliesOrBuilderList

      public List<? extends Feature.MonitoringStatsAnomalyOrBuilder> getMonitoringStatsAnomaliesOrBuilderList()
       Output only. Only applicable for Vertex AI Feature Store (Legacy).
 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:
      getMonitoringStatsAnomaliesOrBuilderList in interface FeatureOrBuilder

    • getMonitoringStatsAnomaliesCount

      public int getMonitoringStatsAnomaliesCount()
       Output only. Only applicable for Vertex AI Feature Store (Legacy).
 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. Only applicable for Vertex AI Feature Store (Legacy).
 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

    • getMonitoringStatsAnomaliesOrBuilder

      public Feature.MonitoringStatsAnomalyOrBuilder getMonitoringStatsAnomaliesOrBuilder(int index)
       Output only. Only applicable for Vertex AI Feature Store (Legacy).
 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:
      getMonitoringStatsAnomaliesOrBuilder in interface FeatureOrBuilder

    • getVersionColumnName

      public String getVersionColumnName()
       Only applicable for Vertex AI Feature Store.
 The name of the BigQuery Table/View column hosting data for this version.
 If no value is provided, will use feature_id.
      string version_column_name = 106;
      Specified by:
      getVersionColumnName in interface FeatureOrBuilder
      Returns:
      The versionColumnName.

    • getVersionColumnNameBytes

      public com.google.protobuf.ByteString getVersionColumnNameBytes()
       Only applicable for Vertex AI Feature Store.
 The name of the BigQuery Table/View column hosting data for this version.
 If no value is provided, will use feature_id.
      string version_column_name = 106;
      Specified by:
      getVersionColumnNameBytes in interface FeatureOrBuilder
      Returns:
      The bytes for versionColumnName.

    • getPointOfContact

      public String getPointOfContact()
       Entity responsible for maintaining this feature. Can be comma separated
 list of email addresses or URIs.
      string point_of_contact = 107;
      Specified by:
      getPointOfContact in interface FeatureOrBuilder
      Returns:
      The pointOfContact.

    • getPointOfContactBytes

      public com.google.protobuf.ByteString getPointOfContactBytes()
       Entity responsible for maintaining this feature. Can be comma separated
 list of email addresses or URIs.
      string point_of_contact = 107;
      Specified by:
      getPointOfContactBytes in interface FeatureOrBuilder
      Returns:
      The bytes for pointOfContact.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Feature parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Feature parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static Feature.Builder newBuilder()

    • newBuilder

      public static Feature.Builder newBuilder(Feature prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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