Package com.google.cloud.aiplatform.v1

Interface EntityTypeOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

EntityType, EntityType.Builder

@Generated
public interface EntityTypeOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
boolean	containsLabels(String key)	Optional.
com.google.protobuf.Timestamp	getCreateTime()	Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder()	Output only.
String	getDescription()	Optional.
com.google.protobuf.ByteString	getDescriptionBytes()	Optional.
String	getEtag()	Optional.
com.google.protobuf.ByteString	getEtagBytes()	Optional.
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()	Optional.
FeaturestoreMonitoringConfigOrBuilder	getMonitoringConfigOrBuilder()	Optional.
String	getName()	Immutable.
com.google.protobuf.ByteString	getNameBytes()	Immutable.
int	getOfflineStorageTtlDays()	Optional.
boolean	getSatisfiesPzi()	Output only.
boolean	getSatisfiesPzs()	Output only.
com.google.protobuf.Timestamp	getUpdateTime()	Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder()	Output only.
boolean	hasCreateTime()	Output only.
boolean	hasMonitoringConfig()	Optional.
boolean	hasUpdateTime()	Output only.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Details

getName

String getName()

 Immutable. Name of the EntityType.
 Format:
 `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`

 The last part entity_type is assigned by the client. The entity_type can be
 up to 64 characters long and can consist only of ASCII Latin letters A-Z
 and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The
 value will be unique given a featurestore.
 

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Immutable. Name of the EntityType.
 Format:
 `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`

 The last part entity_type is assigned by the client. The entity_type can be
 up to 64 characters long and can consist only of ASCII Latin letters A-Z
 and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The
 value will be unique given a featurestore.
 

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The bytes for name.

getDescription

String getDescription()

 Optional. Description of the EntityType.
 

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 Optional. Description of the EntityType.
 

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for description.

hasCreateTime

boolean hasCreateTime()

 Output only. Timestamp when this EntityType was created.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Timestamp when this EntityType was created.
 

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

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp when this EntityType was created.
 

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

hasUpdateTime

boolean hasUpdateTime()

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

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

Returns:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.Timestamp getUpdateTime()

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

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

Returns:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

getLabelsCount

int getLabelsCount()

 Optional. The labels with user-defined metadata to organize your
 EntityTypes.

 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 EntityType (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
 EntityTypes.

 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 EntityType (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
 EntityTypes.

 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 EntityType (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
 EntityTypes.

 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 EntityType (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
 EntityTypes.

 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 EntityType (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()

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

string etag = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The etag.

getEtagBytes

com.google.protobuf.ByteString getEtagBytes()

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

string etag = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for etag.

hasMonitoringConfig

boolean hasMonitoringConfig()

 Optional. The default monitoring configuration for all Features with value
 type
 ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL,
 STRING, DOUBLE or INT64 under this EntityType.

 If this is populated with
 [FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot
 analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is
 disabled.
 

.google.cloud.aiplatform.v1.FeaturestoreMonitoringConfig monitoring_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the monitoringConfig field is set.

getMonitoringConfig

FeaturestoreMonitoringConfig getMonitoringConfig()

 Optional. The default monitoring configuration for all Features with value
 type
 ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL,
 STRING, DOUBLE or INT64 under this EntityType.

 If this is populated with
 [FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot
 analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is
 disabled.
 

.google.cloud.aiplatform.v1.FeaturestoreMonitoringConfig monitoring_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The monitoringConfig.

getMonitoringConfigOrBuilder

FeaturestoreMonitoringConfigOrBuilder getMonitoringConfigOrBuilder()

 Optional. The default monitoring configuration for all Features with value
 type
 ([Feature.ValueType][google.cloud.aiplatform.v1.Feature.ValueType]) BOOL,
 STRING, DOUBLE or INT64 under this EntityType.

 If this is populated with
 [FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot
 analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is
 disabled.
 

.google.cloud.aiplatform.v1.FeaturestoreMonitoringConfig monitoring_config = 8 [(.google.api.field_behavior) = OPTIONAL];

getOfflineStorageTtlDays

int getOfflineStorageTtlDays()

 Optional. Config for data retention policy in offline storage.
 TTL in days for feature values that will be stored in offline storage.
 The Feature Store offline storage periodically removes obsolete feature
 values older than `offline_storage_ttl_days` since the feature generation
 time. If unset (or explicitly set to 0), default to 4000 days TTL.
 

int32 offline_storage_ttl_days = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The offlineStorageTtlDays.

getSatisfiesPzs

boolean getSatisfiesPzs()

 Output only. Reserved for future use.
 

bool satisfies_pzs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The satisfiesPzs.

getSatisfiesPzi

boolean getSatisfiesPzi()

 Output only. Reserved for future use.
 

bool satisfies_pzi = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The satisfiesPzi.