Package com.google.cloud.aiplatform.v1

Class EntityType

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.EntityType
All Implemented Interfaces:
EntityTypeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class EntityType extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • ETAG_FIELD_NUMBER

      public static final int ETAG_FIELD_NUMBER
      See Also:

    • MONITORING_CONFIG_FIELD_NUMBER

      public static final int MONITORING_CONFIG_FIELD_NUMBER
      See Also:

    • OFFLINE_STORAGE_TTL_DAYS_FIELD_NUMBER

      public static final int OFFLINE_STORAGE_TTL_DAYS_FIELD_NUMBER
      See Also:

    • SATISFIES_PZS_FIELD_NUMBER

      public static final int SATISFIES_PZS_FIELD_NUMBER
      See Also:

    • SATISFIES_PZI_FIELD_NUMBER

      public static final int SATISFIES_PZI_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public 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];
      Specified by:
      getName in interface EntityTypeOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface EntityTypeOrBuilder
      Returns:
      The bytes for name.

    • getDescription

      public String getDescription()
       Optional. Description of the EntityType.
      string description = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface EntityTypeOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description of the EntityType.
      string description = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface EntityTypeOrBuilder
      Returns:
      The bytes for description.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Timestamp when this EntityType was created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface EntityTypeOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public 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];
      Specified by:
      getCreateTime in interface EntityTypeOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public 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];
      Specified by:
      getCreateTimeOrBuilder in interface EntityTypeOrBuilder

    • hasUpdateTime

      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];
      Specified by:
      hasUpdateTime in interface EntityTypeOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public 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];
      Specified by:
      getUpdateTime in interface EntityTypeOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public 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];
      Specified by:
      getUpdateTimeOrBuilder in interface EntityTypeOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: EntityTypeOrBuilder
       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];
      Specified by:
      getLabelsCount in interface EntityTypeOrBuilder

    • containsLabels

      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];
      Specified by:
      containsLabels in interface EntityTypeOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface EntityTypeOrBuilder

    • getLabelsMap

      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];
      Specified by:
      getLabelsMap in interface EntityTypeOrBuilder

    • getLabelsOrDefault

      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];
      Specified by:
      getLabelsOrDefault in interface EntityTypeOrBuilder

    • getLabelsOrThrow

      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];
      Specified by:
      getLabelsOrThrow in interface EntityTypeOrBuilder

    • getEtag

      public 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];
      Specified by:
      getEtag in interface EntityTypeOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public 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];
      Specified by:
      getEtagBytes in interface EntityTypeOrBuilder
      Returns:
      The bytes for etag.

    • hasMonitoringConfig

      public 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];
      Specified by:
      hasMonitoringConfig in interface EntityTypeOrBuilder
      Returns:
      Whether the monitoringConfig field is set.

    • getMonitoringConfig

      public 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];
      Specified by:
      getMonitoringConfig in interface EntityTypeOrBuilder
      Returns:
      The monitoringConfig.

    • getMonitoringConfigOrBuilder

      public 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];
      Specified by:
      getMonitoringConfigOrBuilder in interface EntityTypeOrBuilder

    • getOfflineStorageTtlDays

      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];
      Specified by:
      getOfflineStorageTtlDays in interface EntityTypeOrBuilder
      Returns:
      The offlineStorageTtlDays.

    • getSatisfiesPzs

      public boolean getSatisfiesPzs()
       Output only. Reserved for future use.
      bool satisfies_pzs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzs in interface EntityTypeOrBuilder
      Returns:
      The satisfiesPzs.

    • getSatisfiesPzi

      public boolean getSatisfiesPzi()
       Output only. Reserved for future use.
      bool satisfies_pzi = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzi in interface EntityTypeOrBuilder
      Returns:
      The satisfiesPzi.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static EntityType parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EntityType parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EntityType parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EntityType parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EntityType parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EntityType parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EntityType parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EntityType parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static EntityType parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static EntityType parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EntityType parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EntityType parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public EntityType.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static EntityType.Builder newBuilder()

    • newBuilder

      public static EntityType.Builder newBuilder(EntityType prototype)

    • toBuilder

      public EntityType.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected EntityType.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static EntityType getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<EntityType> parser()

    • getParserForType

      public com.google.protobuf.Parser<EntityType> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public EntityType getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder