Class FeatureOnlineStore (3.45.0)

public final class FeatureOnlineStore extends GeneratedMessageV3 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.v1beta1.FeatureOnlineStore

Static Fields

BIGTABLE_FIELD_NUMBER

public static final int BIGTABLE_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DEDICATED_SERVING_ENDPOINT_FIELD_NUMBER

public static final int DEDICATED_SERVING_ENDPOINT_FIELD_NUMBER
Field Value
Type Description
int

EMBEDDING_MANAGEMENT_FIELD_NUMBER

public static final int EMBEDDING_MANAGEMENT_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OPTIMIZED_FIELD_NUMBER

public static final int OPTIMIZED_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FeatureOnlineStore getDefaultInstance()
Returns
Type Description
FeatureOnlineStore

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static FeatureOnlineStore.Builder newBuilder()
Returns
Type Description
FeatureOnlineStore.Builder

newBuilder(FeatureOnlineStore prototype)

public static FeatureOnlineStore.Builder newBuilder(FeatureOnlineStore prototype)
Parameter
Name Description
prototype FeatureOnlineStore
Returns
Type Description
FeatureOnlineStore.Builder

parseDelimitedFrom(InputStream input)

public static FeatureOnlineStore parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FeatureOnlineStore
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FeatureOnlineStore parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FeatureOnlineStore
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FeatureOnlineStore parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FeatureOnlineStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FeatureOnlineStore parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FeatureOnlineStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FeatureOnlineStore parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FeatureOnlineStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FeatureOnlineStore parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FeatureOnlineStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FeatureOnlineStore parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FeatureOnlineStore
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FeatureOnlineStore parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FeatureOnlineStore
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FeatureOnlineStore parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FeatureOnlineStore
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FeatureOnlineStore parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FeatureOnlineStore
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FeatureOnlineStore parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FeatureOnlineStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FeatureOnlineStore parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FeatureOnlineStore
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FeatureOnlineStore> parser()
Returns
Type Description
Parser<FeatureOnlineStore>

Methods

containsLabels(String key)

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];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.v1beta1.FeatureOnlineStore.Bigtable bigtable = 8;

Returns
Type Description
FeatureOnlineStore.Bigtable

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.v1beta1.FeatureOnlineStore.Bigtable bigtable = 8;

Returns
Type Description
FeatureOnlineStore.BigtableOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this FeatureOnlineStore was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this FeatureOnlineStore was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDedicatedServingEndpoint()

public FeatureOnlineStore.DedicatedServingEndpoint getDedicatedServingEndpoint()

Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint.

.google.cloud.aiplatform.v1beta1.FeatureOnlineStore.DedicatedServingEndpoint dedicated_serving_endpoint = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FeatureOnlineStore.DedicatedServingEndpoint

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.v1beta1.FeatureOnlineStore.DedicatedServingEndpoint dedicated_serving_endpoint = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FeatureOnlineStore.DedicatedServingEndpointOrBuilder

getDefaultInstanceForType()

public FeatureOnlineStore getDefaultInstanceForType()
Returns
Type Description
FeatureOnlineStore

getEmbeddingManagement() (deprecated)

public FeatureOnlineStore.EmbeddingManagement getEmbeddingManagement()

Deprecated. google.cloud.aiplatform.v1beta1.FeatureOnlineStore.embedding_management is deprecated. See google/cloud/aiplatform/v1beta1/feature_online_store.proto;l=174

Optional. Deprecated: This field is no longer needed anymore and embedding management is automatically enabled when specifying Optimized storage type.

.google.cloud.aiplatform.v1beta1.FeatureOnlineStore.EmbeddingManagement embedding_management = 11 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FeatureOnlineStore.EmbeddingManagement

The embeddingManagement.

getEmbeddingManagementOrBuilder() (deprecated)

public FeatureOnlineStore.EmbeddingManagementOrBuilder getEmbeddingManagementOrBuilder()

Optional. Deprecated: This field is no longer needed anymore and embedding management is automatically enabled when specifying Optimized storage type.

.google.cloud.aiplatform.v1beta1.FeatureOnlineStore.EmbeddingManagement embedding_management = 11 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FeatureOnlineStore.EmbeddingManagementOrBuilder

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];

Returns
Type Description
String

The etag.

getEtagBytes()

public 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];

Returns
Type Description
ByteString

The bytes for etag.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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];

Returns
Type Description
int

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];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

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];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

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];

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

Identifier. Name of the FeatureOnlineStore. Format: projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Name of the FeatureOnlineStore. Format: projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

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 to use private endpoint. Otherwise will use public endpoint by default.

.google.cloud.aiplatform.v1beta1.FeatureOnlineStore.Optimized optimized = 12;

Returns
Type Description
FeatureOnlineStore.Optimized

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 to use private endpoint. Otherwise will use public endpoint by default.

.google.cloud.aiplatform.v1beta1.FeatureOnlineStore.Optimized optimized = 12;

Returns
Type Description
FeatureOnlineStore.OptimizedOrBuilder

getParserForType()

public Parser<FeatureOnlineStore> getParserForType()
Returns
Type Description
Parser<FeatureOnlineStore>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public FeatureOnlineStore.State getState()

Output only. State of the featureOnlineStore.

.google.cloud.aiplatform.v1beta1.FeatureOnlineStore.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
FeatureOnlineStore.State

The state.

getStateValue()

public int getStateValue()

Output only. State of the featureOnlineStore.

.google.cloud.aiplatform.v1beta1.FeatureOnlineStore.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getStorageTypeCase()

public FeatureOnlineStore.StorageTypeCase getStorageTypeCase()
Returns
Type Description
FeatureOnlineStore.StorageTypeCase

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when this FeatureOnlineStore was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this FeatureOnlineStore was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

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.v1beta1.FeatureOnlineStore.Bigtable bigtable = 8;

Returns
Type Description
boolean

Whether the bigtable field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this FeatureOnlineStore was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDedicatedServingEndpoint()

public boolean hasDedicatedServingEndpoint()

Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint.

.google.cloud.aiplatform.v1beta1.FeatureOnlineStore.DedicatedServingEndpoint dedicated_serving_endpoint = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dedicatedServingEndpoint field is set.

hasEmbeddingManagement() (deprecated)

public boolean hasEmbeddingManagement()

Deprecated. google.cloud.aiplatform.v1beta1.FeatureOnlineStore.embedding_management is deprecated. See google/cloud/aiplatform/v1beta1/feature_online_store.proto;l=174

Optional. Deprecated: This field is no longer needed anymore and embedding management is automatically enabled when specifying Optimized storage type.

.google.cloud.aiplatform.v1beta1.FeatureOnlineStore.EmbeddingManagement embedding_management = 11 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the embeddingManagement field is set.

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 to use private endpoint. Otherwise will use public endpoint by default.

.google.cloud.aiplatform.v1beta1.FeatureOnlineStore.Optimized optimized = 12;

Returns
Type Description
boolean

Whether the optimized field is set.

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];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FeatureOnlineStore.Builder newBuilderForType()
Returns
Type Description
FeatureOnlineStore.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FeatureOnlineStore.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FeatureOnlineStore.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FeatureOnlineStore.Builder toBuilder()
Returns
Type Description
FeatureOnlineStore.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException