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.v1.EntityType
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
public static final int ETAG_FIELD_NUMBER
Field Value
public static final int LABELS_FIELD_NUMBER
Field Value
public static final int MONITORING_CONFIG_FIELD_NUMBER
Field Value
public static final int NAME_FIELD_NUMBER
Field Value
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
public static EntityType getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static EntityType.Builder newBuilder()
Returns
public static EntityType.Builder newBuilder(EntityType prototype)
Parameter
Returns
public static EntityType parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static EntityType parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static EntityType parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
public static EntityType parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static EntityType parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static EntityType parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static EntityType parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static EntityType parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static EntityType parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static EntityType parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static EntityType parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static EntityType parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<EntityType> parser()
Returns
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
Returns
public boolean equals(Object obj)
Parameter
Returns
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
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this EntityType was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
public EntityType getDefaultInstanceForType()
Returns
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
public Map<String,String> getLabels()
Returns
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
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];
Returns
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];
Parameters
Returns
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
Returns
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.v1.FeaturestoreMonitoringConfig monitoring_config = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns
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.v1.FeaturestoreMonitoringConfig monitoring_config = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns
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
public Parser<EntityType> getParserForType()
Returns
Overrides
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
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
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];
Returns
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.v1.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
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public EntityType.Builder newBuilderForType()
Returns
protected EntityType.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public EntityType.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions