Class Feature (3.52.0)

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.v1.Feature

Implements

FeatureOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISABLE_MONITORING_FIELD_NUMBER

public static final int DISABLE_MONITORING_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

MONITORING_STATS_ANOMALIES_FIELD_NUMBER

public static final int MONITORING_STATS_ANOMALIES_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

POINT_OF_CONTACT_FIELD_NUMBER

public static final int POINT_OF_CONTACT_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

VALUE_TYPE_FIELD_NUMBER

public static final int VALUE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

VERSION_COLUMN_NAME_FIELD_NUMBER

public static final int VERSION_COLUMN_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Feature getDefaultInstance()
Returns
Type Description
Feature

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Feature.Builder newBuilder()
Returns
Type Description
Feature.Builder

newBuilder(Feature prototype)

public static Feature.Builder newBuilder(Feature prototype)
Parameter
Name Description
prototype Feature
Returns
Type Description
Feature.Builder

parseDelimitedFrom(InputStream input)

public static Feature parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Feature
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Feature parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Feature
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Feature parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Feature
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Feature parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Feature
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Feature parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Feature
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Feature parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Feature
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Feature parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Feature
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Feature parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Feature
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Feature parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Feature
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Feature parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Feature
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Feature parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Feature
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Feature parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Feature
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Feature> parser()
Returns
Type Description
Parser<Feature>

Methods

containsLabels(String key)

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
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

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.

getCreateTimeOrBuilder()

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];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Feature getDefaultInstanceForType()
Returns
Type Description
Feature

getDescription()

public String getDescription()

Description of the Feature.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the Feature.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

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) 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.

getEtag()

public String getEtag()

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.

getEtagBytes()

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.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

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

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];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

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];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

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

getMonitoringStatsAnomalies(int index)

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];

Parameter
Name Description
index int
Returns
Type Description
Feature.MonitoringStatsAnomaly

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];

Returns
Type Description
int

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];

Returns
Type Description
List<MonitoringStatsAnomaly>

getMonitoringStatsAnomaliesOrBuilder(int index)

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];

Parameter
Name Description
index int
Returns
Type Description
Feature.MonitoringStatsAnomalyOrBuilder

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];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.Feature.MonitoringStatsAnomalyOrBuilder>

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];

Returns
Type Description
String

The name.

getNameBytes()

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.

getParserForType()

public Parser<Feature> getParserForType()
Returns
Type Description
Parser<Feature>
Overrides

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;

Returns
Type Description
String

The pointOfContact.

getPointOfContactBytes()

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

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.

getUpdateTimeOrBuilder()

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];

Returns
Type Description
TimestampOrBuilder

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];

Returns
Type Description
Feature.ValueType

The valueType.

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];

Returns
Type Description
int

The enum numeric value on the wire for valueType.

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;

Returns
Type Description
String

The versionColumnName.

getVersionColumnNameBytes()

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.

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];

Returns
Type Description
boolean

Whether the createTime field is set.

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];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Feature.Builder newBuilderForType()
Returns
Type Description
Feature.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Feature.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Feature.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Feature.Builder toBuilder()
Returns
Type Description
Feature.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException