com.google.cloud.aiplatform.v1beta1

Interface FeatureOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Feature, Feature.Builder

public interface FeatureOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDescription() Description of the Feature.
com.google.protobuf.ByteString	getDescriptionBytes() Description of the Feature.
boolean	getDisableMonitoring() Optional.
String	getEtag() Used to perform a consistent read-modify-write updates.
com.google.protobuf.ByteString	getEtagBytes() Used to perform a consistent read-modify-write updates.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
FeaturestoreMonitoringConfig	getMonitoringConfig() Deprecated. google.cloud.aiplatform.v1beta1.Feature.monitoring_config is deprecated. See google/cloud/aiplatform/v1beta1/feature.proto;l=167
FeaturestoreMonitoringConfigOrBuilder	getMonitoringConfigOrBuilder() Deprecated.
FeatureStatsAnomaly	getMonitoringStats(int index) Output only.
Feature.MonitoringStatsAnomaly	getMonitoringStatsAnomalies(int index) Output only.
int	getMonitoringStatsAnomaliesCount() Output only.
List<Feature.MonitoringStatsAnomaly>	getMonitoringStatsAnomaliesList() Output only.
Feature.MonitoringStatsAnomalyOrBuilder	getMonitoringStatsAnomaliesOrBuilder(int index) Output only.
List<? extends Feature.MonitoringStatsAnomalyOrBuilder>	getMonitoringStatsAnomaliesOrBuilderList() Output only.
int	getMonitoringStatsCount() Output only.
List<FeatureStatsAnomaly>	getMonitoringStatsList() Output only.
FeatureStatsAnomalyOrBuilder	getMonitoringStatsOrBuilder(int index) Output only.
List<? extends FeatureStatsAnomalyOrBuilder>	getMonitoringStatsOrBuilderList() Output only.
String	getName() Immutable.
com.google.protobuf.ByteString	getNameBytes() Immutable.
String	getPointOfContact() Entity responsible for maintaining this feature.
com.google.protobuf.ByteString	getPointOfContactBytes() Entity responsible for maintaining this feature.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
Feature.ValueType	getValueType() Immutable.
int	getValueTypeValue() Immutable.
String	getVersionColumnName() Only applicable for Vertex AI Feature Store.
com.google.protobuf.ByteString	getVersionColumnNameBytes() Only applicable for Vertex AI Feature Store.
boolean	hasCreateTime() Output only.
boolean	hasMonitoringConfig() Deprecated. google.cloud.aiplatform.v1beta1.Feature.monitoring_config is deprecated. See google/cloud/aiplatform/v1beta1/feature.proto;l=167
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

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

Returns:

The bytes for name.

getDescription

String getDescription()

 Description of the Feature.
 

string description = 2;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 Description of the Feature.
 

string description = 2;

Returns:

The bytes for description.

getValueTypeValue

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:

The enum numeric value on the wire for valueType.

getValueType

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

Returns:

The valueType.

hasCreateTime

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:

Whether the createTime field is set.

getCreateTime

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

Returns:

The createTime.

getCreateTimeOrBuilder

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

hasUpdateTime

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:

Whether the updateTime field is set.

getUpdateTime

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

Returns:

The updateTime.

getUpdateTimeOrBuilder

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

getLabelsCount

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

containsLabels

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

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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

getLabelsOrDefault

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

getLabelsOrThrow

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

getEtag

String getEtag()

 Used to perform a consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
 

string etag = 7;

Returns:

The etag.

getEtagBytes

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;

Returns:

The bytes for etag.

hasMonitoringConfig

@Deprecated
boolean hasMonitoringConfig()

Deprecated. google.cloud.aiplatform.v1beta1.Feature.monitoring_config is deprecated. See google/cloud/aiplatform/v1beta1/feature.proto;l=167

 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][google.cloud.aiplatform.v1beta1.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:

Whether the monitoringConfig field is set.

getMonitoringConfig

@Deprecated
FeaturestoreMonitoringConfig getMonitoringConfig()

Deprecated. google.cloud.aiplatform.v1beta1.Feature.monitoring_config is deprecated. See google/cloud/aiplatform/v1beta1/feature.proto;l=167

 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][google.cloud.aiplatform.v1beta1.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:

The monitoringConfig.

getMonitoringConfigOrBuilder

@Deprecated
FeaturestoreMonitoringConfigOrBuilder getMonitoringConfigOrBuilder()

Deprecated.

 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][google.cloud.aiplatform.v1beta1.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];

getDisableMonitoring

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.v1beta1.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:

The disableMonitoring.

getMonitoringStatsList

List<FeatureStatsAnomaly> getMonitoringStatsList()

 Output only. Only applicable for Vertex AI Feature Store (Legacy).
 A list of historical
 [SnapshotAnalysis][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis]
 stats requested by user, sorted by
 [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly.start_time]
 descending.
 

repeated .google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly monitoring_stats = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

getMonitoringStats

FeatureStatsAnomaly getMonitoringStats(int index)

 Output only. Only applicable for Vertex AI Feature Store (Legacy).
 A list of historical
 [SnapshotAnalysis][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis]
 stats requested by user, sorted by
 [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly.start_time]
 descending.
 

repeated .google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly monitoring_stats = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

getMonitoringStatsCount

int getMonitoringStatsCount()

 Output only. Only applicable for Vertex AI Feature Store (Legacy).
 A list of historical
 [SnapshotAnalysis][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis]
 stats requested by user, sorted by
 [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly.start_time]
 descending.
 

repeated .google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly monitoring_stats = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

getMonitoringStatsOrBuilderList

List<? extends FeatureStatsAnomalyOrBuilder> getMonitoringStatsOrBuilderList()

 Output only. Only applicable for Vertex AI Feature Store (Legacy).
 A list of historical
 [SnapshotAnalysis][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis]
 stats requested by user, sorted by
 [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly.start_time]
 descending.
 

repeated .google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly monitoring_stats = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

getMonitoringStatsOrBuilder

FeatureStatsAnomalyOrBuilder getMonitoringStatsOrBuilder(int index)

 Output only. Only applicable for Vertex AI Feature Store (Legacy).
 A list of historical
 [SnapshotAnalysis][google.cloud.aiplatform.v1beta1.FeaturestoreMonitoringConfig.SnapshotAnalysis]
 stats requested by user, sorted by
 [FeatureStatsAnomaly.start_time][google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly.start_time]
 descending.
 

repeated .google.cloud.aiplatform.v1beta1.FeatureStatsAnomaly monitoring_stats = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

getMonitoringStatsAnomaliesList

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

getMonitoringStatsAnomalies

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

getMonitoringStatsAnomaliesCount

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

getMonitoringStatsAnomaliesOrBuilderList

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

getMonitoringStatsAnomaliesOrBuilder

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

getVersionColumnName

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:

The versionColumnName.

getVersionColumnNameBytes

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;

Returns:

The bytes for versionColumnName.

getPointOfContact

String getPointOfContact()

 Entity responsible for maintaining this feature. Can be comma separated
 list of email addresses or URIs.
 

string point_of_contact = 107;

Returns:

The pointOfContact.

getPointOfContactBytes

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;

Returns:

The bytes for pointOfContact.