public final class EntityType extends GeneratedMessageV3 implements EntityTypeOrBuilder
An entity type is a type of object in a system that needs to be modeled and
have stored information about. For example, driver is an entity type, and
driver0 is an instance of an entity type driver.
Protobuf type google.cloud.aiplatform.v1beta1.EntityType
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>)
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 ETAG_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 NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int OFFLINE_STORAGE_TTL_DAYS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static EntityType getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static EntityType.Builder newBuilder()
public static EntityType.Builder newBuilder(EntityType prototype)
public static EntityType parseDelimitedFrom(InputStream input)
public static EntityType parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static EntityType parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static EntityType parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static EntityType parseFrom(ByteString data)
public static EntityType parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EntityType parseFrom(CodedInputStream input)
public static EntityType parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static EntityType parseFrom(InputStream input)
public static EntityType parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static EntityType parseFrom(ByteBuffer data)
public static EntityType parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<EntityType> parser()
Methods
public 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];
| Parameter |
|---|
| Name | Description |
key | String
|
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public Timestamp getCreateTime()
Output only. Timestamp when this EntityType was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this EntityType was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public EntityType getDefaultInstanceForType()
public String getDescription()
Optional. Description of the EntityType.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
String | The description.
|
public ByteString getDescriptionBytes()
Optional. Description of the EntityType.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
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 |
|---|
| Type | Description |
String | The etag.
|
public 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 |
|---|
| Type | Description |
ByteString | The bytes for etag.
|
public Map<String,String> getLabels()
public 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];
| Returns |
|---|
| Type | Description |
int | |
public 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];
public 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];
public 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];
| Parameter |
|---|
| Name | Description |
key | String
|
public FeaturestoreMonitoringConfig getMonitoringConfig()
Optional. The default monitoring configuration for all Features with value
type
(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.v1beta1.FeaturestoreMonitoringConfig monitoring_config = 8 [(.google.api.field_behavior) = OPTIONAL];
public FeaturestoreMonitoringConfigOrBuilder getMonitoringConfigOrBuilder()
Optional. The default monitoring configuration for all Features with value
type
(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.v1beta1.FeaturestoreMonitoringConfig monitoring_config = 8 [(.google.api.field_behavior) = OPTIONAL];
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 |
|---|
| Type | Description |
String | The name.
|
public 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 |
|---|
| Type | Description |
ByteString | The bytes for name.
|
public 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 |
|---|
| Type | Description |
int | The offlineStorageTtlDays.
|
public Parser<EntityType> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public 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 |
|---|
| Type | Description |
Timestamp | The updateTime.
|
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this EntityType was most recently updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public boolean hasCreateTime()
Output only. Timestamp when this EntityType was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
public boolean hasMonitoringConfig()
Optional. The default monitoring configuration for all Features with value
type
(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.v1beta1.FeaturestoreMonitoringConfig monitoring_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the monitoringConfig field is set.
|
public 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 |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
public final boolean isInitialized()
Overrides
public EntityType.Builder newBuilderForType()
protected EntityType.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public EntityType.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
