Package com.google.cloud.aiplatform.v1

Class FeatureOnlineStore

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.FeatureOnlineStore
All Implemented Interfaces:
FeatureOnlineStoreOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class FeatureOnlineStore extends com.google.protobuf.GeneratedMessage implements FeatureOnlineStoreOrBuilder
 Vertex AI Feature Online Store provides a centralized repository for serving
 ML features and embedding indexes at low latency. The Feature Online Store is
 a top-level container.
Protobuf type google.cloud.aiplatform.v1.FeatureOnlineStore
See Also:

  • Field Details

    • BIGTABLE_FIELD_NUMBER

      public static final int BIGTABLE_FIELD_NUMBER
      See Also:

    • OPTIMIZED_FIELD_NUMBER

      public static final int OPTIMIZED_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_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:

    • ETAG_FIELD_NUMBER

      public static final int ETAG_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • DEDICATED_SERVING_ENDPOINT_FIELD_NUMBER

      public static final int DEDICATED_SERVING_ENDPOINT_FIELD_NUMBER
      See Also:

    • ENCRYPTION_SPEC_FIELD_NUMBER

      public static final int ENCRYPTION_SPEC_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

    • getStorageTypeCase

      public FeatureOnlineStore.StorageTypeCase getStorageTypeCase()
      Specified by:
      getStorageTypeCase in interface FeatureOnlineStoreOrBuilder

    • hasBigtable

      public boolean hasBigtable()
       Contains settings for the Cloud Bigtable instance that will be created
 to serve featureValues for all FeatureViews under this
 FeatureOnlineStore.
      .google.cloud.aiplatform.v1.FeatureOnlineStore.Bigtable bigtable = 8;
      Specified by:
      hasBigtable in interface FeatureOnlineStoreOrBuilder
      Returns:
      Whether the bigtable field is set.

    • getBigtable

      public FeatureOnlineStore.Bigtable getBigtable()
       Contains settings for the Cloud Bigtable instance that will be created
 to serve featureValues for all FeatureViews under this
 FeatureOnlineStore.
      .google.cloud.aiplatform.v1.FeatureOnlineStore.Bigtable bigtable = 8;
      Specified by:
      getBigtable in interface FeatureOnlineStoreOrBuilder
      Returns:
      The bigtable.

    • getBigtableOrBuilder

      public FeatureOnlineStore.BigtableOrBuilder getBigtableOrBuilder()
       Contains settings for the Cloud Bigtable instance that will be created
 to serve featureValues for all FeatureViews under this
 FeatureOnlineStore.
      .google.cloud.aiplatform.v1.FeatureOnlineStore.Bigtable bigtable = 8;
      Specified by:
      getBigtableOrBuilder in interface FeatureOnlineStoreOrBuilder

    • hasOptimized

      public boolean hasOptimized()
       Contains settings for the Optimized store that will be created
 to serve featureValues for all FeatureViews under this
 FeatureOnlineStore. When choose Optimized storage type, need to set
 [PrivateServiceConnectConfig.enable_private_service_connect][google.cloud.aiplatform.v1.PrivateServiceConnectConfig.enable_private_service_connect]
 to use private endpoint. Otherwise will use public endpoint by default.
      .google.cloud.aiplatform.v1.FeatureOnlineStore.Optimized optimized = 12;
      Specified by:
      hasOptimized in interface FeatureOnlineStoreOrBuilder
      Returns:
      Whether the optimized field is set.

    • getOptimized

      public FeatureOnlineStore.Optimized getOptimized()
       Contains settings for the Optimized store that will be created
 to serve featureValues for all FeatureViews under this
 FeatureOnlineStore. When choose Optimized storage type, need to set
 [PrivateServiceConnectConfig.enable_private_service_connect][google.cloud.aiplatform.v1.PrivateServiceConnectConfig.enable_private_service_connect]
 to use private endpoint. Otherwise will use public endpoint by default.
      .google.cloud.aiplatform.v1.FeatureOnlineStore.Optimized optimized = 12;
      Specified by:
      getOptimized in interface FeatureOnlineStoreOrBuilder
      Returns:
      The optimized.

    • getOptimizedOrBuilder

      public FeatureOnlineStore.OptimizedOrBuilder getOptimizedOrBuilder()
       Contains settings for the Optimized store that will be created
 to serve featureValues for all FeatureViews under this
 FeatureOnlineStore. When choose Optimized storage type, need to set
 [PrivateServiceConnectConfig.enable_private_service_connect][google.cloud.aiplatform.v1.PrivateServiceConnectConfig.enable_private_service_connect]
 to use private endpoint. Otherwise will use public endpoint by default.
      .google.cloud.aiplatform.v1.FeatureOnlineStore.Optimized optimized = 12;
      Specified by:
      getOptimizedOrBuilder in interface FeatureOnlineStoreOrBuilder

    • getName

      public String getName()
       Identifier. Name of the FeatureOnlineStore. Format:
 `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface FeatureOnlineStoreOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. Name of the FeatureOnlineStore. Format:
 `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface FeatureOnlineStoreOrBuilder
      Returns:
      The bytes for name.

    • hasCreateTime

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

    • getCreateTime

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

    • getCreateTimeOrBuilder

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

    • hasUpdateTime

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

    • getUpdateTime

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

    • getUpdateTimeOrBuilder

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

    • 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 FeatureOnlineStoreOrBuilder
      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 FeatureOnlineStoreOrBuilder
      Returns:
      The bytes for etag.

    • getLabelsCount

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

 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
 FeatureOnlineStore(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 FeatureOnlineStoreOrBuilder

    • containsLabels

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

 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
 FeatureOnlineStore(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 FeatureOnlineStoreOrBuilder

    • getLabels

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

    • getLabelsMap

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

 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
 FeatureOnlineStore(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 FeatureOnlineStoreOrBuilder

    • getLabelsOrDefault

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

 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
 FeatureOnlineStore(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 FeatureOnlineStoreOrBuilder

    • getLabelsOrThrow

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

 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
 FeatureOnlineStore(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 FeatureOnlineStoreOrBuilder

    • getStateValue

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

    • getState

      public FeatureOnlineStore.State getState()
       Output only. State of the featureOnlineStore.
      .google.cloud.aiplatform.v1.FeatureOnlineStore.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface FeatureOnlineStoreOrBuilder
      Returns:
      The state.

    • hasDedicatedServingEndpoint

      public boolean hasDedicatedServingEndpoint()
       Optional. The dedicated serving endpoint for this FeatureOnlineStore, which
 is different from common Vertex service endpoint.
      .google.cloud.aiplatform.v1.FeatureOnlineStore.DedicatedServingEndpoint dedicated_serving_endpoint = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasDedicatedServingEndpoint in interface FeatureOnlineStoreOrBuilder
      Returns:
      Whether the dedicatedServingEndpoint field is set.

    • getDedicatedServingEndpoint

      public FeatureOnlineStore.DedicatedServingEndpoint getDedicatedServingEndpoint()
       Optional. The dedicated serving endpoint for this FeatureOnlineStore, which
 is different from common Vertex service endpoint.
      .google.cloud.aiplatform.v1.FeatureOnlineStore.DedicatedServingEndpoint dedicated_serving_endpoint = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDedicatedServingEndpoint in interface FeatureOnlineStoreOrBuilder
      Returns:
      The dedicatedServingEndpoint.

    • getDedicatedServingEndpointOrBuilder

      public FeatureOnlineStore.DedicatedServingEndpointOrBuilder getDedicatedServingEndpointOrBuilder()
       Optional. The dedicated serving endpoint for this FeatureOnlineStore, which
 is different from common Vertex service endpoint.
      .google.cloud.aiplatform.v1.FeatureOnlineStore.DedicatedServingEndpoint dedicated_serving_endpoint = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDedicatedServingEndpointOrBuilder in interface FeatureOnlineStoreOrBuilder

    • hasEncryptionSpec

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

    • getEncryptionSpec

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

    • getEncryptionSpecOrBuilder

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

    • getSatisfiesPzs

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

    • getSatisfiesPzi

      public boolean getSatisfiesPzi()
       Output only. Reserved for future use.
      bool satisfies_pzi = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzi in interface FeatureOnlineStoreOrBuilder
      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 FeatureOnlineStore parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FeatureOnlineStore.Builder newBuilder()

    • newBuilder

      public static FeatureOnlineStore.Builder newBuilder(FeatureOnlineStore prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FeatureOnlineStore getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<FeatureOnlineStore> 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 FeatureOnlineStore getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder