Package com.google.cloud.aiplatform.v1

Class Featurestore

  • All Implemented Interfaces:
    FeaturestoreOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Featurestore
extends com.google.protobuf.GeneratedMessageV3
implements FeaturestoreOrBuilder
     Vertex AI Feature Store provides a centralized repository for organizing,
 storing, and serving ML features. The Featurestore is a top-level container
 for your features and their values.
    Protobuf type google.cloud.aiplatform.v1.Featurestore
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         Output only. Name of the Featurestore. Format:
 `projects/{project}/locations/{location}/featurestores/{featurestore}`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface FeaturestoreOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. Name of the Featurestore. Format:
 `projects/{project}/locations/{location}/featurestores/{featurestore}`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface FeaturestoreOrBuilder
        Returns:
        The bytes for name.

      • hasCreateTime

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

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Timestamp when this Featurestore was created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface FeaturestoreOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp when this Featurestore was created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface FeaturestoreOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Timestamp when this Featurestore was last updated.
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface FeaturestoreOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. Timestamp when this Featurestore was last updated.
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface FeaturestoreOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Timestamp when this Featurestore was last updated.
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface FeaturestoreOrBuilder

      • getEtag

        public String getEtag()
         Optional. Used to perform consistent read-modify-write updates. If not set,
 a blind "overwrite" update happens.
        string etag = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEtag in interface FeaturestoreOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         Optional. Used to perform consistent read-modify-write updates. If not set,
 a blind "overwrite" update happens.
        string etag = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEtagBytes in interface FeaturestoreOrBuilder
        Returns:
        The bytes for etag.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: FeaturestoreOrBuilder
         Optional. The labels with user-defined metadata to organize your
 Featurestore.

 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 Featurestore(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 FeaturestoreOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Optional. The labels with user-defined metadata to organize your
 Featurestore.

 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 Featurestore(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 FeaturestoreOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Optional. The labels with user-defined metadata to organize your
 Featurestore.

 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 Featurestore(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 FeaturestoreOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         Optional. The labels with user-defined metadata to organize your
 Featurestore.

 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 Featurestore(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 FeaturestoreOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Optional. The labels with user-defined metadata to organize your
 Featurestore.

 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 Featurestore(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 FeaturestoreOrBuilder

      • hasOnlineServingConfig

        public boolean hasOnlineServingConfig()
         Optional. Config for online storage resources. The field should not
 co-exist with the field of `OnlineStoreReplicationConfig`. If both of it
 and OnlineStoreReplicationConfig are unset, the feature store will not have
 an online store and cannot be used for online serving.
        .google.cloud.aiplatform.v1.Featurestore.OnlineServingConfig online_serving_config = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasOnlineServingConfig in interface FeaturestoreOrBuilder
        Returns:
        Whether the onlineServingConfig field is set.

      • getOnlineServingConfig

        public Featurestore.OnlineServingConfig getOnlineServingConfig()
         Optional. Config for online storage resources. The field should not
 co-exist with the field of `OnlineStoreReplicationConfig`. If both of it
 and OnlineStoreReplicationConfig are unset, the feature store will not have
 an online store and cannot be used for online serving.
        .google.cloud.aiplatform.v1.Featurestore.OnlineServingConfig online_serving_config = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getOnlineServingConfig in interface FeaturestoreOrBuilder
        Returns:
        The onlineServingConfig.

      • getOnlineServingConfigOrBuilder

        public Featurestore.OnlineServingConfigOrBuilder getOnlineServingConfigOrBuilder()
         Optional. Config for online storage resources. The field should not
 co-exist with the field of `OnlineStoreReplicationConfig`. If both of it
 and OnlineStoreReplicationConfig are unset, the feature store will not have
 an online store and cannot be used for online serving.
        .google.cloud.aiplatform.v1.Featurestore.OnlineServingConfig online_serving_config = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getOnlineServingConfigOrBuilder in interface FeaturestoreOrBuilder

      • getStateValue

        public int getStateValue()
         Output only. State of the featurestore.
        .google.cloud.aiplatform.v1.Featurestore.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface FeaturestoreOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Featurestore.State getState()
         Output only. State of the featurestore.
        .google.cloud.aiplatform.v1.Featurestore.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface FeaturestoreOrBuilder
        Returns:
        The state.

      • getOnlineStorageTtlDays

        public int getOnlineStorageTtlDays()
         Optional. TTL in days for feature values that will be stored in online
 serving storage. The Feature Store online storage periodically removes
 obsolete feature values older than `online_storage_ttl_days` since the
 feature generation time. Note that `online_storage_ttl_days` should be less
 than or equal to `offline_storage_ttl_days` for each EntityType under a
 featurestore. If not set, default to 4000 days
        int32 online_storage_ttl_days = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getOnlineStorageTtlDays in interface FeaturestoreOrBuilder
        Returns:
        The onlineStorageTtlDays.

      • hasEncryptionSpec

        public boolean hasEncryptionSpec()
         Optional. Customer-managed encryption key spec for data storage. If set,
 both of the online and offline data storage will be secured by this key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasEncryptionSpec in interface FeaturestoreOrBuilder
        Returns:
        Whether the encryptionSpec field is set.

      • getEncryptionSpec

        public EncryptionSpec getEncryptionSpec()
         Optional. Customer-managed encryption key spec for data storage. If set,
 both of the online and offline data storage will be secured by this key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEncryptionSpec in interface FeaturestoreOrBuilder
        Returns:
        The encryptionSpec.

      • getEncryptionSpecOrBuilder

        public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
         Optional. Customer-managed encryption key spec for data storage. If set,
 both of the online and offline data storage will be secured by this key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEncryptionSpecOrBuilder in interface FeaturestoreOrBuilder

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 Featurestore parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Featurestore.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Featurestore getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Featurestore> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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