feat: Add sample code show how to create an optimized private online store in Vertex AI Feature Store.

PiperOrigin-RevId: 644127795

Author: vertex-sdk-bot

samples/model-builder/conftest.py

@@ -716,6 +716,15 @@ def mock_create_optimized_public_online_store(mock_feature_online_store):
         yield mock_create_optimized_store
 
 
+@pytest.fixture
+def mock_create_optimized_private_online_store(mock_feature_online_store):
+    with patch.object(
+        preview_resources.FeatureOnlineStore, "create_optimized_store"
+    ) as mock_create_optimized_store:
+        mock_create_optimized_store.return_value = mock_feature_online_store
+        yield mock_create_optimized_store
+
+
 """
 ----------------------------------------------------------------------------
 Experiment Tracking Fixtures

samples/model-builder/feature_store/create_optimized_private_feature_online_store_sample.py

@@ -0,0 +1,38 @@
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#  [START aiplatform_sdk_create_optimized_private_feature_online_store_sample]
+
+from typing import List
+
+from google.cloud import aiplatform
+from vertexai.resources.preview import feature_store
+
+
+def create_optimized_private_feature_online_store_sample(
+    project: str,
+    location: str,
+    feature_online_store_id: str,
+    project_allowlist: List[str],
+):
+    aiplatform.init(project=project, location=location)
+    fos = feature_store.FeatureOnlineStore.create_optimized_store(
+        name=feature_online_store_id,
+        enable_private_service_connect=True,
+        project_allowlist=project_allowlist,
+    )
+    return fos
+
+
+#  [END aiplatform_sdk_create_optimized_private_feature_online_store_sample]

samples/model-builder/feature_store/create_optimized_private_feature_online_store_sample_test.py

@@ -0,0 +1,38 @@
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from feature_store import create_optimized_private_feature_online_store_sample
+import test_constants as constants
+
+
+def test_create_optimized_feature_online_store_sample(
+    mock_sdk_init, mock_create_optimized_private_online_store
+):
+
+    create_optimized_private_feature_online_store_sample.create_optimized_private_feature_online_store_sample(
+        project=constants.PROJECT,
+        location=constants.LOCATION,
+        feature_online_store_id=constants.FEATURE_ONLINE_STORE_ID,
+        project_allowlist=constants.PROJECT_ALLOWLISTED,
+    )
+
+    mock_sdk_init.assert_called_once_with(
+        project=constants.PROJECT, location=constants.LOCATION
+    )
+
+    mock_create_optimized_private_online_store.assert_called_once_with(
+        name=constants.FEATURE_ONLINE_STORE_ID,
+        enable_private_service_connect=True,
+        project_allowlist=constants.PROJECT_ALLOWLISTED,
+    )

samples/model-builder/test_constants.py

@@ -254,6 +254,7 @@
 
 # Feature online store constants
 FEATURE_ONLINE_STORE_ID = "sample_feature_online_store"
+PROJECT_ALLOWLISTED = ["test-project"]
 
 TABULAR_TARGET_COLUMN = "target_column"
 FORECASTNG_TIME_COLUMN = "date"