public final class Featurestore extends 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.v1beta1.Featurestore
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
public static final int ENCRYPTION_SPEC_FIELD_NUMBER
Field Value
public static final int ETAG_FIELD_NUMBER
Field Value
public static final int LABELS_FIELD_NUMBER
Field Value
public static final int NAME_FIELD_NUMBER
Field Value
public static final int ONLINE_SERVING_CONFIG_FIELD_NUMBER
Field Value
public static final int ONLINE_STORAGE_TTL_DAYS_FIELD_NUMBER
Field Value
public static final int STATE_FIELD_NUMBER
Field Value
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
public static Featurestore getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static Featurestore.Builder newBuilder()
Returns
public static Featurestore.Builder newBuilder(Featurestore prototype)
Parameter
Returns
public static Featurestore parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Featurestore parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Featurestore parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static Featurestore parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Featurestore parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static Featurestore parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Featurestore parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Featurestore parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Featurestore parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Featurestore parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Featurestore parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static Featurestore parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<Featurestore> parser()
Returns
Methods
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];
public boolean equals(Object obj)
Parameter
Returns
Overrides
public Timestamp getCreateTime()
Output only. Timestamp when this Featurestore was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this Featurestore was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Featurestore getDefaultInstanceForType()
Returns
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.v1beta1.EncryptionSpec encryption_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
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.v1beta1.EncryptionSpec encryption_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
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];
| Type | Description |
| String | The etag.
|
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];
public Map<String,String> getLabels()
Returns
public int getLabelsCount()
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];
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];
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];
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];
Output only. Name of the Featurestore. Format:
projects/{project}/locations/{location}/featurestores/{featurestore}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The name.
|
public ByteString getNameBytes()
Output only. Name of the Featurestore. Format:
projects/{project}/locations/{location}/featurestores/{featurestore}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.v1beta1.Featurestore.OnlineServingConfig online_serving_config = 7 [(.google.api.field_behavior) = OPTIONAL];
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.v1beta1.Featurestore.OnlineServingConfig online_serving_config = 7 [(.google.api.field_behavior) = OPTIONAL];
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];
| Type | Description |
| int | The onlineStorageTtlDays.
|
public Parser<Featurestore> getParserForType()
Returns
Overrides
public int getSerializedSize()
Returns
Overrides
public Featurestore.State getState()
Output only. State of the featurestore.
.google.cloud.aiplatform.v1beta1.Featurestore.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getStateValue()
Output only. State of the featurestore.
.google.cloud.aiplatform.v1beta1.Featurestore.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The enum numeric value on the wire for state.
|
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public Timestamp getUpdateTime()
Output only. Timestamp when this Featurestore was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this Featurestore was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public boolean hasCreateTime()
Output only. Timestamp when this Featurestore was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
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.v1beta1.EncryptionSpec encryption_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the encryptionSpec field is set.
|
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.v1beta1.Featurestore.OnlineServingConfig online_serving_config = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the onlineServingConfig field is set.
|
public boolean hasUpdateTime()
Output only. Timestamp when this Featurestore was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public Featurestore.Builder newBuilderForType()
Returns
protected Featurestore.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public Featurestore.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
