Interface FeatureOrBuilder (2.4.0)

public interface FeatureOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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
NameDescription
keyString
Returns
TypeDescription
boolean

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Timestamp when this EntityType was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this EntityType was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDescription()

public abstract String getDescription()

Description of the Feature.

string description = 2;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Description of the Feature.

string description = 2;

Returns
TypeDescription
ByteString

The bytes for description.

getEtag()

public abstract String getEtag()

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

string etag = 7;

Returns
TypeDescription
String

The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

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

string etag = 7;

Returns
TypeDescription
ByteString

The bytes for etag.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public abstract 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
TypeDescription
int

getLabelsMap()

public abstract 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
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract 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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public abstract 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
NameDescription
keyString
Returns
TypeDescription
String

getMonitoringConfig()

public abstract FeaturestoreMonitoringConfig getMonitoringConfig()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
FeaturestoreMonitoringConfig

The monitoringConfig.

getMonitoringConfigOrBuilder()

public abstract FeaturestoreMonitoringConfigOrBuilder getMonitoringConfigOrBuilder()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
FeaturestoreMonitoringConfigOrBuilder

getMonitoringStats(int index)

public abstract FeatureStatsAnomaly getMonitoringStats(int index)

Output only. A list of historical Snapshot Analysis 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
NameDescription
indexint
Returns
TypeDescription
FeatureStatsAnomaly

getMonitoringStatsCount()

public abstract int getMonitoringStatsCount()

Output only. A list of historical Snapshot Analysis 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
TypeDescription
int

getMonitoringStatsList()

public abstract List<FeatureStatsAnomaly> getMonitoringStatsList()

Output only. A list of historical Snapshot Analysis 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
TypeDescription
List<FeatureStatsAnomaly>

getMonitoringStatsOrBuilder(int index)

public abstract FeatureStatsAnomalyOrBuilder getMonitoringStatsOrBuilder(int index)

Output only. A list of historical Snapshot Analysis 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
NameDescription
indexint
Returns
TypeDescription
FeatureStatsAnomalyOrBuilder

getMonitoringStatsOrBuilderList()

public abstract List<? extends FeatureStatsAnomalyOrBuilder> getMonitoringStatsOrBuilderList()

Output only. A list of historical Snapshot Analysis 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
TypeDescription
List<? extends com.google.cloud.aiplatform.v1beta1.FeatureStatsAnomalyOrBuilder>

getName()

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

Returns
TypeDescription
String

The name.

getNameBytes()

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

Returns
TypeDescription
ByteString

The bytes for name.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Timestamp when this EntityType was most recently updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this EntityType was most recently updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getValueType()

public abstract Feature.ValueType getValueType()

Required. Immutable. Type of Feature value.

.google.cloud.aiplatform.v1beta1.Feature.ValueType value_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
Feature.ValueType

The valueType.

getValueTypeValue()

public abstract int getValueTypeValue()

Required. Immutable. Type of Feature value.

.google.cloud.aiplatform.v1beta1.Feature.ValueType value_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
int

The enum numeric value on the wire for valueType.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Timestamp when this EntityType was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasMonitoringConfig()

public abstract boolean hasMonitoringConfig()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the monitoringConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Timestamp when this EntityType was most recently updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the updateTime field is set.