public final class Feature extends GeneratedMessageV3 implements FeatureOrBuilder
Feature Metadata information.
For example, color is a feature that describes an apple.
Protobuf type google.cloud.aiplatform.v1beta1.Feature
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DISABLE_MONITORING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FEATURE_STATS_AND_ANOMALY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MONITORING_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MONITORING_STATS_ANOMALIES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MONITORING_STATS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int POINT_OF_CONTACT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int VALUE_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int VERSION_COLUMN_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static Feature getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static Feature.Builder newBuilder()
public static Feature.Builder newBuilder(Feature prototype)
| Parameter |
| Name |
Description |
prototype |
Feature
|
public static Feature parseDelimitedFrom(InputStream input)
public static Feature parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Feature parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static Feature parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Feature parseFrom(ByteString data)
public static Feature parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Feature parseFrom(CodedInputStream input)
public static Feature parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Feature parseFrom(InputStream input)
public static Feature parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Feature parseFrom(ByteBuffer data)
public static Feature parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<Feature> parser()
Methods
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];
| Parameter |
| Name |
Description |
key |
String
|
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public 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];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
public 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];
public Feature getDefaultInstanceForType()
public String getDescription()
Description of the Feature.
string description = 2;
| Returns |
| Type |
Description |
String |
The description.
|
public ByteString getDescriptionBytes()
Description of the Feature.
string description = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
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)
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];
| Returns |
| Type |
Description |
boolean |
The disableMonitoring.
|
Used to perform a consistent read-modify-write updates. If not set, a blind
"overwrite" update happens.
string etag = 7;
| Returns |
| Type |
Description |
String |
The etag.
|
public ByteString getEtagBytes()
Used to perform a consistent read-modify-write updates. If not set, a blind
"overwrite" update happens.
string etag = 7;
| Returns |
| Type |
Description |
ByteString |
The bytes for etag.
|
public FeatureStatsAndAnomaly getFeatureStatsAndAnomaly(int index)
Output only. Only applicable for Vertex AI Feature Store.
The list of historical stats and anomalies.
repeated .google.cloud.aiplatform.v1beta1.FeatureStatsAndAnomaly feature_stats_and_anomaly = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
public int getFeatureStatsAndAnomalyCount()
Output only. Only applicable for Vertex AI Feature Store.
The list of historical stats and anomalies.
repeated .google.cloud.aiplatform.v1beta1.FeatureStatsAndAnomaly feature_stats_and_anomaly = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
|
public List<FeatureStatsAndAnomaly> getFeatureStatsAndAnomalyList()
Output only. Only applicable for Vertex AI Feature Store.
The list of historical stats and anomalies.
repeated .google.cloud.aiplatform.v1beta1.FeatureStatsAndAnomaly feature_stats_and_anomaly = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
public FeatureStatsAndAnomalyOrBuilder getFeatureStatsAndAnomalyOrBuilder(int index)
Output only. Only applicable for Vertex AI Feature Store.
The list of historical stats and anomalies.
repeated .google.cloud.aiplatform.v1beta1.FeatureStatsAndAnomaly feature_stats_and_anomaly = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
public List<? extends FeatureStatsAndAnomalyOrBuilder> getFeatureStatsAndAnomalyOrBuilderList()
Output only. Only applicable for Vertex AI Feature Store.
The list of historical stats and anomalies.
repeated .google.cloud.aiplatform.v1beta1.FeatureStatsAndAnomaly feature_stats_and_anomaly = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.aiplatform.v1beta1.FeatureStatsAndAnomalyOrBuilder> |
|
public Map<String,String> getLabels()
public int getLabelsCount()
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];
| Returns |
| Type |
Description |
int |
|
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];
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];
| Returns |
| Type |
Description |
String |
|
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];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
public FeaturestoreMonitoringConfig getMonitoringConfig()
Deprecated. google.cloud.aiplatform.v1beta1.Feature.monitoring_config is deprecated. See
google/cloud/aiplatform/v1beta1/feature.proto;l=171
Optional. Only applicable for Vertex AI Feature Store (Legacy).
Deprecated: The custom monitoring configuration for this Feature, if not
set, use the monitoring_config defined for the EntityType this Feature
belongs to.
Only Features with type
(Feature.ValueType)
BOOL, STRING, DOUBLE or INT64 can enable monitoring.
If this is populated with
[FeaturestoreMonitoringConfig.disabled][] = true, snapshot analysis
monitoring is disabled; if
[FeaturestoreMonitoringConfig.monitoring_interval][] specified, snapshot
analysis monitoring is enabled. Otherwise, snapshot analysis monitoring
config is same as the EntityType's this Feature belongs to.
.google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig monitoring_config = 9 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
public FeaturestoreMonitoringConfigOrBuilder getMonitoringConfigOrBuilder()
Optional. Only applicable for Vertex AI Feature Store (Legacy).
Deprecated: The custom monitoring configuration for this Feature, if not
set, use the monitoring_config defined for the EntityType this Feature
belongs to.
Only Features with type
(Feature.ValueType)
BOOL, STRING, DOUBLE or INT64 can enable monitoring.
If this is populated with
[FeaturestoreMonitoringConfig.disabled][] = true, snapshot analysis
monitoring is disabled; if
[FeaturestoreMonitoringConfig.monitoring_interval][] specified, snapshot
analysis monitoring is enabled. Otherwise, snapshot analysis monitoring
config is same as the EntityType's this Feature belongs to.
.google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig monitoring_config = 9 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
public FeatureStatsAnomaly getMonitoringStats(int index)
Output only. Only applicable for Vertex AI Feature Store (Legacy).
A list of historical
SnapshotAnalysis
stats requested by user, sorted by
FeatureStatsAnomaly.start_time
descending.
repeated .google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly monitoring_stats = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
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.v1beta1.Feature.MonitoringStatsAnomaly monitoring_stats_anomalies = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
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.v1beta1.Feature.MonitoringStatsAnomaly monitoring_stats_anomalies = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
|
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.v1beta1.Feature.MonitoringStatsAnomaly monitoring_stats_anomalies = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.v1beta1.Feature.MonitoringStatsAnomaly monitoring_stats_anomalies = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
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.v1beta1.Feature.MonitoringStatsAnomaly monitoring_stats_anomalies = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.aiplatform.v1beta1.Feature.MonitoringStatsAnomalyOrBuilder> |
|
public int getMonitoringStatsCount()
Output only. Only applicable for Vertex AI Feature Store (Legacy).
A list of historical
SnapshotAnalysis
stats requested by user, sorted by
FeatureStatsAnomaly.start_time
descending.
repeated .google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly monitoring_stats = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
|
public List<FeatureStatsAnomaly> getMonitoringStatsList()
Output only. Only applicable for Vertex AI Feature Store (Legacy).
A list of historical
SnapshotAnalysis
stats requested by user, sorted by
FeatureStatsAnomaly.start_time
descending.
repeated .google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly monitoring_stats = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public FeatureStatsAnomalyOrBuilder getMonitoringStatsOrBuilder(int index)
Output only. Only applicable for Vertex AI Feature Store (Legacy).
A list of historical
SnapshotAnalysis
stats requested by user, sorted by
FeatureStatsAnomaly.start_time
descending.
repeated .google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly monitoring_stats = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
public List<? extends FeatureStatsAnomalyOrBuilder> getMonitoringStatsOrBuilderList()
Output only. Only applicable for Vertex AI Feature Store (Legacy).
A list of historical
SnapshotAnalysis
stats requested by user, sorted by
FeatureStatsAnomaly.start_time
descending.
repeated .google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly monitoring_stats = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.aiplatform.v1beta1.FeatureStatsAnomalyOrBuilder> |
|
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];
| Returns |
| Type |
Description |
String |
The name.
|
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
public Parser<Feature> getParserForType()
Overrides
public String getPointOfContact()
Entity responsible for maintaining this feature. Can be comma separated
list of email addresses or URIs.
string point_of_contact = 107;
| Returns |
| Type |
Description |
String |
The pointOfContact.
|
public ByteString getPointOfContactBytes()
Entity responsible for maintaining this feature. Can be comma separated
list of email addresses or URIs.
string point_of_contact = 107;
| Returns |
| Type |
Description |
ByteString |
The bytes for pointOfContact.
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public 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];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
public 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];
public Feature.ValueType getValueType()
Immutable. Only applicable for Vertex AI Feature Store (Legacy).
Type of Feature value.
.google.cloud.aiplatform.v1beta1.Feature.ValueType value_type = 3 [(.google.api.field_behavior) = IMMUTABLE];
public int getValueTypeValue()
Immutable. Only applicable for Vertex AI Feature Store (Legacy).
Type of Feature value.
.google.cloud.aiplatform.v1beta1.Feature.ValueType value_type = 3 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for valueType.
|
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;
| Returns |
| Type |
Description |
String |
The versionColumnName.
|
public 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;
| Returns |
| Type |
Description |
ByteString |
The bytes for versionColumnName.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
public boolean hasMonitoringConfig()
Deprecated. google.cloud.aiplatform.v1beta1.Feature.monitoring_config is deprecated. See
google/cloud/aiplatform/v1beta1/feature.proto;l=171
Optional. Only applicable for Vertex AI Feature Store (Legacy).
Deprecated: The custom monitoring configuration for this Feature, if not
set, use the monitoring_config defined for the EntityType this Feature
belongs to.
Only Features with type
(Feature.ValueType)
BOOL, STRING, DOUBLE or INT64 can enable monitoring.
If this is populated with
[FeaturestoreMonitoringConfig.disabled][] = true, snapshot analysis
monitoring is disabled; if
[FeaturestoreMonitoringConfig.monitoring_interval][] specified, snapshot
analysis monitoring is enabled. Otherwise, snapshot analysis monitoring
config is same as the EntityType's this Feature belongs to.
.google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig monitoring_config = 9 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the monitoringConfig field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public Feature.Builder newBuilderForType()
protected Feature.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public Feature.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
