feat(samples): add remaining featurestore api samples (#338)

* added create-featurestore-sample.js and create-featurestore-sample.test.js * feat(samples): added createFeaturestore sample (#313) * feat(samples): added remaining featurestore samples (#313) * removed the extraneous files * feat(samples): add remaining featurestore api samples (#313) * feat(samples): add remaining featurestore apis samples (#313) * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat(samples): changed timeout of featurestore apis samples (#313) * feat(samples): update featurestore-samples.test.js (#313) Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: junkourata <[email protected]>
GoogleCloudPlatform · Aug 2, 2022 · 1cab5c0 · 1cab5c0
1 parent 40d1ac9
commit 1cab5c0
Show file tree

Hide file tree

Showing 8 changed files with 727 additions and 0 deletions.
diff --git a/ai-platform/snippets/delete-featurestore-sample.js b/ai-platform/snippets/delete-featurestore-sample.js
@@ -0,0 +1,88 @@
+/*
+ * Copyright 2022 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.
+ */
+
+/*
+ * Deletes a single Featurestore.
+ * See https://cloud.google.com/vertex-ai/docs/featurestore/setup before running
+ * the code snippet
+ */
+
+'use strict';
+
+async function main(
+  project,
+  featurestoreId,
+  force = false,
+  location = 'us-central1',
+  apiEndpoint = 'us-central1-aiplatform.googleapis.com',
+  timeout = 60000
+) {
+  // [START aiplatform_delete_featurestore_sample]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.\
+   * (Not necessary if passing values as arguments)
+   */
+
+  // const project = 'YOUR_PROJECT_ID';
+  // const featurestoreId = 'YOUR_FEATURESTORE_ID';
+  // const force = <BOOLEAN>;
+  // const location = 'YOUR_PROJECT_LOCATION';
+  // const apiEndpoint = 'YOUR_API_ENDPOINT';
+  // const timeout = <TIMEOUT_IN_MILLI_SECONDS>;
+
+  // Imports the Google Cloud Featurestore Service Client library
+  const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1;
+
+  // Specifies the location of the api endpoint
+  const clientOptions = {
+    apiEndpoint: apiEndpoint,
+  };
+
+  // Instantiates a client
+  const featurestoreServiceClient = new FeaturestoreServiceClient(
+    clientOptions
+  );
+
+  async function deleteFeaturestore() {
+    // Configure the name resource
+    const name = `projects/${project}/locations/${location}/featurestores/${featurestoreId}`;
+
+    const request = {
+      name: name,
+      force: Boolean(force),
+    };
+
+    // Delete Featurestore request
+    const [operation] = await featurestoreServiceClient.deleteFeaturestore(
+      request,
+      {timeout: Number(timeout)}
+    );
+    const [response] = await operation.promise();
+
+    console.log('Delete featurestore response');
+    console.log('Raw response:');
+    console.log(JSON.stringify(response, null, 2));
+  }
+  deleteFeaturestore();
+  // [END aiplatform_delete_featurestore_sample]
+}
+
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+
+main(...process.argv.slice(2));
diff --git a/ai-platform/snippets/get-featurestore-sample.js b/ai-platform/snippets/get-featurestore-sample.js
@@ -0,0 +1,85 @@
+/*
+ * Copyright 2022 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.
+ */
+
+/*
+ * Gets details of a single Featurestore.
+ * See https://cloud.google.com/vertex-ai/docs/featurestore/setup before running
+ * the code snippet
+ */
+
+'use strict';
+
+async function main(
+  project,
+  featurestoreId,
+  location = 'us-central1',
+  apiEndpoint = 'us-central1-aiplatform.googleapis.com',
+  timeout = 5000
+) {
+  // [START aiplatform_get_featurestore_sample]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.\
+   * (Not necessary if passing values as arguments)
+   */
+
+  // const project = 'YOUR_PROJECT_ID';
+  // const featurestoreId = 'YOUR_FEATURESTORE_ID';
+  // const location = 'YOUR_PROJECT_LOCATION';
+  // const apiEndpoint = 'YOUR_API_ENDPOINT';
+  // const timeout = <TIMEOUT_IN_MILLI_SECONDS>;
+
+  // Imports the Google Cloud Featurestore Service Client library
+  const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1;
+
+  // Specifies the location of the api endpoint
+  const clientOptions = {
+    apiEndpoint: apiEndpoint,
+  };
+
+  // Instantiates a client
+  const featurestoreServiceClient = new FeaturestoreServiceClient(
+    clientOptions
+  );
+
+  async function getFeaturestore() {
+    // Configure the parent resource
+    const name = `projects/${project}/locations/${location}/featurestores/${featurestoreId}`;
+
+    const request = {
+      name: name,
+    };
+
+    // Get Featurestore request
+    const [response] = await featurestoreServiceClient.getFeaturestore(
+      request,
+      {timeout: Number(timeout)}
+    );
+
+    console.log('Get featurestore response');
+    console.log(`Name : ${response.name}`);
+    console.log('Raw response:');
+    console.log(JSON.stringify(response, null, 2));
+  }
+  getFeaturestore();
+  // [END aiplatform_get_featurestore_sample]
+}
+
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+
+main(...process.argv.slice(2));
diff --git a/ai-platform/snippets/list-featurestores-async-sample.js b/ai-platform/snippets/list-featurestores-async-sample.js
@@ -0,0 +1,84 @@
+/*
+ * Copyright 2022 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.
+ */
+
+/*
+ * Lists Featurestores asynchronously in a given project and location.
+ * See https://cloud.google.com/vertex-ai/docs/featurestore/setup before running
+ * the code snippet
+ */
+
+'use strict';
+
+async function main(
+  project,
+  location = 'us-central1',
+  apiEndpoint = 'us-central1-aiplatform.googleapis.com',
+  timeout = 5000
+) {
+  // [START aiplatform_list_featurestores_async_sample]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.\
+   * (Not necessary if passing values as arguments)
+   */
+
+  // const project = 'YOUR_PROJECT_ID';
+  // const location = 'YOUR_PROJECT_LOCATION';
+  // const apiEndpoint = 'YOUR_API_ENDPOINT';
+  // const timeout = <TIMEOUT_IN_MILLI_SECONDS>;
+
+  // Imports the Google Cloud Featurestore Service Client library
+  const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1;
+
+  // Specifies the location of the api endpoint
+  const clientOptions = {
+    apiEndpoint: apiEndpoint,
+  };
+
+  // Instantiates a client
+  const featurestoreServiceClient = new FeaturestoreServiceClient(
+    clientOptions
+  );
+
+  async function listFeaturestoresAsync() {
+    // Configure the parent resource
+    const parent = `projects/${project}/locations/${location}`;
+
+    const request = {
+      parent: parent,
+    };
+
+    // List featurestores async request
+    const iterable = await featurestoreServiceClient.listFeaturestoresAsync(
+      request,
+      {timeout: Number(timeout)}
+    );
+
+    console.log('List featurestores async response');
+    console.log('Raw response:');
+    for await (const response of iterable) {
+      console.log(JSON.stringify(response, null, 2));
+    }
+  }
+  listFeaturestoresAsync();
+  // [END aiplatform_list_featurestores_async_sample]
+}
+
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+
+main(...process.argv.slice(2));
diff --git a/ai-platform/snippets/list-featurestores-sample.js b/ai-platform/snippets/list-featurestores-sample.js
@@ -0,0 +1,82 @@
+/*
+ * Copyright 2022 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.
+ */
+
+/*
+ * Lists Featurestores in a given project and location.
+ * See https://cloud.google.com/vertex-ai/docs/featurestore/setup before running
+ * the code snippet
+ */
+
+'use strict';
+
+async function main(
+  project,
+  location = 'us-central1',
+  apiEndpoint = 'us-central1-aiplatform.googleapis.com',
+  timeout = 5000
+) {
+  // [START aiplatform_list_featurestores_sample]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.\
+   * (Not necessary if passing values as arguments)
+   */
+
+  // const project = 'YOUR_PROJECT_ID';
+  // const location = 'YOUR_PROJECT_LOCATION';
+  // const apiEndpoint = 'YOUR_API_ENDPOINT';
+  // const timeout = <TIMEOUT_IN_MILLI_SECONDS>;
+
+  // Imports the Google Cloud Featurestore Service Client library
+  const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1;
+
+  // Specifies the location of the api endpoint
+  const clientOptions = {
+    apiEndpoint: apiEndpoint,
+  };
+
+  // Instantiates a client
+  const featurestoreServiceClient = new FeaturestoreServiceClient(
+    clientOptions
+  );
+
+  async function listFeaturestores() {
+    // Configure the parent resource
+    const parent = `projects/${project}/locations/${location}`;
+
+    const request = {
+      parent: parent,
+    };
+
+    // List featurestores request
+    const [response] = await featurestoreServiceClient.listFeaturestores(
+      request,
+      {timeout: Number(timeout)}
+    );
+
+    console.log('List featurestores response');
+    console.log('Raw response:');
+    console.log(JSON.stringify(response, null, 2));
+  }
+  listFeaturestores();
+  // [END aiplatform_list_featurestores_sample]
+}
+
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+
+main(...process.argv.slice(2));