Class FeatureOnlineStore (3.31.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
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DEDICATED_SERVING_ENDPOINT_FIELD_NUMBER

public static final int DEDICATED_SERVING_ENDPOINT_FIELD_NUMBER
Field Value
TypeDescription
int

EMBEDDING_MANAGEMENT_FIELD_NUMBER

public static final int EMBEDDING_MANAGEMENT_FIELD_NUMBER
Field Value
TypeDescription
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

OPTIMIZED_FIELD_NUMBER

public static final int OPTIMIZED_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static FeatureOnlineStore getDefaultInstance()
Returns
TypeDescription
FeatureOnlineStore

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static FeatureOnlineStore.Builder newBuilder()
Returns
TypeDescription
FeatureOnlineStore.Builder

newBuilder(FeatureOnlineStore prototype)

public static FeatureOnlineStore.Builder newBuilder(FeatureOnlineStore prototype)
Parameter
NameDescription
prototypeFeatureOnlineStore
Returns
TypeDescription
FeatureOnlineStore.Builder

parseDelimitedFrom(InputStream input)

public static FeatureOnlineStore parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FeatureOnlineStore
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FeatureOnlineStore parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FeatureOnlineStore
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static FeatureOnlineStore parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
FeatureOnlineStore
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FeatureOnlineStore parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FeatureOnlineStore
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FeatureOnlineStore parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
FeatureOnlineStore
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FeatureOnlineStore parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FeatureOnlineStore
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FeatureOnlineStore parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
FeatureOnlineStore
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FeatureOnlineStore parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FeatureOnlineStore
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static FeatureOnlineStore parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FeatureOnlineStore
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FeatureOnlineStore parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FeatureOnlineStore
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static FeatureOnlineStore parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
FeatureOnlineStore
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FeatureOnlineStore parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FeatureOnlineStore
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<FeatureOnlineStore> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
FeatureOnlineStore.DedicatedServingEndpointOrBuilder

getDefaultInstanceForType()

public FeatureOnlineStore getDefaultInstanceForType()
Returns
TypeDescription
FeatureOnlineStore

getEmbeddingManagement()

public FeatureOnlineStore.EmbeddingManagement getEmbeddingManagement()

Optional. The settings for embedding management in FeatureOnlineStore.

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

Returns
TypeDescription
FeatureOnlineStore.EmbeddingManagement

The embeddingManagement.

getEmbeddingManagementOrBuilder()

public FeatureOnlineStore.EmbeddingManagementOrBuilder getEmbeddingManagementOrBuilder()

Optional. The settings for embedding management in FeatureOnlineStore.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for etag.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getName()

public String getName()

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

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
FeatureOnlineStore.OptimizedOrBuilder

getParserForType()

public Parser<FeatureOnlineStore> getParserForType()
Returns
TypeDescription
Parser<FeatureOnlineStore>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for state.

getStorageTypeCase()

public FeatureOnlineStore.StorageTypeCase getStorageTypeCase()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the dedicatedServingEndpoint field is set.

hasEmbeddingManagement()

public boolean hasEmbeddingManagement()

Optional. The settings for embedding management in FeatureOnlineStore.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public FeatureOnlineStore.Builder newBuilderForType()
Returns
TypeDescription
FeatureOnlineStore.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FeatureOnlineStore.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
FeatureOnlineStore.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public FeatureOnlineStore.Builder toBuilder()
Returns
TypeDescription
FeatureOnlineStore.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException